Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | pmbaty | 1 | The API documentation is readable in a few ways: |
| 2 | |||
| 3 | - Read physfs.h; it's _heavily_ documented and the primary source of reference |
||
| 4 | documentation for the library. |
||
| 5 | - Run Doxygen over the header, which produces nicer-to-browse documentation in |
||
| 6 | HTML, LaTeX, manpage, etc formats. This is done for you if Doxygen is |
||
| 7 | installed and you build the "docs" target in whatever project files CMake |
||
| 8 | generated for you. |
||
| 9 | - Too much trouble? We generated the HTML reference for you, online here: |
||
| 10 | |||
| 11 | https://icculus.org/physfs/docs/ |
||
| 12 | |||
| 13 | - We would love well-written tutorials for the latest version of PhysicsFS! |
||
| 14 | If you write one, we would love to list it here. Drop me a line about it: |
||
| 15 | icculus@icculus.org ... Thanks! |
||
| 16 | |||
| 17 | --ryan. |
||
| 18 |