Skip to content

infini/_task

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 documentation.
	
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.


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages