| kernel-doc (43caf1a6823dc7c156cf38a6c71881c1e90cd3c2) | kernel-doc (f1583922bf9383ce0079dfdded959dfc5585dc5b) |
|---|---|
| 1#!/usr/bin/env perl 2# SPDX-License-Identifier: GPL-2.0 3 4use warnings; 5use strict; 6 7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## --- 27 unchanged lines hidden (view full) --- 36 [-nosymbol NAME] ... 37 ] 38 [-no-doc-sections] 39 [-export-file FILE] ... 40 FILE ... 41 42Run `kernel-doc -h` for details. 43 | 1#!/usr/bin/env perl 2# SPDX-License-Identifier: GPL-2.0 3 4use warnings; 5use strict; 6 7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## 8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## --- 27 unchanged lines hidden (view full) --- 36 [-nosymbol NAME] ... 37 ] 38 [-no-doc-sections] 39 [-export-file FILE] ... 40 FILE ... 41 42Run `kernel-doc -h` for details. 43 |
| 44=head1 DESCRIPTION 45 46Read C language source or header FILEs, extract embedded documentation comments, 47and print formatted documentation to standard output. 48 49The documentation comments are identified by the "/**" opening comment mark. 50 51See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 52 |
|
| 44=cut 45 46# 18/01/2001 - Cleanups 47# Functions prototyped as foo(void) same as foo() 48# Stop eval'ing where we don't need to. 49# -- huggie@earth.li 50 51# 27/06/2001 - Allowed whitespace after initial "/**" and --- 15 unchanged lines hidden (view full) --- 67 68# 25/07/2012 - Added support for HTML5 69# -- Dan Luedtke <mail@danrl.de> 70 71sub usage { 72 my $message = <<"EOF"; 73Usage: $0 [OPTION ...] FILE ... 74 | 53=cut 54 55# 18/01/2001 - Cleanups 56# Functions prototyped as foo(void) same as foo() 57# Stop eval'ing where we don't need to. 58# -- huggie@earth.li 59 60# 27/06/2001 - Allowed whitespace after initial "/**" and --- 15 unchanged lines hidden (view full) --- 76 77# 25/07/2012 - Added support for HTML5 78# -- Dan Luedtke <mail@danrl.de> 79 80sub usage { 81 my $message = <<"EOF"; 82Usage: $0 [OPTION ...] FILE ... 83 |
| 75Read C language source or header FILEs, extract embedded documentation comments, 76and print formatted documentation to standard output. 77 78The documentation comments are identified by "/**" opening comment mark. See 79Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. 80 | |
| 81Output format selection (mutually exclusive): 82 -man Output troff manual page format. This is the default. 83 -rst Output reStructuredText format. 84 -none Do not output documentation, only warnings. 85 86Output format selection modifier (affects only ReST output): 87 88 -sphinx-version Use the ReST C domain dialect compatible with an --- 2474 unchanged lines hidden --- | 84Output format selection (mutually exclusive): 85 -man Output troff manual page format. This is the default. 86 -rst Output reStructuredText format. 87 -none Do not output documentation, only warnings. 88 89Output format selection modifier (affects only ReST output): 90 91 -sphinx-version Use the ReST C domain dialect compatible with an --- 2474 unchanged lines hidden --- |