Commit Graph

12 Commits

Author SHA1 Message Date
Graham Pentheny
f974101ec6 Fixed ordering of custom pages in doxygen's sidebar
Apparently it's alphabetical and based on the order in which the files are specified in INPUT
2024-01-06 16:57:22 -05:00
Graham Pentheny
1c87cff00c Improved doxygen output (#681)
Added logo, updated doxyfile, fixed alignment of top-level readme, and changed the logo url to an s3-hosted file since github has restrictions that prevent it from loading on recastnav.com
2023-12-28 18:23:26 -05:00
Graham Pentheny
53089459fa Docs Overhaul (#680)
A lot of the auxiliary project documentation was pretty old, redundant, or could use some polishing.  This change fixes up some wording, grammar, layout and generally cleans up the docs a bit.  It's not perfection, but it's an improvement

I also tried to streamline and beautify the top-level `README.md` to be more appealing, clear, and to direct people to the official docs.  To this end, I moved the building instructions to This is based on what I've seen in some other popular github projects.
2023-12-28 17:06:03 -05:00
Graham Pentheny
ede5c5d85a Added code of conduct to doxygen input 2023-03-18 18:18:58 -04:00
Graham Pentheny
250c3041ce Added development roadmap 2022-11-25 21:38:11 -05:00
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
c464d91fe8 Updated some old documentation (#209) 2016-06-08 11:06:01 -04: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
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
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
Cameron hart
d5729c678b Changed header comments to use Doxygen format and added configuration Doxyfile. 2011-05-06 23:22:08 +00:00