search

littlefs-project / littlefs

A little fail-safe filesystem designed for microcontrollers
BSD 3-Clause "New" or "Revised" License
5.25k stars 804 forks source link

Request: setup Doxygen to generate gh-pages documentation #995

Open DeflateAwning opened 5 months ago

DeflateAwning commented 5 months ago

Easy guide to follow:

https://github.com/satu0king/Github-Documentation-With-Doxygen

Note that the one change from that documentation you'll need to make is enabling the following variables in the Doxyfile, in order to generate docs for functions:

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_METHODS = YES
geky commented 5 months ago

Hi @DeflateAwning thanks for creating an issue.

Agree this would be good to do. Will be adding it to the list of TODO items related to documentation/website.