Skip to content

Commit

Permalink
Fixed ordering of custom pages in doxygen's sidebar
Browse files Browse the repository at this point in the history
Apparently it's alphabetical and based on the order in which the files are specified in INPUT
  • Loading branch information
grahamboree committed Jan 6, 2024
1 parent cc131d8 commit f974101
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion Docs/Roadmap.md → Docs/_99_Roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
7 changes: 3 additions & 4 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down

0 comments on commit f974101

Please sign in to comment.