| kernel-doc (9598f91f2216ba51fef472a7fc3074a0c8429a96) | kernel-doc (d28bee0c0a9c6abddf1d14c69f188400e994eb5a) |
|---|---|
| 1#!/usr/bin/perl -w 2 3use strict; 4 5## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 6## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 7## Copyright (C) 2001 Simon Huggins ## 8## ## --- 31 unchanged lines hidden (view full) --- 40# 41# This will read a 'c' file and scan for embedded comments in the 42# style of gnome comments (+minor extensions - see below). 43# 44 45# Note: This only supports 'c'. 46 47# usage: | 1#!/usr/bin/perl -w 2 3use strict; 4 5## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 6## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## 7## Copyright (C) 2001 Simon Huggins ## 8## ## --- 31 unchanged lines hidden (view full) --- 40# 41# This will read a 'c' file and scan for embedded comments in the 42# style of gnome comments (+minor extensions - see below). 43# 44 45# Note: This only supports 'c'. 46 47# usage: |
| 48# kerneldoc [ -docbook | -html | -text | -man ] | 48# kernel-doc [ -docbook | -html | -text | -man ] |
| 49# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile 50# or 51# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile 52# 53# Set output format using one of -docbook -html -text or -man. Default is man. 54# 55# -function funcname 56# If set, then only generate documentation for the given function(s). All 57# other functions are ignored. 58# 59# -nofunction funcname 60# If set, then only generate documentation for the other function(s). All 61# other functions are ignored. Cannot be used with -function together | 49# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile 50# or 51# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile 52# 53# Set output format using one of -docbook -html -text or -man. Default is man. 54# 55# -function funcname 56# If set, then only generate documentation for the given function(s). All 57# other functions are ignored. 58# 59# -nofunction funcname 60# If set, then only generate documentation for the other function(s). All 61# other functions are ignored. Cannot be used with -function together |
| 62# (yes thats a bug - perl hackers can fix it 8)) | 62# (yes, that's a bug -- perl hackers can fix it 8)) |
| 63# 64# c files - list of 'c' files to process 65# 66# All output goes to stdout, with errors to stderr. 67 68# 69# format of comments. 70# In the following table, (...)? signifies optional structure. --- 358 unchanged lines hidden (view full) --- 429 print "<dd>"; 430 output_highlight($args{'parameterdescs'}{$parameter}); 431 } 432 print "</dl>\n"; 433 output_section_html(@_); 434 print "<hr>\n"; 435} 436 | 63# 64# c files - list of 'c' files to process 65# 66# All output goes to stdout, with errors to stderr. 67 68# 69# format of comments. 70# In the following table, (...)? signifies optional structure. --- 358 unchanged lines hidden (view full) --- 429 print "<dd>"; 430 output_highlight($args{'parameterdescs'}{$parameter}); 431 } 432 print "</dl>\n"; 433 output_section_html(@_); 434 print "<hr>\n"; 435} 436 |
| 437# output tyepdef in html | 437# output typedef in html |
| 438sub output_typedef_html(%) { 439 my %args = %{$_[0]}; 440 my ($parameter); 441 my $count; 442 print "<h2>typedef ".$args{'typedef'}."</h2>\n"; 443 444 print "<b>typedef ".$args{'typedef'}."</b>\n"; 445 output_section_html(@_); --- 1438 unchanged lines hidden --- | 438sub output_typedef_html(%) { 439 my %args = %{$_[0]}; 440 my ($parameter); 441 my $count; 442 print "<h2>typedef ".$args{'typedef'}."</h2>\n"; 443 444 print "<b>typedef ".$args{'typedef'}."</b>\n"; 445 output_section_html(@_); --- 1438 unchanged lines hidden --- |