[geany/geany-plugins] 95d4f6: Merge pull request #1294 from b4n/gendoc/local - Plugins-Commits

14 Apr 2024


      Branch:      refs/heads/master
Author:      Frank Lanitz frank@frank.uvena.de
Committer:   GitHub noreply@github.com
Date:        Sun, 14 Apr 2024 14:29:40 UTC
Commit:      95d4f6fa88ee37133f798b3e5ee4d31de8b805e2
             https://github.com/geany/geany-plugins/commit/95d4f6fa88ee37133f798b3e5ee4d3...
Log Message:
-----------
Merge pull request #1294 from b4n/gendoc/local
Fix handling of locals
Modified Paths:
--------------
    geanygendoc/data/filetypes/c.conf
    geanygendoc/docs/manual.rst
    geanygendoc/src/ggd-tag-utils.c
    geanygendoc/src/ggd.c
Modified: geanygendoc/data/filetypes/c.conf
5 lines changed, 5 insertions(+), 0 deletions(-)
===================================================================
@@ -41,6 +41,8 @@ doctypes = {
     struct.prototype.policy = FORWARD;
     member.policy           = FORWARD;
     enumval.policy          = FORWARD;
+    # usually, locals are just not documented and get in the way
+    local.policy            = FORWARD;
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";
@@ -73,6 +75,9 @@ doctypes = {
   }
doxygen = {
+    # usually, locals are just not documented and get in the way
+    local.policy = FORWARD;
+
     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";
     struct.member = {
Modified: geanygendoc/docs/manual.rst
2 lines changed, 2 insertions(+), 0 deletions(-)
===================================================================
@@ -348,6 +348,8 @@ Known types
   A function.
 ``interface``
   An interface.
+``local``
+  A local variable.
 ``member``
   A member (of a structure for example).
 ``method``
Modified: geanygendoc/src/ggd-tag-utils.c
1 lines changed, 1 insertions(+), 0 deletions(-)
===================================================================
@@ -255,6 +255,7 @@ static const struct {
   { tm_tag_field_t,           "field"     },
   { tm_tag_function_t,        "function"  },
   { tm_tag_interface_t,       "interface" },
+  { tm_tag_local_var_t,       "local"     },
   { tm_tag_member_t,          "member"    },
   { tm_tag_method_t,          "method"    },
   { tm_tag_namespace_t,       "namespace" },
Modified: geanygendoc/src/ggd.c
2 lines changed, 1 insertions(+), 1 deletions(-)
===================================================================
@@ -208,7 +208,7 @@ get_env_for_tag (GgdFileType   *ft,
       CtplValue    *v;
       GList        *tmp = children;
-      if (el->type & setting->matches) {
+      if (type_name && el->type & setting->matches) {
         v = g_hash_table_lookup (vars, type_name);
         if (! v) {
           v = ctpl_value_new_array (CTPL_VTYPE_STRING, 0, NULL);
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).

    