Merge pull request #1294 from b4n/gendoc/local

Fix handling of locals
geany · Apr 14, 2024 · 95d4f6f · 95d4f6f
2 parents a8f26ab + 3af0bf5
commit 95d4f6f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/geanygendoc/data/filetypes/c.conf b/geanygendoc/data/filetypes/c.conf
@@ -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 = {

diff --git a/geanygendoc/docs/manual.rst b/geanygendoc/docs/manual.rst
@@ -348,6 +348,8 @@ Known types
   A function.
 ``interface``
   An interface.
+``local``
+  A local variable.
 ``member``
   A member (of a structure for example).
 ``method``

diff --git a/geanygendoc/src/ggd-tag-utils.c b/geanygendoc/src/ggd-tag-utils.c
@@ -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" },

diff --git a/geanygendoc/src/ggd.c b/geanygendoc/src/ggd.c
@@ -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);