From f974101ec655653a28dea7cd50cf46051c0099b7 Mon Sep 17 00:00:00 2001 From: Graham Pentheny Date: Sat, 6 Jan 2024 16:57:22 -0500 Subject: [PATCH] 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 --- ...ldingAndIntegrating.md => _2_BuildingAndIntegrating.md} | 2 +- Docs/{FAQ.md => _3_FAQ.md} | 0 Docs/{Roadmap.md => _99_Roadmap.md} | 2 +- Doxyfile | 7 +++---- 4 files changed, 5 insertions(+), 6 deletions(-) rename Docs/{BuildingAndIntegrating.md => _2_BuildingAndIntegrating.md} (97%) rename Docs/{FAQ.md => _3_FAQ.md} (100%) rename Docs/{Roadmap.md => _99_Roadmap.md} (97%) diff --git a/Docs/BuildingAndIntegrating.md b/Docs/_2_BuildingAndIntegrating.md similarity index 97% rename from Docs/BuildingAndIntegrating.md rename to Docs/_2_BuildingAndIntegrating.md index 638496ad0..dcde60f5e 100644 --- a/Docs/BuildingAndIntegrating.md +++ b/Docs/_2_BuildingAndIntegrating.md @@ -74,7 +74,7 @@ vcpkg install recast Recast and Detour strive to avoid heap allocations whenever possible. In the cases where they are needed, all allocations are routed through allocation functions that by default just wrap `malloc` and `free`. Additionally, the `rcAllocHint` enum gives some coarse-grained information about the intended lifetime of the allocation. -You can specify your own `rcAlloocFunc` and `rcFreeFunc` in `RecastAlloc.cpp` (and similarly in `DetourAlloc.cpp`) to tune heap usage to your specific needs. +You can specify your own `rcAllocFunc` and `rcFreeFunc` in `RecastAlloc.cpp` (and similarly in `DetourAlloc.cpp`) to tune heap usage to your specific needs. ## A Note on DLL exports and C API diff --git a/Docs/FAQ.md b/Docs/_3_FAQ.md similarity index 100% rename from Docs/FAQ.md rename to Docs/_3_FAQ.md diff --git a/Docs/Roadmap.md b/Docs/_99_Roadmap.md similarity index 97% rename from Docs/Roadmap.md rename to Docs/_99_Roadmap.md index fb93f6be5..83222a909 100644 --- a/Docs/Roadmap.md +++ b/Docs/_99_Roadmap.md @@ -8,7 +8,7 @@ If you're excited about contributing to Recast or want to understand what its fu ### Documentation & Web Presence (WIP) - ✅ **Project website** (GitHub pages). A home for docs, info, tutorials, etc. that's easy to find and navigate. There's stuff like the wiki system in GitHub that can serve this purpose, but it's not the greatest. -- ✅**Hosted API Reference**: We have extensive doxygen docs that we should also host on github pages. Ideally this would be implemented as a job for the CI process. +- ✅ **Hosted API Reference**: We have extensive doxygen docs that we should also host on github pages. Ideally this would be implemented as a job for the CI process. - **High-level design/overview**. Basically taking a lot of the "how does Recast work?" docs we have (and stuff on Mikko's blog) and surfacing them in a place that's easier to find. e.g. [this information](http://digestingduck.blogspot.com/2010/02/slides-from-past.html) should be integrated to the documentation. - **FAQ** to include answers to common questions like "can I use Recast on a spherical world?" etc. The small group of questions that come up often. - **Expand on configuration parameter docstrings**. Expand on the docstrings for the fields in `rcConfig`. diff --git a/Doxyfile b/Doxyfile index c38b83e43..978586f75 100644 --- a/Doxyfile +++ b/Doxyfile @@ -949,10 +949,9 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = . \ - README.md \ - CONTRIBUTING.md \ - CODE_OF_CONDUCT.md \ +INPUT = README.md \ + Docs \ + . \ DetourCrowd \ DetourTileCache \ Recast \