diff --git a/.cmake-format.yaml b/.cmake-format.yaml deleted file mode 100755 index 8988642..0000000 --- a/.cmake-format.yaml +++ /dev/null @@ -1,204 +0,0 @@ -_help_format: Options affecting formatting. -format: - _help_disable: - - Disable formatting entirely, making cmake-format a no-op - disable: false - _help_line_width: - - How wide to allow formatted cmake files - line_width: 100 - _help_tab_size: - - How many spaces to tab for indent - tab_size: 4 - _help_use_tabchars: - - If true, lines are indented using tab characters (utf-8 - - 0x09) instead of space characters (utf-8 0x20). - - In cases where the layout would require a fractional tab - - character, the behavior of the fractional indentation is - - governed by - use_tabchars: false - _help_fractional_tab_policy: - - If is True, then the value of this variable - - indicates how fractional indentions are handled during - - whitespace replacement. If set to 'use-space', fractional - - indentation is left as spaces (utf-8 0x20). If set to - - '`round-up` fractional indentation is replaced with a single' - - tab character (utf-8 0x09) effectively shifting the column - - to the next tabstop - fractional_tab_policy: use-space - _help_max_subgroups_hwrap: - - If an argument group contains more than this many sub-groups - - (parg or kwarg groups) then force it to a vertical layout. - max_subgroups_hwrap: 2 - _help_max_pargs_hwrap: - - If a positional argument group contains more than this many - - arguments, then force it to a vertical layout. - max_pargs_hwrap: 6 - _help_max_rows_cmdline: - - If a cmdline positional group consumes more than this many - - lines without nesting, then invalidate the layout (and nest) - max_rows_cmdline: 2 - _help_separate_ctrl_name_with_space: - - If true, separate flow control names from their parentheses - - with a space - separate_ctrl_name_with_space: false - _help_separate_fn_name_with_space: - - If true, separate function names from parentheses with a - - space - separate_fn_name_with_space: false - _help_dangle_parens: - - If a statement is wrapped to more than one line, than dangle - - the closing parenthesis on its own line. - dangle_parens: false - _help_dangle_align: - - If the trailing parenthesis must be 'dangled' on its on - - 'line, then align it to this reference: `prefix`: the start' - - 'of the statement, `prefix-indent`: the start of the' - - 'statement, plus one indentation level, `child`: align to' - - the column of the arguments - dangle_align: prefix - _help_min_prefix_chars: - - If the statement spelling length (including space and - - parenthesis) is smaller than this amount, then force reject - - nested layouts. - min_prefix_chars: 4 - _help_max_prefix_chars: - - If the statement spelling length (including space and - - parenthesis) is larger than the tab width by more than this - - amount, then force reject un-nested layouts. - max_prefix_chars: 10 - _help_max_lines_hwrap: - - If a candidate layout is wrapped horizontally but it exceeds - - this many lines, then reject the layout. - max_lines_hwrap: 2 - _help_line_ending: - - What style line endings to use in the output. - line_ending: unix - _help_command_case: - - Format command names consistently as 'lower' or 'upper' case - command_case: canonical - _help_keyword_case: - - Format keywords consistently as 'lower' or 'upper' case - keyword_case: unchanged - _help_always_wrap: - - A list of command names which should always be wrapped - always_wrap: [] - _help_enable_sort: - - If true, the argument lists which are known to be sortable - - will be sorted lexicographicall - enable_sort: true - _help_autosort: - - If true, the parsers may infer whether or not an argument - - list is sortable (without annotation). - autosort: false - _help_require_valid_layout: - - By default, if cmake-format cannot successfully fit - - everything into the desired linewidth it will apply the - - last, most agressive attempt that it made. If this flag is - - True, however, cmake-format will print error, exit with non- - - zero status code, and write-out nothing - require_valid_layout: false - _help_layout_passes: - - A dictionary mapping layout nodes to a list of wrap - - decisions. See the documentation for more information. - layout_passes: {} -_help_markup: Options affecting comment reflow and formatting. -markup: - _help_bullet_char: - - What character to use for bulleted lists - bullet_char: '*' - _help_enum_char: - - What character to use as punctuation after numerals in an - - enumerated list - enum_char: . - _help_first_comment_is_literal: - - If comment markup is enabled, don't reflow the first comment - - block in each listfile. Use this to preserve formatting of - - your copyright/license statements. - first_comment_is_literal: false - _help_literal_comment_pattern: - - If comment markup is enabled, don't reflow any comment block - - which matches this (regex) pattern. Default is `None` - - (disabled). - literal_comment_pattern: - _help_fence_pattern: - - Regular expression to match preformat fences in comments - - default= ``r'^\s*([`~]{3}[`~]*)(.*)$'`` - fence_pattern: ^\s*([`~]{3}[`~]*)(.*)$ - _help_ruler_pattern: - - Regular expression to match rulers in comments default= - - "``r'^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$'``" - ruler_pattern: ^\s*[^\w\s]{3}.*[^\w\s]{3}$ - _help_explicit_trailing_pattern: - - If a comment line matches starts with this pattern then it - - is explicitly a trailing comment for the preceeding - - argument. Default is '#<' - explicit_trailing_pattern: '#<' - _help_hashruler_min_length: - - If a comment line starts with at least this many consecutive - - hash characters, then don't lstrip() them off. This allows - - for lazy hash rulers where the first hash char is not - - separated by space - hashruler_min_length: 10 - _help_canonicalize_hashrulers: - - If true, then insert a space between the first hash char and - - remaining hash chars in a hash ruler, and normalize its - - length to fill the column - canonicalize_hashrulers: true - _help_enable_markup: - - enable comment markup parsing and reflow - enable_markup: true -_help_lint: Options affecting the linter -lint: - _help_disabled_codes: - - a list of lint codes to disable - # C0113: Missing COMMENT in statement which allows it - disabled_codes: [C0113, C0301] - _help_function_pattern: - - regular expression pattern describing valid function names - function_pattern: '[0-9a-z_]+' - _help_macro_pattern: - - regular expression pattern describing valid macro names - macro_pattern: '[0-9A-Z_]+' - _help_global_var_pattern: - - regular expression pattern describing valid names for - - variables with global (cache) scope - global_var_pattern: '[A-Z][0-9A-Z_]+' - _help_internal_var_pattern: - - regular expression pattern describing valid names for - - variables with global scope (but internal semantic) - internal_var_pattern: _[A-Z][0-9A-Z_]+ - _help_local_var_pattern: - - regular expression pattern describing valid names for - - variables with local scope - local_var_pattern: '[a-z][a-z0-9_]+' - _help_private_var_pattern: - - regular expression pattern describing valid names for - - privatedirectory variables - private_var_pattern: _[0-9a-z_]+ - _help_public_var_pattern: - - regular expression pattern describing valid names for public - - directory variables - public_var_pattern: '[A-Z][0-9A-Z_]+' - _help_argument_var_pattern: - - regular expression pattern describing valid names for - - function/macro arguments and loop variables. - argument_var_pattern: '[a-z][a-z0-9_]+' - _help_keyword_pattern: - - regular expression pattern describing valid names for - - keywords used in functions or macros - keyword_pattern: '[A-Z][0-9A-Z_]+' - _help_max_conditionals_custom_parser: - - In the heuristic for C0201, how many conditionals to match - - within a loop in before considering the loop a parser. - max_conditionals_custom_parser: 2 - _help_min_statement_spacing: - - Require at least this many newlines between statements - min_statement_spacing: 1 - _help_max_statement_spacing: - - Require no more than this many newlines between statements - max_statement_spacing: 2 - max_returns: 6 - max_branches: 12 - max_arguments: 5 - max_localvars: 15 - max_statements: 50 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 81e306c..63abc3f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,19 +40,21 @@ repos: entry: cmake-format language: python types: [cmake] - args: [--in-place] + args: [--line-width, '100', '--tab-size', '4', '--in-place'] - id: cmake-lint name: cmake-lint entry: cmake-lint language: python types: [cmake] + args: ['--disabled-codes', 'C0113 C0301'] - repo: https://github.com/google/yamlfmt rev: v0.10.0 hooks: - id: yamlfmt - args: [-conf, .yamlfmt.yaml] + args: ['-formatter', 'max_line_length=100', '-formatter', 'indent=2', '-formatter', 'retain_line_breaks=true', + '-formatter', 'include_document_start=false'] - repo: https://github.com/igorshubovych/markdownlint-cli rev: v0.42.0 diff --git a/.yamlfmt.yaml b/.yamlfmt.yaml deleted file mode 100644 index 4e67e16..0000000 --- a/.yamlfmt.yaml +++ /dev/null @@ -1,6 +0,0 @@ -formatter: - type: basic - indent: 2 - retain_line_breaks: true - include_document_start: false - max_line_length: 100 diff --git a/docs/styles/extra.css b/docs/styles/extra.css new file mode 100644 index 0000000..cd8fdb6 --- /dev/null +++ b/docs/styles/extra.css @@ -0,0 +1,6 @@ +:root { + --md-primary-fg-color: #9d2246; + --md-primary-fg-color--light: #d50c2f; + --md-primary-fg-color--dark: #9d2246; + --md-accent-fg-color: #f39ca9; + } \ No newline at end of file diff --git a/include/PackageName/template.h b/include/PackageName/template.h index f0e9ca6..c5a7cc7 100644 --- a/include/PackageName/template.h +++ b/include/PackageName/template.h @@ -1,10 +1,22 @@ #ifndef PACKAGENAME_TEMPLATE_H #define PACKAGENAME_TEMPLATE_H -// Function declaration for addition +/** + * @brief Add two integers + * + * @param pA First integer + * @param pB Second integer + * @return int Sum of the two integers + */ int add(int pA, int pB); -// Function declaration for subtraction +/** + * @brief Subtract two integers + * + * @param pA First integer + * @param pB Second integer + * @return int Difference of the two integers + */ int subtract(int pA, int pB); int multiply(int pA, int pB) diff --git a/mkdocs.yaml b/mkdocs.yaml index 4b65958..310b75f 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -2,6 +2,11 @@ site_name: PackageName documentation site_url: https://secorolab.github.io/c_cpp_pkg_template/ repo_url: https://github.com/secorolab/c_cpp_pkg_template repo_name: secorolab/c_cpp_pkg_template + +# nav: +# - Home: index.md +# - API Reference: reference/ + theme: # logo: assets/logo.png icon: @@ -10,20 +15,24 @@ theme: palette: # Palette toggle for automatic mode - media: (prefers-color-scheme) + primary: custom + accent: custom toggle: icon: material/brightness-auto name: Switch to light mode # Palette toggle for light mode - media: '(prefers-color-scheme: light)' scheme: default - primary: black + primary: custom + accent: custom toggle: icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - media: '(prefers-color-scheme: dark)' scheme: slate - primary: black + primary: custom + accent: custom toggle: icon: material/brightness-4 name: Switch to system preference @@ -71,6 +80,8 @@ markdown_extensions: plugins: - search - awesome-pages +extra_css: + - styles/extra.css extra: social: - icon: fontawesome/brands/github