Add in a couple of examples that weren't properly linked

into the documentation.

Also fix a typo.

svn path=/trunk/kdesupport/qca/; revision=595156
This commit is contained in:
Brad Hards 2006-10-13 12:18:00 +00:00
parent 406ff9f765
commit 341b543c88
2 changed files with 57 additions and 43 deletions

View File

@ -491,16 +491,18 @@ EXCLUDE_PATTERNS = *.moc.* \
# the \include command).
EXAMPLE_PATH = examples/aes-cmac \
examples/base64test \
examples/certtest \
examples/ciphertest \
examples/cms \
examples/hashtest \
examples/hextest \
examples/mactest \
examples/providertest \
examples/base64test \
examples/randomtest \
examples/hextest \
examples/certtest \
examples/rsatest \
examples/ssltest \
examples/sslservtest \
examples/rsatest
examples/sslservtest
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@ -729,7 +731,7 @@ TREEVIEW_WIDTH = 250
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
GENERATE_LATEX = YES
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be

View File

@ -1,6 +1,54 @@
/** \example aes-cmac.cpp
This example 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
*/
/** \example base64test.cpp
The code below shows some simple operations on a Base64 object, converting
between QSecureArray and QString.
*/
/** \example certtest.cpp
This example shows how QCA::Certificate and QCA::CertificateCollection
can be used. Note that the argument, if you provide it, must be a
PEM encoded file collection.
*/
/** \example ciphertest.cpp
The code below shows the normal way to use the Cipher class.
*/
/** \example cmsexample.cpp
The code below shows the normal way to use the CMS class.
*/
/** \example hashtest.cpp
The code below shows how to use a Hash subclass
The code below shows how to use the Hash lass
*/
/** \example hextest.cpp
The code below shows some simple operations on a Hex object, converting
between QSecureArray and QString.
*/
@ -17,21 +65,6 @@ use of iterators and some member functions.
*/
/** \example base64test.cpp
The code below shows some simple operations on a Base64 object, converting
between QSecureArray and QString.
*/
/** \example hextest.cpp
The code below shows some simple operations on a Hex object, converting
between QSecureArray and QString.
*/
/** \example randomtest.cpp
The code below shows the normal way to use the Random class.
@ -68,25 +101,4 @@ just create a TlsConnection for each server connection.
*/
/** \example certtest.cpp
This example shows how QCA::Certificate and QCA::CertificateCollection
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
*/