12 Commits

Author SHA1 Message Date
Graham Pentheny
2b0c244d12
Updated doxygen output (#581)
- Upgraded doxyfile to latest format
- Fixed a bunch of warnings and errors in docstrings that doxygen was complaining about
- Added the doxygen-awesome theme to modernize the output
- Removed a duplicate screenshot we'd had in the docs folder
- Moved the RecastDemo screenshot into the Docs/images folder
- Changed the doxygen main page to be the README.md since the dedicated main page file we had was nearly identical but out of date
- Added CONTRIBUTING.md so it's part of the generated doxygen output
- Removed duplicate license file to avoid confusion
- Combined the FAQ with the Recast_api.txt, since the FAQ was essentially just better docs for the members of `rcConfig`
2022-11-23 00:13:38 -05:00
Graham Pentheny
4e233f22b4 Added configuration protips from Mikko's blog to a FAQ 2022-10-15 01:59:47 -04:00
Graham Pentheny
c464d91fe8 Updated some old documentation (#209) 2016-06-08 11:06:01 -04:00
Stephen Pratt
085bbf2348 Doc Home Page Spelling, Grammar, and Formatting
Updates to the home page file include:

Fixes spelling error.
Minor grammar fixes.  (Added 'the', 'and', etc.)
Standardizes formatting for the product and folder names.
2014-05-02 09:07:05 -06:00
Stephen Pratt
c93b11eafd Add Doc Build Info To ReadMe File
Adds some information on building the documentation to the documentation
ReadMe file.
2014-04-23 12:24:22 -06:00
Stephen Pratt
30558a7c7d Sync Doc Home Page Content with GitHub Home
Updates the content of the documentation home page to match the content
of the GitHub repository home page.  This includes the new Recast
introduction image, premake4 based build info, etc.
2014-04-23 12:12:37 -06:00
Stephen Pratt
3458b9c820 Upgrade to Doxygen 1.8.6 from 1.7.3
Upgrades Doxygen configuration files to 1.8.6.  The upgrade results in
breaking changes (can't use original configuration) so all Doxygen files
were regenerated and updated as needed.

The Doxyfile shows a large number of changes, but most are the comments
and new settings created by the Doxygen auto-upgrade process.
Otherwise, some obsolete settings were removed and the logo was set to
none since its source image no longer exists in the repository.

Where appropriate the configuration files were updated to link to the
new Git repository.  This is the only significant document content
change.
2014-04-23 12:09:50 -06:00
Mikko Mononen
8395e9fc8a Fixed typo 2013-09-16 21:15:35 +02:00
Stephen Pratt
6f5c9f9b82 Recast: Detail API documentation for the members declared in Recast.h. (Complete)
Recast.h: Completed rcPolyMeshDetail through end, plus updates to existing documentation.
Configuration: Removed DebugUtils directory from the document build.
Configuration: Fixed issue 179. (Backslashes)
2011-08-29 23:03:16 +00:00
Stephen Pratt
5553d19d59 Recast: Detail API documentation for the elements declared in Recast.h. (Partial)
The elements through rcPolyMesh are complete.
2011-08-22 21:49:21 +00:00
Stephen Pratt
a20f4192f3 Update Doxygen configuration and conceptual content. (Minor changes.) 2011-08-22 21:43:59 +00:00
Stephen Pratt
11fe155861 Update Doxygen configuration and add initial documentation support files. 2011-08-15 16:45:39 +00:00