]> de.git.xonotic.org Git - xonotic/netradiant.git/blobdiff - README.doxygen
Backing out r347 and r345. Keeping r346.
[xonotic/netradiant.git] / README.doxygen
index f3847f6723f06081e60e02a7253823df1167f7f3..effbf3f40e3b7d96d2d227b1823a3da0380d41be 100644 (file)
@@ -1,51 +1,51 @@
- Documentation for generating doxygen documentation
----------------------------------------------------------
-
-1. Options for gendox
-More up-to-date command line options are available via
-the command ./gendox --help
-
-usage: "sh gendox [ <target(s)> ] [ -o <output_dir> ]"
-    or "./gendox [ <target(s)> ] [ -o <output_dir> ]"
-
-<target(s)> 
-  The directory, or directories to generate the 
-  documentation from.
-
--o
-  Specifies the output directory <output_dir> which
-  should follow the -o switch
-  
--q --quiet
-  Stops the script from outputing status information,
-  other than errors.
-  
--k --kill
-  Kills other running doxygen pids.
-
-eg: ./gendox include/ -o ../Documentation
-
-* This will produce documentation for the include files,
-and output to the directory specified one level above the
-current directory.
-
-The target can be the current directory "./" in which case
-doxygen will generate documentation for all subdirectories
-of the current directory recursively.
-
-The default output directory is currently ...
-> ../GtkRadiant-doxygen
-
-* If the script is called without any target directories
-it will generate documentation for the core of radiant...
-include/ libs/ radiant/ and plugins/
-
-If there are specific options that you'd like to customise,
-the DoxyConfig file is used to generate the file from which
-doxygen gets its settings from. So any changes that need
-to be made should be made to this file.
-
-
-Gef :]
-(gefdavis@dingoblue.net.au)
----------------------------------------------------------
+ Documentation for generating doxygen documentation\r
+---------------------------------------------------------\r
+\r
+1. Options for gendox\r
+More up-to-date command line options are available via\r
+the command ./gendox --help\r
+\r
+usage: "sh gendox [ <target(s)> ] [ -o <output_dir> ]"\r
+    or "./gendox [ <target(s)> ] [ -o <output_dir> ]"\r
+\r
+<target(s)> \r
+  The directory, or directories to generate the \r
+  documentation from.\r
+\r
+-o\r
+  Specifies the output directory <output_dir> which\r
+  should follow the -o switch\r
+  \r
+-q --quiet\r
+  Stops the script from outputing status information,\r
+  other than errors.\r
+  \r
+-k --kill\r
+  Kills other running doxygen pids.\r
+\r
+eg: ./gendox include/ -o ../Documentation\r
+\r
+* This will produce documentation for the include files,\r
+and output to the directory specified one level above the\r
+current directory.\r
+\r
+The target can be the current directory "./" in which case\r
+doxygen will generate documentation for all subdirectories\r
+of the current directory recursively.\r
+\r
+The default output directory is currently ...\r
+> ../GtkRadiant-doxygen\r
+\r
+* If the script is called without any target directories\r
+it will generate documentation for the core of radiant...\r
+include/ libs/ radiant/ and plugins/\r
+\r
+If there are specific options that you'd like to customise,\r
+the DoxyConfig file is used to generate the file from which\r
+doxygen gets its settings from. So any changes that need\r
+to be made should be made to this file.\r
+\r
+\r
+Gef :]\r
+(gefdavis@dingoblue.net.au)\r
+---------------------------------------------------------\r