Link the aes-cmac example into the API documentation.

svn path=/trunk/kdesupport/qca/; revision=503084
This commit is contained in:
Brad Hards 2006-01-28 08:07:11 +00:00
parent beef3740c2
commit fffd8e95b3
2 changed files with 17 additions and 1 deletions

View File

@ -490,7 +490,8 @@ EXCLUDE_PATTERNS = *.moc.* \
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH = examples/hashtest \
EXAMPLE_PATH = examples/aes-cmac \
examples/hashtest \
examples/mactest \
examples/providertest \
examples/base64test \

View File

@ -59,3 +59,18 @@ can be used. Note that the argument, if you provide it, must be a
PEM encoded file collection.
*/
/** \example aes-cmac.cpp
This examples shows how to implement a client side "provider".
There are three important parts to this
- the class derived from QCA::Provider (in this example called
"ClientSideProvider"), that generates the context class
- one or more context classes (in this example only one, implementing
AES-CMAC, called "AESCMACContext")
- a call to QCA::insertProvider, to add the QCA::Provider subclass
into QCA
*/