*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> gnome-doc (1)              



NAME    [Toc]    [Back]

       gnome-doc - Documentation tool for GNOME

SYNOPSIS    [Toc]    [Back]

       gnome-doc [  -docbook | -html | -text | -man  ] [  -function funcname [
       -function funcname ...]	] [  c files  ]

DESCRIPTION    [Toc]    [Back]

       gnome-doc This will read a 'c' file and scan for embedded  comments  in
       the style of gnome comments (+minor extensions - see below).

       All output goes to stdout, with errors to stderr.

OPTIONS    [Toc]    [Back]

       -docbook -html -text -man
	      Set  output  format  using  one of -docbook -html -text or -man.
	      Default is man.

	      If set, then only generate documentation	for  the  given  function(s).
 All other functions are ignored.

       c files
	      list of 'c' files to process

FORMAT OF COMMENTS    [Toc]    [Back]

       In the following table,

		 (...)? signifies optional structure.
		 (...)* signifies 0 or more structure elements.

	     * function_name(:)? (- short description)?
	     * @parameterx: (description of parameter x)?)*
	    (* a blank line)?
	     * (Description:)? (Description of function)?
	     * (section header: (section description)? )*

	     So .. the trivial example would be:
	      * my_function

	     If the Description: header tag is omitted, then there must be a blank
	     line after the last parameter specification.
	     * my_function - does my stuff
	     * @my_arg: its mine damnit
	     * Does my stuff explained.

	    or, could also use:
	     * my_function - does my stuff
	     * @my_arg: its mine damnit
	     * Description: Does my stuff explained.

	    All descriptions can be multiline, apart from the short function

	    All descriptive text is further processed, scanning for the
	    following special patterns, which are highlighted appropriately.

	    funcname()	- function
	    $ENVVAR	- environmental variable
	    struct_name - name of a structure
	    @parameter	- name of a parameter
	    %CONST	- name of a constant.

AUTHOR    [Toc]    [Back]

       This   manual   page   was   written   by  Christian  Marillat  <marillat@debian.org> for the Debian GNU/Linux system (but  may  be  used  by

				09 januar 2002			  GNOME-DOC(1)
[ Back ]
 Similar pages
Name OS Title
gconfigger Linux Tool to change/read GNOME configuration entry.
loadshlib Linux Gnome Object Activation Directory
oafd Linux the GNOME Object Activation Daemon.
gnome-bug Linux Report a bug to the GNOME Bug Tracking System.
gnome_segv Linux Graphical interface segfault for Gnome program.
gnome-font-install Linux Fontmap file generator for gnome-print
manuals HP-UX list of HP-UX documentation
perlpod IRIX plain old documentation
texinfo OpenBSD software documentation system
info FreeBSD readable online documentation
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service