kernel-doc/rst: &foo references are more universal than structs
authorJani Nikula <jani.nikula@intel.com>
Thu, 26 May 2016 10:57:06 +0000 (13:57 +0300)
committerJani Nikula <jani.nikula@intel.com>
Mon, 30 May 2016 10:38:56 +0000 (13:38 +0300)
It's possible to use &foo to reference structs, enums, typedefs, etc. in
the Sphinx C domain. Thus do not prefix the links with "struct".

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
scripts/kernel-doc

index e8651d7cf1cd6cfffb84b23d86268bebafb7d774..e7aa792e7f1b29362b72ac45aaa0719efe1449e8 100755 (executable)
@@ -283,7 +283,8 @@ my @highlights_rst = (
                        [$type_func, "\\:c\\:func\\:`\$1()`"],
                        [$type_struct_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
                        [$type_enum_full, "\\:c\\:type\\:`\$1 \$2 <\$2>`"],
-                       [$type_struct, "\\:c\\:type\\:`struct \$1 <\$1>`"],
+                       # in rst this can refer to any type
+                       [$type_struct, "\\:c\\:type\\:`\$1`"],
                        [$type_param, "**\$1**"]
                      );
 my $blankline_rst = "\n";