diff options
author | John Mark Bell <jmb@netsurf-browser.org> | 2009-01-08 20:30:48 +0000 |
---|---|---|
committer | John Mark Bell <jmb@netsurf-browser.org> | 2009-01-08 20:30:48 +0000 |
commit | 78d9f91ac9ba645b60fcc2a5fa72e2fe5965d597 (patch) | |
tree | 508cb6d9c97b6e6a74e237fa3864855b38f10abd | |
parent | d2cfc4113b37234f5209f62d50697bb7fa606070 (diff) | |
download | libhubbub-78d9f91ac9ba645b60fcc2a5fa72e2fe5965d597.tar.gz libhubbub-78d9f91ac9ba645b60fcc2a5fa72e2fe5965d597.tar.bz2 |
Document "make docs"
Document the Aliases file, what it's used for, and where a copy can be found.
svn path=/trunk/hubbub/; revision=6001
-rw-r--r-- | README | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -72,3 +72,17 @@ API documentation public API may be found in the "include" directory. The "examples" directory contains commented examples of how to use hubbub. + Additionally, you can use doxygen to auto-generate API documentation, thus: + + $ make docs + + Then open the build/docs/html/index.html file in a web browser. + +A note on character set aliases +------------------------------- + + Hubbub uses an external mapping file to encode relationships between + character set names. This is the "Aliases" file. A copy may be found at + test/data/Aliases. The path to this file is required when calling + hubbub_initialise(). + |