From: hama <hama@siduction.net>
Date: Thu, 24 Dec 2015 20:09:49 +0000 (+0100)
Subject: Doxygen improvements
X-Git-Url: https://gitweb.hamatoma.de/?a=commitdiff_plain;h=3da220c07745869d68d18eafb3620f19db6d83e8;p=reqt

Doxygen improvements
---

diff --git a/.gitignore b/.gitignore
index a427b8f..8543d61 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,3 +11,5 @@ rpldoc.zip
 build/
 appl/build-reidos-Desktop-Debug/
 .metadata
+2github
+
diff --git a/Doxyfile b/Doxyfile
index f22a2eb..17b750f 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -2385,7 +2385,7 @@ PLANTUML_INCLUDE_PATH  =
 # Minimum value: 0, maximum value: 10000, default value: 50.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_GRAPH_MAX_NODES    = 50
+DOT_GRAPH_MAX_NODES    = 500
 
 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
 # generated by dot. A depth value of 3 means that only nodes reachable from the
diff --git a/README.md b/README.md
index f879c27..0d9279e 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,2 @@
-doc:
-* rpldoc.zip contains a full source code documentation generated by Doxygen
-usage:
-* copy (or link) the wanted source directories (e.g. rplcore+rplnet) into your project.
-* each of the sublibraries rplcore, rplmath, rplexpr... has a main include file, e.g. rplcore/rplcore.hpp
-* include this main include file into your source
-
-
-
+# reqt
+Libs and applications developed in a QT environment. Successor of rplqt.
diff --git a/appl/reide/views/ProjectPerspective.cpp b/appl/reide/views/ProjectPerspective.cpp
index 1cf21a3..6a707ee 100644
--- a/appl/reide/views/ProjectPerspective.cpp
+++ b/appl/reide/views/ProjectPerspective.cpp
@@ -17,13 +17,14 @@ const char* ProjectPerspective::KEY_HISTORY_OPEN_FILES = "openFiles";
 /**
  * Constructor.
  *
+ * @param path			home path (for the settings)
  * @param mainWindow	the parent (main window)
  */
 ProjectPerspective::ProjectPerspective(const QString& path,
-    MainWindow* mainWindow) :
-	    Perspective(NAME, mainWindow),
-	    ReSettings(path, ".reditor.proj", mainWindow->logger()),
-	    m_editorView(NULL) {
+	MainWindow* mainWindow) :
+		Perspective(NAME, mainWindow),
+		ReSettings(path, ".reditor.proj", mainWindow->logger()),
+		m_editorView(NULL) {
 	setDefaultViews();
 	//QString filename = topOfHistory(KEY_HISTORY_OPEN_FILES);
 	//QFileInfo info(filename);
@@ -40,9 +41,9 @@ ProjectPerspective::ProjectPerspective(const QString& path,
 void ProjectPerspective::changeProject(const QString& path) {
 	setPath(path);
 	int maxEntries = m_mainWindow->workspace()->intValue(
-	    "history.max_projects");
+		"history.max_projects");
 	m_mainWindow->workspace()->addHistoryEntry(Workspace::KEY_HISTORY_PROJECTS,
-	    m_path, ';', maxEntries);
+		m_path, ';', maxEntries);
 	/*<pre>
 	 if (m_fileTree == NULL) {
 	 m_fileTree = new ReFileTree(path, m_logger, this);
@@ -94,7 +95,7 @@ void ProjectPerspective::setDefaultViews() {
 		m_editorView = new EditorView(m_mainWindow);
 		append(m_editorView, Qt::NoDockWidgetArea);
 		append(new FileTreeView(QDir::homePath(), m_mainWindow),
-		    Qt::LeftDockWidgetArea);
+			Qt::LeftDockWidgetArea);
 	}
 }
 
diff --git a/appl/reimgconvert/converter.cpp b/appl/reimgconvert/converter.cpp
index bf6803f..396cab7 100644
--- a/appl/reimgconvert/converter.cpp
+++ b/appl/reimgconvert/converter.cpp
@@ -16,7 +16,7 @@
 #include <QRegularExpression>
 #include <QRegExp>
 
-/** @mainpage A converter for images.
+/** @file
  *
  * @section intro_sec Introduction
  *
@@ -110,6 +110,8 @@ QString sizeToString(qint64 size);
  *
  * @param directory         the source directory. The images will be searched here
  * @param targetDirectory   the target directory
+ * @param sourcePattern		the pattern for the files to process
+ * @param targetType		the target image type
  * @param landscapeX        0 or the given maximal width for landscape format
  * @param landscapeY        0 or the given maximal height for landscape format
  * @param portraitX         0 or the given maximal width for portrait format
diff --git a/base/ReException.cpp b/base/ReException.cpp
index 8a35e5e..64814e5 100644
--- a/base/ReException.cpp
+++ b/base/ReException.cpp
@@ -19,6 +19,7 @@
  * <li>math: mathematic definitions and tools</li>
  * <li>expr: definition for parsing and interpretation of languages</li>
  * <li>net: definitions and tools for tcp/udp communication</li>
+ * <li>appl: some applications</li>
  * </ul>
  *
  * Each module group has a central include file, which organizes the necessary
@@ -58,7 +59,7 @@ class ReException;
  * For derived classes only!
  */
 ReException::ReException() :
-	    m_message("") {
+		m_message("") {
 }
 
 /**
@@ -68,7 +69,7 @@ ReException::ReException() :
  * @param ...       the values for the placeholders in the format.
  */
 ReException::ReException(const char* format, ...) :
-	    m_message("") {
+		m_message("") {
 	char buffer[64000];
 	va_list ap;
 	va_start(ap, format);
@@ -93,8 +94,8 @@ ReException::ReException(const char* format, ...) :
  * @param logger    if NULL the global logger will be used
  */
 ReException::ReException(ReLoggerLevel level, int location, ReLogger* logger,
-    const char* format, ...) :
-	    m_message("") {
+	const char* format, ...) :
+		m_message("") {
 	char buffer[64000];
 	va_list ap;
 	va_start(ap, format);
@@ -136,14 +137,14 @@ ReException::ReException(ReLoggerLevel level, int location, ReLogger* logger,
  */
 
 ReRangeException::ReRangeException(ReLoggerLevel level, int location,
-    size_t current, size_t lbound, size_t ubound, const char* message,
-    ReLogger* logger) :
-	    ReException("") {
+	size_t current, size_t lbound, size_t ubound, const char* message,
+	ReLogger* logger) :
+		ReException("") {
 	char buffer[64000];
 	if (message == NULL)
 		message = "value outside limits";
 	qsnprintf(buffer, sizeof buffer, "%s: %lu [%lu, %lu]",
-	    message == NULL ? "" : message, current, lbound, ubound);
+		message == NULL ? "" : message, current, lbound, ubound);
 	if (logger == NULL)
 		logger = ReLogger::globalLogger();
 	logger->log(level, location, buffer);
@@ -176,9 +177,9 @@ ReRangeException::ReRangeException(ReLoggerLevel level, int location,
  * @param logger    if NULL the global logger will be used
  */
 RplInvalidDataException::RplInvalidDataException(ReLoggerLevel level,
-    int location, const char* message, const void* data, size_t dataSize,
-    ReLogger* logger) :
-	    ReException("") {
+	int location, const char* message, const void* data, size_t dataSize,
+	ReLogger* logger) :
+		ReException("") {
 	char buffer[64000];
 	if (message == NULL)
 		message = "invalid data: ";
@@ -190,7 +191,7 @@ RplInvalidDataException::RplInvalidDataException(ReLoggerLevel level,
 	char* ptr = buffer + strlen(buffer);
 	for (ix = 0; ix < dataSize; ix++) {
 		qsnprintf(ptr, sizeof(buffer) - (ptr - buffer) - 1, "%02x ",
-		    ((unsigned char*) data)[ix]);
+			((unsigned char*) data)[ix]);
 		ptr += strlen(ptr);
 	}
 	for (ix = 0; ix < dataSize; ix++) {
@@ -211,9 +212,9 @@ RplInvalidDataException::RplInvalidDataException(ReLoggerLevel level,
  * @param message   describes what is not implemented
  */
 ReNotImplementedException::ReNotImplementedException(const char* message) :
-	    ReException("not implemented: ", message) {
+		ReException("not implemented: ", message) {
 	ReLogger::globalLogger()->log(LOG_ERROR, LOC_NOT_IMPLEMENTED_1,
-	    getMessage());
+		getMessage());
 }
 
 /**
@@ -222,7 +223,7 @@ ReNotImplementedException::ReNotImplementedException(const char* message) :
  * @param message   the description of the exception
  */
 ReQException::ReQException(const QString message) :
-	    m_message(message) {
+		m_message(message) {
 }
 
 /**
diff --git a/base/ReProgramArgs.cpp b/base/ReProgramArgs.cpp
index 398d5cc..5156851 100644
--- a/base/ReProgramArgs.cpp
+++ b/base/ReProgramArgs.cpp
@@ -17,7 +17,7 @@ QByteArray ReProgramArgs::UNDEFINED_STRING("\01");
 /** @brief Constructor.
  *
  * @param caller	the object which throw the exception.
- * @param message	the error message with placeholders like sprintf()
+ * @param format	the error message with placeholders like sprintf()
  * @param ...
  */
 ReOptionException::ReOptionException(ReProgramArgs* caller, const char* format,
@@ -48,7 +48,7 @@ ReOptionException::ReOptionException(ReProgramArgs* caller, const QString& messa
 
 /** @brief Constructor.
  *
- * @param usage		a string array with the description of the usage.
+ * @param usageList	a string array with the description of the usage.
  * 					Every string will be issued in a separate line
  * @param examples	a string with one ore more calling examples.
  * 					Every string will be issued in a separate line
@@ -82,10 +82,10 @@ ReProgramArgs::ReProgramArgs(const char* usageList[], const char* examples[]) :
 
 /** @brief Constructor.
  *
- * @param usage		a string with the description of the usage
- * 					It may contain <code>'\\n'</code> for separate lines
- * @param examples	a string with one ore more calling examples.
- * 					It may contain <code>'\\n'</code> for separate lines
+ * @param usageString	a string with the description of the usage
+ *						It may contain <code>'\\n'</code> for separate lines
+ * @param examples		a string with one ore more calling examples.
+ *						It may contain <code>'\\n'</code> for separate lines
  */
 ReProgramArgs::ReProgramArgs(const char* usageString, const char* examples) :
 		m_usage(),
@@ -107,10 +107,10 @@ ReProgramArgs::ReProgramArgs(const char* usageString, const char* examples) :
 
 /** @brief Constructor.
  *
- * @param usage		a string with the description of the usage
- * 					It may contain <code>'\\n'</code> for separate lines
- * @param examples	a string with one ore more calling examples.
- * 					It may contain <code>'\\n'</code> for separate lines
+ * @param usageString	a string with the description of the usage
+ *						It may contain <code>'\\n'</code> for separate lines
+ * @param examples		a string with one ore more calling examples.
+ *						It may contain <code>'\\n'</code> for separate lines
  */
 ReProgramArgs::ReProgramArgs(const QString& usageString, QString examples) :
 	m_usage(),
@@ -248,9 +248,9 @@ void ReProgramArgs::addProperties(const char*name, const char* description,
  * @see getBool()
  */
 void ReProgramArgs::addBool(const char* name, const char* description,
-	char shortOpt, const char* longOpt, bool defaultVal) {
+	char shortOpt, const char* longOpt, bool defaultValue) {
 	addProperties(name, description, shortOpt, longOpt, DT_BOOL,
-		defaultVal ? "t" : "f");
+		defaultValue ? "t" : "f");
 }
 
 /** @brief Adds an option with an integer value.
@@ -264,8 +264,8 @@ void ReProgramArgs::addBool(const char* name, const char* description,
  * * @see getInt()
  */
 void ReProgramArgs::addInt(const char* name, const char* description,
-	char shortOpt, const char* longOpt, int defaultVal) {
-	QByteArray number = QByteArray::number(defaultVal);
+	char shortOpt, const char* longOpt, int defaultValue) {
+	QByteArray number = QByteArray::number(defaultValue);
 	addProperties(name, description, shortOpt, longOpt, DT_INT, number.constData());
 }
 
@@ -275,16 +275,17 @@ void ReProgramArgs::addInt(const char* name, const char* description,
  * @param description	A short description of the option. Used in the user messages
  * @param shortOpt		the one character option identifier. Used in the arguments. Must be preceded by '-'
  * @param longOpt		the multi character option identifier.  Used in the arguments. Must be preceded by '--'
+ * @param mayBeEmpty	<code>false</code>: an empty string is an error
  * @param defaultValue	the default value of the option
  *
  * @see getString()
  */
 void ReProgramArgs::addString(const char* name, const char* description,
 	char shortOpt, const char* longOpt, bool mayBeEmpty,
-	const char* defaultVal) {
+	const char* defaultValue) {
 	addProperties(name, description, shortOpt, longOpt,
 		mayBeEmpty ? DT_STRING_EMPTY : DT_STRING,
-				  defaultVal == NULL ? UNDEFINED_STRING.constData() : defaultVal);
+				  defaultValue == NULL ? UNDEFINED_STRING.constData() : defaultValue);
 }
 
 /** @brief Analyses a long name option.
@@ -496,7 +497,8 @@ int ReProgramArgs::getInt(const char* name) {
 
 /** @brief Returns the value of a string option.
  *
- * @param name	the name of the option
+ * @param name		the name of the option
+ * @param buffer	OUT: the buffer for the name
  *
  * @return		NULL: default value is NULL and no argument has been given<br>
  *				the value of the option set in the programs arguments or the default value.
diff --git a/base/ReRandomizer.cpp b/base/ReRandomizer.cpp
index 286bddf..286ca08 100644
--- a/base/ReRandomizer.cpp
+++ b/base/ReRandomizer.cpp
@@ -1149,6 +1149,7 @@ ReRandomizer& ReByteScrambler::contentRandom(bool doReset)
 /**
  * Initializes the scrambler from a header.
  *
+ * @param reservedLength	length of an area in front of the marker (not encrypted)
  * @param markerLength		length of a mark to ensure header's integrity
  * @param infoLength		the length of the "reserved area"
  * @param encryptedFrom		the first index from which data are encrypted.
diff --git a/base/ReStringUtils.cpp b/base/ReStringUtils.cpp
index 3ec4fd9..5502eb5 100644
--- a/base/ReStringUtils.cpp
+++ b/base/ReStringUtils.cpp
@@ -33,7 +33,7 @@ const QByteArray ReStringUtils::m_empty;
  *
  * @param string	string to change
  * @param cc		character to remove. Default: end of line ('\n')<br>
- *					If <code>cc</code> is '\n' then also '\r' will be removed
+ *					If <code>cc</code> is '\n' then also '\\r' will be removed
  *					at the end of the string
  * @return			<code>string</code>: for chaining
  */
diff --git a/gui/ReSettings.cpp b/gui/ReSettings.cpp
index 7913575..a697836 100644
--- a/gui/ReSettings.cpp
+++ b/gui/ReSettings.cpp
@@ -101,6 +101,7 @@ bool ReProperty::isValid(const QString& value, QString* error) {
  *
  * @param path		the parent directory for the storage files
  * @param prefix	type of the storage: "proj" or "ws" (workspace)
+ * @param logger	the logger
  */
 ReSettings::ReSettings(const QString& path, const QString& prefix,
 	ReLogger* logger) :
diff --git a/os/ReCryptFileSystem.cpp b/os/ReCryptFileSystem.cpp
index a2418e9..aa1b354 100644
--- a/os/ReCryptFileSystem.cpp
+++ b/os/ReCryptFileSystem.cpp
@@ -102,9 +102,9 @@ ReCryptFileSystem::~ReCryptFileSystem() {
  * The file must exist in the current directory.
  * The caller must free the instance.
  *
- * @param meta	the metadata of the file
- * @return		NULL: no file found<br>
- *				otherwise: the file
+ * @param metadata	the metadata of the file
+ * @return			NULL: no file found<br>
+ *					otherwise: the file
  */
 ReLeafFile* ReCryptFileSystem::buildFile(const ReFileMetaData& metadata)
 {
@@ -890,7 +890,7 @@ ReFileSystem::ErrorCode ReCryptLeafFile::close()
 /**
  * Reads data from the current position into a buffer.
  *
- * @param maxSize	number of bytes to read
+ * @param size		number of bytes to read
  * @param buffer	OUT: content of the file
  * @return			EC_SUCCESS or error code
  */
diff --git a/os/ReFileSystem.cpp b/os/ReFileSystem.cpp
index 01e2a93..5347503 100644
--- a/os/ReFileSystem.cpp
+++ b/os/ReFileSystem.cpp
@@ -92,8 +92,9 @@ ReFileSystem* ReFileSystem::buildFromUrl(const QString& url)
 /**
  * Copy a file from a source filesystem to the current directory of the instance.
  *
- * @param source	meta data of the source file (in current directory)
- * @param sourceFS	the filesystem containing the source
+ * @param source		meta data of the source file (in current directory)
+ * @param sourceFS		the filesystem containing the source
+ * @param targetNode	the name of the target file (without path)
  * @return			EC_SUCCESS: success<br>
  *
  */
@@ -257,8 +258,9 @@ bool ReFileSystem::first(const QString& pattern, ReFileMetaData& file,
 /**
  * Move a file from a source filesystem to the current directory of the instance.
  *
- * @param source	meta data of the source file (in current directory)
- * @param sourceFS	the filesystem containing the source
+ * @param source		meta data of the source file (in current directory)
+ * @param sourceFS		the filesystem containing the source
+ * @param targetNode	the name of the target file (without path)
  * @return			EC_SUCCESS: success<br>
  *
  */
@@ -910,6 +912,8 @@ ReOSPermissions&ReOSPermissions::operator =(const ReOSPermissions& source)
  * Constructor.
  *
  * @param metaData	the meta data of the file
+ * @param fullName	the name with path of the file
+ * @param logger	the logger
  */
 ReLocalLeafFile::ReLocalLeafFile(const ReFileMetaData& metaData,
 		const QString& fullName, ReLogger* logger) :
@@ -957,7 +961,7 @@ ReFileSystem::ErrorCode ReLocalLeafFile::close(){
 /**
  * Reads data from the current position into a buffer.
  *
- * @param size		number of bytes to read
+ * @param maxSize		number of bytes to read
  * @param buffer	OUT: content of the file
  * @return			EC_SUCCESS: success<br>
  *					EC_INVALID_STATE: file not open