Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen conversion #722

Merged
merged 10 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ docs/xml
docs/build
docs/src
doc/doc*
doc/*
*.tmp
*.swo
*.swp
Expand Down
36 changes: 36 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@

docs_path:=./doc
doxyfile:=$(docs_path)/Doxyfile



.PHONY: usage

usage:
echo "make docs to create documentation"
echo "make nuke to rebuild the single header nuklear.h from source"
echo "make all to re-pack the header and create documentation"
echo "make install to "install" man files"


docs: $(docs_path)/html/index.html

$(docs_path)/html/index.html: $(docs_path)/doxygen-awesome-css/doxygen-awesome.css $(doxyfile)
doxygen $(doxyfile)

$(doxyfile):
doxygen -g $@

$(docs_path)/doxygen-awesome-css/doxygen-awesome.css:
git clone https://github.com/jothepro/doxygen-awesome-css.git $(docs_path)/doxygen-awesome-css --branch v2.3.4

nuke:
cd ./src && ./paq.sh

all: docs nuke

install:

clean:
rm -rf $(docs_path)/html

2,739 changes: 2,739 additions & 0 deletions doc/Doxyfile

Large diffs are not rendered by default.

26 changes: 0 additions & 26 deletions doc/Makefile

This file was deleted.

2 changes: 0 additions & 2 deletions doc/build.sh

This file was deleted.

2,974 changes: 0 additions & 2,974 deletions doc/index.html

This file was deleted.

11 changes: 0 additions & 11 deletions doc/nuklear.html

This file was deleted.

141 changes: 0 additions & 141 deletions doc/stddoc.c

This file was deleted.

Loading