diff --git a/Docs/Conceptual/license_c.txt b/Docs/Conceptual/license_c.txt index 005d7b6..c2a3c1e 100644 --- a/Docs/Conceptual/license_c.txt +++ b/Docs/Conceptual/license_c.txt @@ -1,24 +1,27 @@ -/// @page License License -/// -/// -///
-/// Copyright (c) 2009-2011 Mikko Mononen memon@inside.org
-///
-/// This software is provided 'as-is', without any express or implied
-/// warranty.  In no event will the authors be held liable for any damages
-/// arising from the use of this software.
-///
-/// Permission is granted to anyone to use this software for any purpose,
-/// including commercial applications, and to alter it and redistribute it
-/// freely, subject to the following restrictions:
-///
-/// 1. The origin of this software must not be misrepresented; you must not
-///    claim that you wrote the original software. If you use this software
-///    in a product, an acknowledgment in the product documentation would be
-///    appreciated but is not required.
-///
-/// 2. Altered source versions must be plainly marked as such, and must not be
-///    misrepresented as being the original software.
-///
-/// 3. This notice may not be removed or altered from any source distribution.
-/// 
\ No newline at end of file
+
+/** 
+@page License License
+
+
+Copyright (c) 2009-2011 Mikko Mononen memon@inside.org
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.
+
+ +*/ \ No newline at end of file diff --git a/Docs/Readme.txt b/Docs/Readme.txt new file mode 100644 index 0000000..9c18205 --- /dev/null +++ b/Docs/Readme.txt @@ -0,0 +1,42 @@ +This directory contains source for the documentation. It is also the +build target for doxygen output. + +Directory Layout + +. (Docs root) + + High level content and format files. (E.g. css, header, footer.) + +./Conceptual + + Conceptual (non-api) documentation such as overviews, how-to's, etc. + The main index page content is also in this directory. + +./Extern + + API documentation that is located outside the source files. + + When the API documentation gets too big or complex for the header + and source files, it goes in this directory. + +./Images + + Images related to the docuemntation. + +Miscellany + +One of the requirements for the API documentation is that it +has the minimum possible impact on the declarations in the +header files. So, in general, the header file declarations only +contain summary documentation. The detail documentation +is placed as follows: + +1. If an element is defined in a cpp file, then place + the detail documentation in the source file. +2. If an element does not have an associated cpp file, then + place the detail documentation at the end of the header file. +3. If there is a lot of detail documentation cluttering up + the end of a header file, then the content is moved to + a separate file in the Extern directory. + + diff --git a/Doxyfile b/Doxyfile index cfe09ca..c2cb030 100644 --- a/Doxyfile +++ b/Doxyfile @@ -617,7 +617,8 @@ INPUT = Detour \ DetourCrowd \ DetourTileCache \ Recast \ - Docs\Conceptual + Docs\Conceptual \ + Docs\Extern # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -637,7 +638,8 @@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.cpp \ *.h \ - *_c.txt + *_c.txt \ + *_api.txt # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO.