Let the user use @foo, &bar, %baz, etc. in the first kernel-doc purpose line too.
Unified · Split
| @@ -1805,6 +1805,7 @@ sub output_highlight_rst { · 1804 unmodified lines | ||
| 1805 | 1805 | sub output_function_rst(%) { |
| 1806 | 1806 | my %args = %{$_[0]}; |
| 1807 | 1807 | my ($parameter, $section); |
| 1808 | + my $oldprefix = $lineprefix; | |
| 1808 | 1809 | my $start; |
| 1809 | 1810 | |
| 1810 | 1811 | print ".. c:function:: "; |
| @@ -1829,9 +1830,13 @@ sub output_function_rst(%) { · 18 unmodified lines | ||
| 1829 | 1830 | print $type . " " . $parameter; |
| 1830 | 1831 | } |
| 1831 | 1832 | } |
| 1832 | − print ")\n\n " . $args{'purpose'} . "\n\n"; | |
| 1833 | + print ")\n\n"; | |
| 1834 | + $lineprefix = " "; | |
| 1835 | + output_highlight_rst($args{'purpose'}); | |
| 1836 | + print "\n"; | |
| 1833 | 1837 | |
| 1834 | 1838 | print ":Parameters:\n\n"; |
| 1839 | + $lineprefix = " "; | |
| 1835 | 1840 | foreach $parameter (@{$args{'parameterlist'}}) { |
| 1836 | 1841 | my $parameter_name = $parameter; |
| 1837 | 1842 | #$parameter_name =~ s/\[.*//; |
| @@ -1844,15 +1849,14 @@ sub output_function_rst(%) { · 6 unmodified lines | ||
| 1844 | 1849 | } |
| 1845 | 1850 | if (defined($args{'parameterdescs'}{$parameter_name}) && |
| 1846 | 1851 | $args{'parameterdescs'}{$parameter_name} ne $undescribed) { |
| 1847 | − my $oldprefix = $lineprefix; | |
| 1848 | − $lineprefix = " "; | |
| 1849 | 1852 | output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
| 1850 | − $lineprefix = $oldprefix; | |
| 1851 | 1853 | } else { |
| 1852 | 1854 | print "\n _undescribed_\n"; |
| 1853 | 1855 | } |
| 1854 | 1856 | print "\n"; |
| 1855 | 1857 | } |
| 1858 | + | |
| 1859 | + $lineprefix = $oldprefix; | |
| 1856 | 1860 | output_section_rst(@_); |
| 1857 | 1861 | } |
| 1858 | 1862 | |
| @@ -1874,14 +1878,16 @@ sub output_section_rst(%) { · 15 unmodified lines | ||
| 1874 | 1878 | sub output_enum_rst(%) { |
| 1875 | 1879 | my %args = %{$_[0]}; |
| 1876 | 1880 | my ($parameter); |
| 1881 | + my $oldprefix = $lineprefix; | |
| 1877 | 1882 | my $count; |
| 1878 | 1883 | my $name = "enum " . $args{'enum'}; |
| 1879 | 1884 | |
| 1880 | 1885 | print "\n\n.. c:type:: " . $name . "\n\n"; |
| 1881 | − print " " . $args{'purpose'} . "\n\n"; | |
| 1886 | + $lineprefix = " "; | |
| 1887 | + output_highlight_rst($args{'purpose'}); | |
| 1888 | + print "\n"; | |
| 1882 | 1889 | |
| 1883 | 1890 | print "..\n\n:Constants:\n\n"; |
| 1884 | − my $oldprefix = $lineprefix; | |
| 1885 | 1891 | $lineprefix = " "; |
| 1886 | 1892 | foreach $parameter (@{$args{'parameterlist'}}) { |
| 1887 | 1893 | print " `$parameter`\n"; |
| @@ -1892,6 +1898,7 @@ sub output_enum_rst(%) { · 4 unmodified lines | ||
| 1892 | 1898 | } |
| 1893 | 1899 | print "\n"; |
| 1894 | 1900 | } |
| 1901 | + | |
| 1895 | 1902 | $lineprefix = $oldprefix; |
| 1896 | 1903 | output_section_rst(@_); |
| 1897 | 1904 | } |
| @@ -1899,23 +1906,29 @@ sub output_enum_rst(%) { · 1 unmodified line | ||
| 1899 | 1906 | sub output_typedef_rst(%) { |
| 1900 | 1907 | my %args = %{$_[0]}; |
| 1901 | 1908 | my ($parameter); |
| 1902 | − my $count; | |
| 1909 | + my $oldprefix = $lineprefix; | |
| 1903 | 1910 | my $name = "typedef " . $args{'typedef'}; |
| 1904 | 1911 | |
| 1905 | 1912 | ### FIXME: should the name below contain "typedef" or not? |
| 1906 | 1913 | print "\n\n.. c:type:: " . $name . "\n\n"; |
| 1907 | − print " " . $args{'purpose'} . "\n\n"; | |
| 1914 | + $lineprefix = " "; | |
| 1915 | + output_highlight_rst($args{'purpose'}); | |
| 1916 | + print "\n"; | |
| 1908 | 1917 | |
| 1918 | + $lineprefix = $oldprefix; | |
| 1909 | 1919 | output_section_rst(@_); |
| 1910 | 1920 | } |
| 1911 | 1921 | |
| 1912 | 1922 | sub output_struct_rst(%) { |
| 1913 | 1923 | my %args = %{$_[0]}; |
| 1914 | 1924 | my ($parameter); |
| 1925 | + my $oldprefix = $lineprefix; | |
| 1915 | 1926 | my $name = $args{'type'} . " " . $args{'struct'}; |
| 1916 | 1927 | |
| 1917 | 1928 | print "\n\n.. c:type:: " . $name . "\n\n"; |
| 1918 | − print " " . $args{'purpose'} . "\n\n"; | |
| 1929 | + $lineprefix = " "; | |
| 1930 | + output_highlight_rst($args{'purpose'}); | |
| 1931 | + print "\n"; | |
| 1919 | 1932 | |
| 1920 | 1933 | print ":Definition:\n\n"; |
| 1921 | 1934 | print " ::\n\n"; |
| @@ -1944,6 +1957,7 @@ sub output_struct_rst(%) { · 22 unmodified lines | ||
| 1944 | 1957 | print " };\n\n"; |
| 1945 | 1958 | |
| 1946 | 1959 | print ":Members:\n\n"; |
| 1960 | + $lineprefix = " "; | |
| 1947 | 1961 | foreach $parameter (@{$args{'parameterlist'}}) { |
| 1948 | 1962 | ($parameter =~ /^#/) && next; |
| 1949 | 1963 | |
| @@ -1953,13 +1967,12 @@ sub output_struct_rst(%) { · 3 unmodified lines | ||
| 1953 | 1967 | ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; |
| 1954 | 1968 | $type = $args{'parametertypes'}{$parameter}; |
| 1955 | 1969 | print " `$type $parameter`" . "\n"; |
| 1956 | − my $oldprefix = $lineprefix; | |
| 1957 | − $lineprefix = " "; | |
| 1958 | 1970 | output_highlight_rst($args{'parameterdescs'}{$parameter_name}); |
| 1959 | − $lineprefix = $oldprefix; | |
| 1960 | 1971 | print "\n"; |
| 1961 | 1972 | } |
| 1962 | 1973 | print "\n"; |
| 1974 | + | |
| 1975 | + $lineprefix = $oldprefix; | |
| 1963 | 1976 | output_section_rst(@_); |
| 1964 | 1977 | } |
| 1965 | 1978 | |