libcangjie documentation
libcangjie is a very simple library:
- there is only one header to include:
cangjie.h - everything happens by instantiating a
Cangjiecontext, and then passing it to the various functions of the API.
These pages will document proper use of libcangjie. Although the interesting part is the last of the list, we recommend you read them in order:
- the possible error codes
- the supported Cangjie versions
- the available output filters
- the
CangjieCharstructure - the
CangjieCharListcharacter lists - the
Cangjiecontext
libcangjie also comes with a command-line tool, which can be seen as an
example of how to use the API, and is useful for testing/debugging purpose:
libcangjie_cli. Read its documentation for details on how to use
it.