From 12b7a80640621a8f12a7a7390636dc926b4d0625 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 27 Sep 2017 16:13:00 -0400 Subject: [PATCH] Added some notes on API documentation. (transplanted from 7ee477e62e86838eca158df16a724d417eef125f) --- docs/README-API-documentation.txt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/README-API-documentation.txt diff --git a/docs/README-API-documentation.txt b/docs/README-API-documentation.txt new file mode 100644 index 00000000..65f9b821 --- /dev/null +++ b/docs/README-API-documentation.txt @@ -0,0 +1,18 @@ +The API documentation is readable in a few ways: + +- Read physfs.h; it's _heavily_ documented and the primary source of reference + documentation for the library. +- Run Doxygen over the header, which produces nicer-to-browse documentation in + HTML, LaTeX, manpage, etc formats. This is done for you if Doxygen is + installed and you build the "docs" target in whatever project files CMake + generated for you. +- Too much trouble? We generated the HTML reference for you, online here: + + https://icculus.org/physfs/docs/ + +- We would love well-written tutorials for the latest version of PhysicsFS! + If you write one, we would love to list it here. Drop me a line about it: + icculus@icculus.org ... Thanks! + +--ryan. +