docs/README-API-documentation.txt
author Ryan C. Gordon <icculus@icculus.org>
Fri, 12 Jun 2020 03:37:58 -0400
changeset 1692 acdcf93d1f9b
parent 1615 7ee477e62e86
permissions -rw-r--r--
android: PhysicsFS now has actual Android support. This compiled and worked on Android before, if you didn't care about PHYSFS_getBaseDir() and PHYSFS_getPrefDir() being useful. Now you can pass PHYSFS_init() some necessary Android objects to solve this. Passing NULL to PHYSFS_init is acceptable and will simply report "/" for the base dir and prefdir, under the assumption that the app queried the OS for these directly instead.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1615
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     1
The API documentation is readable in a few ways:
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     2
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     3
- Read physfs.h; it's _heavily_ documented and the primary source of reference
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     4
  documentation for the library.
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     5
- Run Doxygen over the header, which produces nicer-to-browse documentation in
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     6
  HTML, LaTeX, manpage, etc formats. This is done for you if Doxygen is
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     7
  installed and you build the "docs" target in whatever project files CMake
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     8
  generated for you.
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     9
- Too much trouble? We generated the HTML reference for you, online here:
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    10
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    11
      https://icculus.org/physfs/docs/
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    12
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    13
- We would love well-written tutorials for the latest version of PhysicsFS!
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    14
  If you write one, we would love to list it here. Drop me a line about it:
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    15
  icculus@icculus.org ... Thanks!
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    16
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    17
--ryan.
7ee477e62e86 Added some notes on API documentation.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    18