Branch: refs/heads/master Author: Colomban Wendling ban@herbesfolles.org Committer: Colomban Wendling ban@herbesfolles.org Date: Sat, 06 Jul 2024 15:15:16 UTC Commit: 8043a678b69c3ad3dcb58e4826a2232e97072ebf https://github.com/geany/geany-plugins/commit/8043a678b69c3ad3dcb58e4826a223...

Log Message: ----------- geanygendoc: Add support for types "include" and "other"

They are both ignored by the default configuration, as include directives are not usually useful to document, and "other" is not normally emitted by the C language parser.

Modified Paths: -------------- geanygendoc/data/filetypes/c.conf geanygendoc/docs/manual.rst geanygendoc/src/ggd-tag-utils.c

Modified: geanygendoc/data/filetypes/c.conf 6 lines changed, 6 insertions(+), 0 deletions(-) =================================================================== @@ -43,6 +43,9 @@ doctypes = { enumval.policy = FORWARD; # usually, locals are just not documented and get in the way local.policy = FORWARD; + # usually nothing useful to document + include.policy = PASS; + other.policy = PASS;

function = { template = "/**\n * {symbol}:\n{for arg in argument_list} * @{arg}: {cursor}\n{end} * \n * {cursor}\n{if returns} * \n * Returns: \n{end}{if write_since}{if returns} * \n{end} * Since: \n{end} */\n"; @@ -77,6 +80,9 @@ doctypes = { doxygen = { # usually, locals are just not documented and get in the way local.policy = FORWARD; + # usually nothing useful to document + include.policy = PASS; + other.policy = PASS;

function.template = "/**\n * {doxygen_prefix}brief {cursor}\n{for a in argument_list} * {doxygen_prefix}param {a} \n{end}{if returns} * {doxygen_prefix}returns \n{end}{if write_since} * {doxygen_prefix}since \n{end} * \n * \n */\n"; macro.template = "/**\n * {doxygen_prefix}brief {cursor}\n{for a in argument_list} * {doxygen_prefix}param {a} \n{end}{if returns} * {doxygen_prefix}returns \n{end}{if write_since} * {doxygen_prefix}since \n{end} * \n * \n */\n";

Modified: geanygendoc/docs/manual.rst 4 lines changed, 4 insertions(+), 0 deletions(-) =================================================================== @@ -346,6 +346,8 @@ Known types A field (of a class for example). ``function`` A function. +``include`` + An include directive. ``interface`` An interface. ``local`` @@ -356,6 +358,8 @@ Known types A method. ``namespace`` A namespace. +``other`` + A non-specific type that highly depend on the language. ``package`` A package. ``prototype``

Modified: geanygendoc/src/ggd-tag-utils.c 2 lines changed, 2 insertions(+), 0 deletions(-) =================================================================== @@ -256,12 +256,14 @@ static const struct { { tm_tag_field_t, "field" }, { tm_tag_function_t, "function" }, { tm_tag_interface_t, "interface" }, + { tm_tag_include_t, "include" }, { tm_tag_local_var_t, "local" }, { tm_tag_macro_t, "define" }, { tm_tag_macro_with_arg_t, "macro" }, { tm_tag_member_t, "member" }, { tm_tag_method_t, "method" }, { tm_tag_namespace_t, "namespace" }, + { tm_tag_other_t, "other" }, { tm_tag_package_t, "package" }, { tm_tag_prototype_t, "prototype" }, { tm_tag_struct_t, "struct" },

-------------- This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).