QuasarApp/qca
4
0
Fork 0
mirror of https://github.com/QuasarApp/qca.git synced 2025-05-18 21:19:33 +00:00
Code Issues Projects Releases Wiki Activity

Minor docs tweaks.

Browse Source 
svn path=/trunk/kdesupport/qca/; revision=705256
This commit is contained in:
Brad Hards 2007-08-27 15:36:18 +00:00
parent b34c1ce1cd
commit 57d0f8c93a
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/QtCrypto/qca_basic.h
View File

@ -1,7 +1,7 @@
/* /*
* qca_basic.h - Qt Cryptographic Architecture * qca_basic.h - Qt Cryptographic Architecture
* Copyright (C) 2003-2007 Justin Karneges <justin@affinix.com> * Copyright (C) 2003-2007 Justin Karneges <justin@affinix.com>
* Copyright (C) 2004-2006 Brad Hards <bradh@frogmouth.net> * Copyright (C) 2004-2007 Brad Hards <bradh@frogmouth.net>
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public * modify it under the terms of the GNU Lesser General Public
@ -22,7 +22,7 @@
/** /**
\file qca_basic.h \file qca_basic.h
Header file for classes for cryptographic primitives (basic operations) Header file for classes for cryptographic primitives (basic operations).
\note You should not use this header directly from an \note You should not use this header directly from an
application. You should just use <tt> \#include \<QtCrypto> application. You should just use <tt> \#include \<QtCrypto>
@ -47,7 +47,7 @@ namespace QCA {
/** /**
\class Random qca_basic.h QtCrypto \class Random qca_basic.h QtCrypto
Source of random numbers Source of random numbers.
QCA provides a built in source of random numbers, which QCA provides a built in source of random numbers, which
can be accessed through this class. You can also use can be accessed through this class. You can also use
@ -73,7 +73,7 @@ public:
/** /**
Copy constructor Copy constructor
\param from the Random object to copy from \param from the %Random object to copy from
*/ */
Random(const Random &from); Random(const Random &from);
@ -82,7 +82,7 @@ public:
/** /**
Assignment operator Assignment operator
\param from the Random object to copy state from \param from the %Random object to copy state from
*/ */
Random & operator=(const Random &from); Random & operator=(const Random &from);
@ -97,7 +97,7 @@ public:
uchar nextByte(); uchar nextByte();
/** /**
Provide a specified number of random bytes Provide a specified number of random bytes.
This method isn't normally required - you should use This method isn't normally required - you should use
the static randomArray() method instead. the static randomArray() method instead.
@ -117,12 +117,12 @@ public:
myRandomChar = QCA::Random::randomChar(); myRandomChar = QCA::Random::randomChar();
\endcode \endcode
If you need a number of bytes, perhaps randomArray() may be of use If you need a number of bytes, perhaps randomArray() may be of use.
*/ */
static uchar randomChar(); static uchar randomChar();
/** /**
Provide a random integer Provide a random integer.
This is the normal way of obtaining a single random integer, This is the normal way of obtaining a single random integer,
as shown below: as shown below:
@ -133,7 +133,7 @@ myRandomInt = QCA::Random::randomInt();
static int randomInt(); static int randomInt();
/** /**
Provide a specified number of random bytes Provide a specified number of random bytes.
\code \code
// build a 30 byte secure array. // build a 30 byte secure array.
@ -210,9 +210,9 @@ public:
Constructor Constructor
\param type label for the type of hash to be \param type label for the type of hash to be
created (eg "sha1" or "md2") created (for example, "sha1" or "md2")
\param provider the name of the provider plugin \param provider the name of the provider plugin
for the subclass (eg "qca-openssl") for the subclass (eg "qca-ossl")
*/ */
explicit Hash(const QString &type, const QString &provider = QString()); explicit Hash(const QString &type, const QString &provider = QString());
/** /**

2
include/QtCrypto/qca_core.h
View File

@ -291,7 +291,7 @@ QCA_EXPORT void setProviderPriority(const QString &name, int priority);
/** /**
Return the priority of a specified provider Return the priority of a specified provider
The name of the provider (eg "qca-openssl") is used to look up the The name of the provider (eg "qca-ossl") is used to look up the
current priority associated with that provider. If the provider current priority associated with that provider. If the provider
is not found (or something else went wrong), -1 is returned. is not found (or something else went wrong), -1 is returned.