Development/Tools/apidox - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:50:26Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:44:06Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 7:
Line 7:
  ===HTML pages===   ===HTML pages===
  Generate apidox in the KDE format using   Generate apidox in the KDE format using
− <code> + <syntaxhighlight lang="text">
  % cd html_dir   % cd html_dir
  % /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \   % /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \
Line 21:
Line 21:
    
  To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:   To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:
− <code> + <syntaxhighlight lang="text">
  % cd source_dir   % cd source_dir
  % /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh   % /path/to/trunk/KDE/kdesdk/scripts/kdedoxygen.sh
Line 36:
Line 36:
  Man page lovers can generate man pages using {{program|kdedoxyman.sh}}   Man page lovers can generate man pages using {{program|kdedoxyman.sh}}
  Like so:   Like so:
− <code> + <syntaxhighlight lang="text">
  % cd source_dir   % cd source_dir
  % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share   % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share
Line 42:
Line 42:
  <br>   <br>
  You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}:   You can also generate man pages from Qt source code using {{program|kdedoxyman.sh}}:
− <code> + <syntaxhighlight lang="text">
  % cd qt-copy/src   % cd qt-copy/src
  % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share   % /path/trunk/KDE/kdesdk/scripts/kdedoxyman.sh -d /path/kdeinstall/share



Nicolas17: Remove ‘Intro heading
2010-04-01T16:34:12Z
Remove ‘Intro heading

				
				
				
				
			
			← Older revision
			Revision as of 16:34, 1 April 2010
			
Line 1:
Line 1:
− == Intro ==  
  The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code.   The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code.
    



Tampakrap: corrected link description
2009-05-22T00:40:00Z
corrected link description

				
				
				
				
			
			← Older revision
			Revision as of 00:40, 22 May 2009
			
Line 60:
Line 60:
  <pre>   <pre>
  % cd source_dir   % cd source_dir
− % /path/trunk/KDE/kdesk/scripts/kdedoxyqt.sh + % /path/trunk/KDE/kdesdk/scripts/kdedoxyqt.sh
  [wait]   [wait]
  </pre>   </pre>



Winterz: add a section for Qt assistant
2009-04-14T14:57:02Z
add a section for Qt assistant

				
				
				
				
			
			← Older revision
			Revision as of 14:57, 14 April 2009
			
Line 49:
Line 49:
  <br>   <br>
  and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable.   and then add {{path|/path/kdeinstall/share/man}} to your $MANPATH environment variable.
  + 
  + ===Qt Assistant===
  + If you like to view API documentation with Qt's {{program|assistant}}, then you can generate the necessary 'qch' files using {{program|kdedoxyqt.sh}}.
  + 
  + Note that {{program|kdedoxyqt.sh}} requires {{program|doxygen}} as well as {{program|qhelpgenerator}} from the Qt toolkit.
  + 
  + {{warning|doxygen v1.5.7 or above is required.}}
  + 
  + To use:
  + <pre>
  + % cd source_dir
  + % /path/trunk/KDE/kdesk/scripts/kdedoxyqt.sh
  + [wait]
  + </pre>
  + 
  + You should now have a file called apidocs/qch/KDE-4.2.qch in this current working directory. Copy KDE-4.2.qch some place for safe keeping.
  + 
  + Now, start {{program|assistant}}.  Go into Edit->Preferences->Documentation
  + and add the safe copy of KDE-4.2.qch into the db.



Pippin: /* HTML pages */
2009-01-02T19:29:01Z
‎HTML pages

				
				
				
				
			
			← Older revision
			Revision as of 19:29, 2 January 2009
			
Line 19:
Line 19:
  * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.   * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.
    
− * The QTDOCDIR environment variable should point to the html folder of the Qt documentation.  If QTDIR points to the Qt source directory, there is no need to set QTDOCDIR. + * The QTDOCDIR environment variable should point to the html folder of the Qt documentation.  If QTDOCDIR is not set, doxygen.sh will try to find the documentation based on the value of QTDIR.
    
  To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:   To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:



Pippin: /* HTML pages */
2009-01-02T19:06:39Z
‎HTML pages

				
				
				
				
			
			← Older revision
			Revision as of 19:06, 2 January 2009
			
Line 19:
Line 19:
  * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.   * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.
    
− * The QTDOCDIR environment variable must first be set to point to the html folder of the Qt documentation.  If QTDIR points to the Qt source directory, there is no need to set QTDOCDIR. + * The QTDOCDIR environment variable should point to the html folder of the Qt documentation.  If QTDIR points to the Qt source directory, there is no need to set QTDOCDIR.
    
  To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:   To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:



Pippin: /* HTML pages */
2009-01-02T19:05:56Z
‎HTML pages

				
				
				
				
			
			← Older revision
			Revision as of 19:05, 2 January 2009
			
Line 19:
Line 19:
  * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.   * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.
    
− * QTDIR environment variable must first be set to point to the Qt installation directory. + * The QTDOCDIR environment variable must first be set to point to the html folder of the Qt documentation.  If QTDIR points to the Qt source directory, there is no need to set QTDOCDIR.
    
  To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:   To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:



Pippin: /* HTML pages */
2009-01-02T19:01:32Z
‎HTML pages

				
				
				
				
			
			← Older revision
			Revision as of 19:01, 2 January 2009
			
Line 17:
Line 17:
  Notes:   Notes:
    
− * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory. + * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.  However, you can use the $HOME environment variable instead.
    
  * QTDIR environment variable must first be set to point to the Qt installation directory.   * QTDIR environment variable must first be set to point to the Qt installation directory.





Djarvie: /* HTML pages */ How to generate HTML apidox in KDE format
2008-08-12T14:19:25Z
‎HTML pages:  How to generate HTML apidox in KDE format

				
				
				
				
			
			← Older revision
			Revision as of 14:19, 12 August 2008
			
Line 7:
Line 7:
  == Generating ==   == Generating ==
  ===HTML pages===   ===HTML pages===
− Generate apidox in html using {{program|kdedoxygen.sh}}: + Generate apidox in the KDE format using
  + <code>
  + % cd html_dir
  + % /path/to/trunk/KDE/kdelibs/doc/api/doxygen.sh --recurse \
  +     --doxdatadir=/path/to/trunk/KDE/kdelibs/doc/common \
  +     /path/to/trunk/KDE/kdelibs
  + </code>
  +  
  + Notes:
  +  
  + * You must type the paths in full - the script doesn't understand tilde ('~') representing your home directory.
  +  
  + * QTDIR environment variable must first be set to point to the Qt installation directory.
  +  
  + To generate documentation in {{program|doxygen}} style instead of KDE style, use {{program|kdedoxygen.sh}}:
  <code>   <code>
  % cd source_dir   % cd source_dir

← Older revision		Revision as of 16:34, 1 April 2010
Line 1:		Line 1:
−	~~== Intro ==~~
	The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code.		The KDE project uses [http://www.doxygen.org doxygen] to generate API documentation from source code.

← Older revision		Revision as of 14:57, 14 April 2009
Line 49:		Line 49:
	<br>		<br>
	and then add {{path\|/path/kdeinstall/share/man}} to your $MANPATH environment variable.		and then add {{path\|/path/kdeinstall/share/man}} to your $MANPATH environment variable.
		+
		+	===Qt Assistant===
		+	If you like to view API documentation with Qt's {{program\|assistant}}, then you can generate the necessary 'qch' files using {{program\|kdedoxyqt.sh}}.
		+
		+	Note that {{program\|kdedoxyqt.sh}} requires {{program\|doxygen}} as well as {{program\|qhelpgenerator}} from the Qt toolkit.
		+
		+	{{warning\|doxygen v1.5.7 or above is required.}}
		+
		+	To use:
		+	<pre>
		+	% cd source_dir
		+	% /path/trunk/KDE/kdesk/scripts/kdedoxyqt.sh
		+	[wait]
		+	</pre>
		+
		+	You should now have a file called apidocs/qch/KDE-4.2.qch in this current working directory. Copy KDE-4.2.qch some place for safe keeping.
		+
		+	Now, start {{program\|assistant}}. Go into Edit->Preferences->Documentation
		+	and add the safe copy of KDE-4.2.qch into the db.