changeset 1053:78798d3af8f0

Fixed doxygen build warnings.
author Emanuel Schuetze <emanuel@intevation.de>
date Tue, 09 Sep 2014 15:22:19 +0200
parents 0b2169f7ce09
children 0d92ab04d61c
files cinst/main.c cinst/mozilla.c cinst/nss-secitemlist.h cinst/nssstore_linux.c common/binverify.h common/linuxlockfile.h common/listutil.h common/selftest.h common/util.h ui/administratorwindow.h ui/certificateitemwidget.h ui/certificatetabledelegate.h ui/createcertlistdialog.h ui/createinstallerdialog.h ui/downloader.h ui/installwrapper.h ui/processhelp.h ui/processwaitdialog.h ui/proxysettingsdlg.h ui/sslconnection.cpp ui/sslconnection.h ui/taskscheduler.h ui/textoverlaybutton.h
diffstat 23 files changed, 58 insertions(+), 43 deletions(-) [+]
line wrap: on
line diff
--- a/cinst/main.c	Fri Sep 05 16:16:57 2014 +0200
+++ b/cinst/main.c	Tue Sep 09 15:22:19 2014 +0200
@@ -14,15 +14,15 @@
  *  process will modify system wide certificate stores.
  *  Otherwise only the users certificate stores are modified.
  *
- *  The first parameter to this process should be list=<file_name>
+ *  The first parameter to this process should be list=\<file_name\>
  *  of the certificate list to work on. The second parameter should
- *  be choices=<choices_file_name>|uninstall
+ *  be choices=\<choices_file_name\>|uninstall
  *
  *  choices_file_name should be the absolute path to an
  *  choices file formatted as:
  *
- *  I:<certificate>
- *  R:<certificate>
+ *  I:\<certificate\><BR>
+ *  R:\<certificate\>
  *
  *  Line breaks can be system dependent in the Choices file.
  *
--- a/cinst/mozilla.c	Fri Sep 05 16:16:57 2014 +0200
+++ b/cinst/mozilla.c	Tue Sep 09 15:22:19 2014 +0200
@@ -12,12 +12,12 @@
  * Reads from a file given on command line or stdin a list of
  * instructions in the form:
  *
- * I:<base64 DER econded certificate>
- * R:<base64 DER econded certificate>
+ * I:\<base64 DER econded certificate\> <BR>
+ * R:\<base64 DER econded certificate\>
  * ...
  *
  * With one instruction per line. the maximum size of an input
- * line is 9999 characters (including the \r\n) at the end of the line.
+ * line is 9999 characters (including the \\r\\n) at the end of the line.
  *
  * Certificates marked with I: will be installed and the ones
  * marked with R: will be searched and if available removed from
@@ -153,14 +153,14 @@
  * Parse the profiles.ini and extract all profile paths from that.
  * The expected data is in the form:
  *
- * [Profile99]
- * IsRelative=1
- * Path=Example/fooo.bar
+ * [Profile99]<BR>
+ * IsRelative=1<BR>
+ * Path=Example/foo.bar
  *
- * or
- * [Profile0]
- * IsRelative=0
- * Path=c:\foo\bar\baz
+ * or<BR>
+ * [Profile0]<BR>
+ * IsRelative=0<BR>
+ * Path=c:\\foo\\bar\\baz
  *
  * Mozilla also accepts the ini file on Windows even if it is UTF-16
  * encoded but never writes UTF-16 on its own.  So currently we ignore
@@ -549,7 +549,7 @@
  *
  * Should be freed by caller.
  * @param[in] secitemp ponts to an SECItem holding the DER certificate.
- * @retruns a string of the from "CN of Subject - O of Subject"
+ * @returns a string of the from "CN of Subject - O of Subject"
  */
 static char *
 nss_cert_name(SECItem *secitemp)
@@ -774,6 +774,7 @@
  * Reads command lines (R: and I:) from standard input and puts the
  * certificates to process in two SECItem lists holding the
  * certificates in DER format.
+ * @param[inout] stream from standard input
  * @param[inout] install_list list of SECItems with certifiactes to install
  * @param[inout] remove_list list of SECItems with certifiactes to remove
  */
--- a/cinst/nss-secitemlist.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/cinst/nss-secitemlist.h	Tue Sep 09 15:22:19 2014 +0200
@@ -39,7 +39,7 @@
  * @brief Remove and return first SECItem from list
  *
  * @param[inout] list pointer to the list to which the item will be added.
- * @retruns the removed item, or NULL if list is empty.
+ * @returns the removed item, or NULL if list is empty.
  * The caller shoud free this item after use.
  */
 SECItem *seciteml_pop (seciteml_t **list);
--- a/cinst/nssstore_linux.c	Fri Sep 05 16:16:57 2014 +0200
+++ b/cinst/nssstore_linux.c	Tue Sep 09 15:22:19 2014 +0200
@@ -37,8 +37,8 @@
  *
  * @param [in] to_install strv of DER encoded certificates to be added.
  * @param [in] to_remove strv of DER encoded certificates to be remvoed.
- * @param [in] uid_t uid of the user to install certificates for.
- * @param [in] gid_t the gid of the user to install certificates for.
+ * @param [in] uid uid of the user to install certificates for.
+ * @param [in] gid the gid of the user to install certificates for.
  * @param [in] homedir the homedir of the user.
  *
  * @returns childs pid on success. -1 on failure
--- a/common/binverify.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/common/binverify.h	Tue Sep 09 15:22:19 2014 +0200
@@ -44,7 +44,7 @@
  * file.
  *
  * On Linux the file is epxected to and with the pattern of
- * \r\nS: (0x0d0a533A) followed by a 3072 Bit Base64 encoded RSA
+ * \\r\\nS: (0x0d0a533A) followed by a 3072 Bit Base64 encoded RSA
  * signature.
  * The signature is verified against the built in codesigning key in
  * the same certificate that is used for windows verification.
--- a/common/linuxlockfile.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/common/linuxlockfile.h	Tue Sep 09 15:22:19 2014 +0200
@@ -26,7 +26,7 @@
 /**
  * @brief close a lockfile
  * @details unlock and close a lockfile for the given file descriptor.
- * @param[in] path to the lockfile
+ * @param[in] fd TODO
  * @returns the file descriptor of the lockfile or -1 on error
  */
 void close_lockfile(int fd);
--- a/common/listutil.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/common/listutil.h	Tue Sep 09 15:22:19 2014 +0200
@@ -86,7 +86,7 @@
  *
  * The caller needs to free data
  *
- * @param[in] fileName Name of the file.
+ * @param[in] file_name Name of the file.
  * @param[out] data the file content
  * @param[out] size size in bytes of the file content.
  * @param[in] max_size the maximum amount of bytes to read.
--- a/common/selftest.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/common/selftest.h	Tue Sep 09 15:22:19 2014 +0200
@@ -8,7 +8,9 @@
  * See LICENSE.txt for details.
  */
 
-/** @file self test against manipulation
+/** 
+ * @file selftest.h 
+ * @brief self test against manipulation
  *
  * The selftest is intended to detect untargeted manipulation or
  * corruption of the executable. Circumvention of the selftest
--- a/common/util.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/common/util.h	Tue Sep 09 15:22:19 2014 +0200
@@ -43,7 +43,7 @@
  * On linux this looks for the installation configuration in /etc
  * and checks if the current process is inside the installation prefix.
  *
- * The checked path is limited to MAX_PATH on Windows and @MAX_PATH_LINUX on
+ * The checked path is limited to MAX_PATH on Windows and \@MAX_PATH_LINUX on
  * Linux.
  */
 bool is_system_install();
--- a/ui/administratorwindow.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/administratorwindow.h	Tue Sep 09 15:22:19 2014 +0200
@@ -48,7 +48,7 @@
      * saved as current.
      *
      * @param currentCerts  Path to the current certificate list file.
-     * @param certFingerprint The fingerprint of the signing key used.
+     * @param keyFingerprint The fingerprint of the signing key used.
      */
     void logChanges(const QString &currentCerts, const QString &keyFingerprint);
 
--- a/ui/certificateitemwidget.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/certificateitemwidget.h	Tue Sep 09 15:22:19 2014 +0200
@@ -8,7 +8,7 @@
 #ifndef CERTIFICATELISTITEM_H
 #define CERTIFICATELISTITEM_H
 /**
- * @file certificateitemdelegate.h
+ * @file certificateitemwidget.h
  * @brief Item delegate drawing custom certificate items in list views.
  *
  */
--- a/ui/certificatetabledelegate.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/certificatetabledelegate.h	Tue Sep 09 15:22:19 2014 +0200
@@ -45,11 +45,9 @@
     /**
      * @brief Draw the item using the given parameters.
      *
-     * @param painter   The painter to draw the item.
+     * @param parent    The parent widget.
      * @param option    The style options.
      * @param index     The model index of the item to draw.
-     * @param icon      The icon to display.
-     * @param font      The font used to draw text.
      */
     QWidget *drawComboBox(QWidget *parent, const QStyleOptionViewItem &option,
         const QModelIndex &index) const;
--- a/ui/createcertlistdialog.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/createcertlistdialog.h	Tue Sep 09 15:22:19 2014 +0200
@@ -66,7 +66,7 @@
      * If the file is not a valid key or an error
      * occurs mPk will be NULL after a call to this function.
      *
-     * @param [in] the file to load
+     * @param [in] fileName the file to load
      */
     void loadKeyFile(const QString& fileName);
 
--- a/ui/createinstallerdialog.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/createinstallerdialog.h	Tue Sep 09 15:22:19 2014 +0200
@@ -98,8 +98,8 @@
 public slots:
     /**@brief Append a base64 encoded sha256 RSA signature to a file.
      *
-     * The format of the added signature line will be:
-     * S:<signature>\r\n
+     * The format of the added signature line will be:<BR>
+     * S:\<signature\>\\r\\n<BR>
      * For the signature the key in mCertFile is used.
      *
      * @param[in] input The absolute path of the file to sign
--- a/ui/downloader.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/downloader.h	Tue Sep 09 15:22:19 2014 +0200
@@ -43,6 +43,7 @@
      * @param[in] newestList datetime after which the list should be downloaded
      * @param[in] resourceSW the path where the software is to be found
      * @param[in] resourceList the path where the list is to be found
+     * @param[in] downloadSW TODO
      */
     Downloader(QObject* parent, const QString& url,
                const QByteArray& certificate = QByteArray(),
@@ -118,7 +119,7 @@
      * @brief An error happened
      *
      * @param[out] message: A message to show. Can be empty.
-     * @param[out] errorCode: ErrorCode of this error.
+     * @param[out] error: ErrorCode of this error.
      */
     void error(const QString &message, SSLConnection::ErrorCode error);
 
--- a/ui/installwrapper.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/installwrapper.h	Tue Sep 09 15:22:19 2014 +0200
@@ -52,8 +52,8 @@
      * as the current application.
      *
      * @param[in] parent the parent object.
-     * @param[in] listFileName the absolute path to the certificatelist.
-     * @param[in] choices a list of R: / I: <cert> lines to execute.
+     * @param[in] path the absolute path to the certificatelist.
+     * @param[in] instructions a list of R: / I: \<cert\> lines to execute.
      */
     InstallWrapper(QObject* parent, const QString& path,
                    const QStringList& instructions);
--- a/ui/processhelp.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/processhelp.h	Tue Sep 09 15:22:19 2014 +0200
@@ -15,8 +15,8 @@
 #include <QString>
 
 /**
- * @file Static helper functions for process handling
- * @brief process handling functions
+ * @file processhelp.h 
+ * @brief Static helper functions for process handling
  */
 
 namespace ProcessHelp
--- a/ui/processwaitdialog.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/processwaitdialog.h	Tue Sep 09 15:22:19 2014 +0200
@@ -10,7 +10,9 @@
 #include <QDialog>
 #include <QStringList>
 
-/** @file Dialog to show that some processes need to be closed
+/** 
+ * @file processwaitdialog.h
+ * @brief Dialog to show that some processes need to be closed
  *
  * This dialog informs about processes that are still running and
  * need to be closed.
--- a/ui/proxysettingsdlg.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/proxysettingsdlg.h	Tue Sep 09 15:22:19 2014 +0200
@@ -13,7 +13,10 @@
 class QLineEdit;
 class QPushButton;
 
-/** @file Small dialog for proxy settings. */
+/** 
+ * @file proxysettingsdlg.h
+ * @brief Small dialog for proxy settings. 
+ */
 
 class ProxySettingsDlg : public QDialog {
 
--- a/ui/sslconnection.cpp	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/sslconnection.cpp	Tue Sep 09 15:22:19 2014 +0200
@@ -6,7 +6,10 @@
  * See LICENSE.txt for details.
  */
 
-/**@file base implemetation of sslconnection. */
+/**
+  * @file sslconnection.cpp
+  * @brief Base implemetation of sslconnection. 
+  */
 
 #include "sslconnection.h"
 
--- a/ui/sslconnection.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/sslconnection.h	Tue Sep 09 15:22:19 2014 +0200
@@ -88,7 +88,7 @@
 
     /** @brief Set acceptable ciphersuites.
      *
-     * @param [in] cipers a zero terminated list of ciphers as defined in 
+     * @param [in] ciphers a zero terminated list of ciphers as defined in 
      * polarssl/ssl_ciphersuites.h
      */
     virtual void setCiphersuites(int ciphers[]) = 0;
--- a/ui/taskscheduler.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/taskscheduler.h	Tue Sep 09 15:22:19 2014 +0200
@@ -9,8 +9,10 @@
 #define TASKSCHEDULER_H
 
 /**
- * @file Interface to the Task Scheduler API
- * @brief Provides a Qt / C++ API to work with the windows task scheduler
+ * @file taskscheduler.h
+ * @brief Interface to the Task Scheduler API
+ * 
+ * Provides a Qt / C++ API to work with the windows task scheduler.
  */
 
 #include <QString>
--- a/ui/textoverlaybutton.h	Fri Sep 05 16:16:57 2014 +0200
+++ b/ui/textoverlaybutton.h	Tue Sep 09 15:22:19 2014 +0200
@@ -8,7 +8,10 @@
  * See LICENSE.txt for details.
  */
 
-/** @file A tool button that overlays a text over the icon */
+/** 
+  * @file textoverlaybutton.h
+  * @brief A tool button that overlays a text over the icon.
+  */
 
 #include <QToolButton>
 #include <QString>

http://wald.intevation.org/projects/trustbridge/