Skip to content

Feature/add parametrized description #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andcaspe wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Feature/add parametrized description #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d29c86
Added new block called "description"
pe-andreu Dec 2, 2024
1ff2a34
Description field is injected into the jinja template
pe-andreu Dec 2, 2024
9a81f1a
Description field is injected in missing codecs
pe-andreu Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/cbexigen/datatype_classes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,7 @@ def generate_file(self):
temp = self.generator.get_template('BaseDatatypes.h.jinja')
code = temp.render(filename=self.h_params['filename'],
filekey=self.h_params['identifier'],
description=self.h_params.get('description'),
include=include,
defines=defines,
enum_code=enum_code,
Expand Down Expand Up @@ -888,7 +889,7 @@ def generate_file(self):
try:
temp = self.generator.get_template("BaseDatatypes.c.jinja")
code = temp.render(filename=self.c_params["filename"], filekey=self.c_params["identifier"],
includes_code=includes, code=content)
description=self.c_params.get('description'), includes_code=includes, code=content)
tools.save_code_to_file(self.c_params["filename"], code, self.parameters['folder'])
except KeyError as err:
tools_logging.log_write_error(f'Exception in {self.__class__.__name__}.{self.generate_file.__name__} '
Expand Down
6 changes: 4 additions & 2 deletions src/cbexigen/decoder_classes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ def __render_file(self):
try:
temp = self.generator.get_template('DatatypesDecoder.h.jinja')
code = temp.render(filename=self.h_params["filename"], filekey=self.h_params['identifier'],
include_content=self.__include_content, code_content=self.__code_content)
description=self.h_params.get('description'), include_content=self.__include_content,
code_content=self.__code_content)
tools.save_code_to_file(self.h_params['filename'], code, self.parameters['folder'])
except KeyError as err:
log_write_error(f'Exception in {self.__class__.__name__}.{self.__render_file.__name__} '
Expand Down Expand Up @@ -918,7 +919,8 @@ def __render_file(self):
try:
temp = self.generator.get_template("DatatypesDecoder.c.jinja")
code = temp.render(filename=self.c_params["filename"], filekey=self.c_params["identifier"],
includes_code=self.__include_content, code=self.__code_content)
description=self.c_params.get('description'), includes_code=self.__include_content,
code=self.__code_content)
tools.save_code_to_file(self.c_params["filename"], code, self.parameters['folder'])
except KeyError as err:
log_write_error(f'Exception in {self.__class__.__name__}.{self.__render_file.__name__} '
Expand Down
6 changes: 4 additions & 2 deletions src/cbexigen/encoder_classes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ def __render_file(self):
try:
temp = self.generator.get_template('DataTypesEncoder.h.jinja')
code = temp.render(filename=self.h_params["filename"], filekey=self.h_params['identifier'],
include_content=self.__include_content, code_content=self.__code_content)
description=self.h_params.get('description'), include_content=self.__include_content,
code_content=self.__code_content)
tools.save_code_to_file(self.h_params['filename'], code, self.parameters['folder'])
except KeyError as err:
log_write_error(f'Exception in {self.__class__.__name__}.{self.__render_file.__name__} '
Expand Down Expand Up @@ -924,7 +925,8 @@ def __render_file(self):
try:
temp = self.generator.get_template("DataTypesEncoder.c.jinja")
code = temp.render(filename=self.c_params["filename"], filekey=self.c_params["identifier"],
includes_code=self.__include_content, code=self.__code_content)
description=self.c_params.get('description'), includes_code=self.__include_content,
code=self.__code_content)
tools.save_code_to_file(self.c_params["filename"], code, self.parameters['folder'])
except KeyError as err:
log_write_error(f'Exception in {self.__class__.__name__}.{self.__render_file.__name__} '
Expand Down
5 changes: 3 additions & 2 deletions src/input/code_templates/c/CommonFileHeader.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@
* The Code is generated! Changes may be overwritten.
*
*****************************************************/

{% block description %}
/**
* @file {{ filename }}
* @brief Description goes here
* @brief {{ description or "Description goes here" }}
*
**/
{% endblock description %}

{%- block file_content %}{% endblock %}