From: hama Date: Sat, 7 Nov 2015 23:53:18 +0000 (+0100) Subject: Doxigen warnings X-Git-Url: https://gitweb.hamatoma.de/?a=commitdiff_plain;h=b84ba2adf4717db326101a9839b0d3878703bc95;p=reqt Doxigen warnings --- diff --git a/Doxyfile b/Doxyfile index 48c3421..f22a2eb 100644 --- a/Doxyfile +++ b/Doxyfile @@ -32,19 +32,19 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = RePublib +PROJECT_NAME = "Real Public Library - Qt Library" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = 2015.11 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = "Qt Source Code: Base Classes and Applications" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = doc +OUTPUT_DIRECTORY = /home/doxygen/reqt # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -419,7 +419,7 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -756,7 +756,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = warnings.log #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -768,7 +768,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = . +INPUT = /home/ws/qt/reqt # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -844,7 +844,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = build # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -860,7 +860,8 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = moc_*.cpp \ + *.js # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -958,7 +959,7 @@ USE_MDFILE_AS_MAINPAGE = # also VERBATIM_HEADERS is set to NO. # The default value is: NO. -SOURCE_BROWSER = NO +SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. diff --git a/appl/refind/filefinder.cpp b/appl/refind/filefinder.cpp index d6b4533..5f66614 100644 --- a/appl/refind/filefinder.cpp +++ b/appl/refind/filefinder.cpp @@ -258,7 +258,7 @@ void FileFinder::setFiletypes(const QDir::Filters& filetypes){ /** * Sets the maximum subdirectory depth. * - * @param minDepth 0: search only in the base directory
+ * @param maxDepth 0: search only in the base directory
* otherwise: the maximum depth */ void FileFinder::setMaxDepth(int maxDepth){ diff --git a/appl/refind/mainwindow.cpp b/appl/refind/mainwindow.cpp index 92aab29..2308aea 100644 --- a/appl/refind/mainwindow.cpp +++ b/appl/refind/mainwindow.cpp @@ -35,6 +35,8 @@ const QString VERSION("2015.06.01"); /** * @brief Constructor. * + * @param startDir the current directory at program start + * @param homeDir the base directory for the configuration files * @param parent NULL or the parent widget */ MainWindow::MainWindow(const QString& startDir, const QString& homeDir, diff --git a/appl/refind/textfinder.cpp b/appl/refind/textfinder.cpp index 2352860..346a597 100644 --- a/appl/refind/textfinder.cpp +++ b/appl/refind/textfinder.cpp @@ -56,10 +56,7 @@ TextFinder::~TextFinder(){ /** * Search a text pattern in the given file. * - * @param pattern a text pattern to search - * @param ignoreCase true: the search must be case insensitive - * @param isRegular true: the pattern is a regular expression - * @return true: the patter was found + * @return true: the pattern was found */ bool TextFinder::contains(){ bool rc = false; diff --git a/appl/reide/project.cpp b/appl/reide/project.cpp index ab07bd5..7e0c03d 100644 --- a/appl/reide/project.cpp +++ b/appl/reide/project.cpp @@ -15,8 +15,8 @@ const char* Project::KEY_HISTORY_OPEN_FILES = "openFiles"; /** * Constructor. * - * @param path the directory containing the configuration - * @param logger the logger + * @param path the directory containing the configuration + * @param mainWindow the instance of the main window */ Project::Project(const QString& path, MainWindow* mainWindow) : ReSettings(path, ".reditor.proj", mainWindow->logger()), diff --git a/appl/reimgconvert/converter.cpp b/appl/reimgconvert/converter.cpp index 7716039..c30c7e0 100644 --- a/appl/reimgconvert/converter.cpp +++ b/appl/reimgconvert/converter.cpp @@ -174,16 +174,6 @@ void Converter::changeState(Converter::State state, const QString& info){ m_mainWindows->on_threadStateChanged(state, info); } -/** - * Reads the image properties from an image file. - * - * @param name filename with path - * @param width OUT: the width of the image - * @param height OUT: the height of the image - * @param info OUT: information of the image - * @return true: success
- * false: cannot retrieve the image data - */ /** * Converts an image into another format. * @@ -349,7 +339,7 @@ bool Converter::readProperties(const QString& name, int& width, int& height, *