Merge branch 'master' of github.com:doxygen/doxygen

Author: doxygen

addon/doxywizard/CMakeLists.txt

@@ -156,7 +156,9 @@ file(GLOB DOXYWIZARD_TRANSLATION_FILES CONFIGURE_DEPENDS "${TRANSLATIONS_DIR}/do
 
 find_package(Qt${QT_VERSION_MAJOR}LinguistTools QUIET)
 if(Qt${QT_VERSION_MAJOR}LinguistTools_FOUND)
-  set_source_files_properties(${DOXYWIZARD_TRANSLATION_FILES} PROPERTIES OUTPUT_LOCATION ${CMAKE_CURRENT_BINARY_DIR})
+  set(I18N_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/i18n)
+  file(MAKE_DIRECTORY ${I18N_BINARY_DIR})
+  set_source_files_properties(${DOXYWIZARD_TRANSLATION_FILES} PROPERTIES OUTPUT_LOCATION ${I18N_BINARY_DIR})
   qt_add_translation(doxywizard_QM_FILES ${DOXYWIZARD_TRANSLATION_FILES})
   get_target_property(QT_QMAKE_EXECUTABLE Qt${QT_VERSION_MAJOR}::qmake IMPORTED_LOCATION)
   execute_process(
@@ -171,18 +173,20 @@ if(Qt${QT_VERSION_MAJOR}LinguistTools_FOUND)
   foreach(ts_file ${DOXYWIZARD_TRANSLATION_FILES})
     get_filename_component(ts_name ${ts_file} NAME_WE)
     string(REGEX REPLACE "doxywizard_(.+)" "\\1" LOCALE "${ts_name}")
-    set(qm_file "${CMAKE_CURRENT_BINARY_DIR}/${ts_name}.qm")
+    set(qm_file "${I18N_BINARY_DIR}/${ts_name}.qm")
     list(APPEND doxywizard_QM_FILES_PATHS ${qm_file})
 
     if (QT_TRANSLATIONS_DIR)
       if (EXISTS "${QT_TRANSLATIONS_DIR}/qtbase_${LOCALE}.qm")
-        string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"qtbase_${LOCALE}.qm\">${QT_TRANSLATIONS_DIR}/qtbase_${LOCALE}.qm</file>\n")
+        configure_file("${QT_TRANSLATIONS_DIR}/qtbase_${LOCALE}.qm" "${I18N_BINARY_DIR}/qtbase_${LOCALE}.qm" COPYONLY)
+        string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"qtbase_${LOCALE}.qm\">i18n/qtbase_${LOCALE}.qm</file>\n")
       else()
         message(WARNING "Qt translation file ${QT_TRANSLATIONS_DIR}/qtbase_${LOCALE}.qm not found")
       endif()
     endif()
-    string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"config_${LOCALE}.xml\">${PROJECT_SOURCE_DIR}/src/i18n/config_${LOCALE}.xml</file>\n")
-    string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"${ts_name}.qm\">${qm_file}</file>\n")
+    configure_file("${PROJECT_SOURCE_DIR}/src/i18n/config_${LOCALE}.xml" "${I18N_BINARY_DIR}/config_${LOCALE}.xml" COPYONLY)
+    string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"config_${LOCALE}.xml\">i18n/config_${LOCALE}.xml</file>\n")
+    string(APPEND TRANSLATIONS_QRC_CONTENT "        <file alias=\"${ts_name}.qm\">i18n/${ts_name}.qm</file>\n")
   endforeach()
   string(APPEND TRANSLATIONS_QRC_CONTENT "    </qresource>\n</RCC>\n")
 

addon/doxywizard/doxywizard.cpp

@@ -463,8 +463,7 @@ void MainWindow::switchLanguage()
     qDebug() << "selected language" << langCode;
     if (langCode!=DoxygenWizard::langCode)
     {
-      m_settings.setValue(QString::fromLatin1("language/code"), langCode);
-      m_settings.sync();
+      setLanguage(langCode);
       quit();
     }
   }
@@ -891,6 +890,18 @@ void MainWindow::outputLogFinish()
   m_saveLog->setEnabled(true);
 }
 
+#define TXT_ARGS  QString::fromLatin1(argc > 2?"Too many arguments specified\n\n":"")
+static void usage(const char *exeName, const QString txt)
+{
+  QMessageBox msgBox;
+  QString fullText = txt;
+  fullText +=  QString::fromLatin1("Usage: %1 [--debug] [--language [lang]] [config file]\n").arg(QString::fromLatin1(exeName));
+  fullText +=  QString::fromLatin1("Usage: %1 --help\n").arg(QString::fromLatin1(exeName));
+  fullText +=  QString::fromLatin1("Usage: %1 --version\n").arg(QString::fromLatin1(exeName));
+  msgBox.setText(fullText);
+  msgBox.exec();
+}
+
 //-----------------------------------------------------------------------
 int main(int argc,char **argv)
 {
@@ -905,21 +916,27 @@ int main(int argc,char **argv)
 #endif
 
   QApplication a(argc,argv);
-  int locArgc = argc;
 
-  if (locArgc == 2)
+  int optInd=1;
+  bool langSet = false;
+  QString langSel;
+  while (optInd<argc && argv[optInd][0]=='-' && argv[optInd][1]=='-')
   {
-    if (!qstrcmp(argv[1],"--help"))
+    if (!qstrcmp(argv[optInd],"--help"))
     {
-      QMessageBox msgBox;
-      msgBox.setText(QString::fromLatin1("Usage: %1 [config file]").arg(QString::fromLatin1(argv[0])));
-      msgBox.exec();
+      usage(argv[0],TXT_ARGS);
+      if (argc > 2) exit(1);
       exit(0);
     }
-    else if (!qstrcmp(argv[1],"--version"))
+    else if (!qstrcmp(argv[optInd],"--version"))
     {
       QMessageBox msgBox;
-      if (!qstrcmp(qVersion(),QT_VERSION_STR))
+      if (argc > 2)
+      {
+        usage(argv[0],TXT_ARGS);
+        exit(1);
+      }
+      else if (!qstrcmp(qVersion(),QT_VERSION_STR))
       {
         msgBox.setText(QString::fromLatin1("Doxywizard version: %1, Qt version: %2").arg(QString::fromLatin1(getFullVersion().c_str())).arg(QString::fromLatin1(QT_VERSION_STR)));
       }
@@ -930,25 +947,48 @@ int main(int argc,char **argv)
       msgBox.exec();
       exit(0);
     }
-  }
-  if (!qstrcmp(argv[1],"--debug") && ((locArgc == 2) || (locArgc == 3)))
-  {
-    DoxygenWizard::debugFlag = true;
-    locArgc--;
+    else if (!qstrcmp(argv[optInd],"--debug"))
+    {
+      DoxygenWizard::debugFlag = true;
+    }
+    else if (!qstrcmp(argv[optInd],"--language"))
+    {
+      langSet = true;
+      if (optInd+1>=argc || (argv[optInd+1][0]=='-' && argv[optInd+1][1]=='-'))
+      {
+        langSel = QString::fromLatin1("en");
+      }
+      else
+      {
+        langSel = QString::fromLatin1(argv[optInd+1]);
+        optInd++;
+      }
+      if (!isLanguageCodeSupported(langSel))
+      {
+        usage(argv[0],QString::fromLatin1("Unknown language selected\n\n"));
+        exit(1);
+      }
+    }
+    optInd++;
   }
 
-  if (locArgc > 2)
+  if (optInd+2<=argc)
   {
-    QMessageBox msgBox;
-    msgBox.setText(QString::fromLatin1("Too many arguments specified\n\nUsage: %1 [config file]").arg(QString::fromLatin1(argv[0])));
-    msgBox.exec();
+    usage(argv[0],TXT_ARGS);
     exit(1);
   }
-  else
+
   {
     qDebug() << "Starting doxywizard...";
 
-    DoxygenWizard::langCode = getStartupLanguageCode();
+    if (langSet)
+    {
+      DoxygenWizard::langCode = langSel;
+    }
+    else
+    {
+      DoxygenWizard::langCode = getStartupLanguageCode();
+    }
     QTranslator qtTranslator;
     if (!DoxygenWizard::langCode.isEmpty() &&
         qtTranslator.load(QString::fromLatin1(":/i18n/qtbase_%1.qm").arg(DoxygenWizard::langCode))
@@ -967,7 +1007,11 @@ int main(int argc,char **argv)
     }
 
     MainWindow &main = MainWindow::instance();
-    if (locArgc==2 && argv[argc-1][0]!='-') // name of config file as an argument
+    if (langSet)
+    {
+      main.setLanguage(langSel);
+    }
+    if (optInd+1==argc && argv[argc-1][0]!='-') // name of config file as an argument
     {
       main.loadConfigFromFile(QString::fromLocal8Bit(argv[argc-1]));
     }

addon/doxywizard/doxywizard.h

@@ -45,6 +45,11 @@ class MainWindow : public QMainWindow
     void outputLogStart();
     void outputLogText(QString text);
     void outputLogFinish();
+    void setLanguage(const QString &langCode)
+    {
+      m_settings.setValue(QString::fromLatin1("language/code"), langCode);
+      m_settings.sync();
+    }
 
   public slots:
     void manual();

doc/customize.dox

@@ -468,6 +468,8 @@ files as one big DOM tree would not fit into memory.
 See <a href="https://github.com/breathe-doc/breathe">the Breathe project</a> for
 an example that uses Doxygen XML output from Python to bridge it with the
 <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> document generator.
+See also <a href="https://0state.com/moxygen">Moxygen</a> for converting
+Doxygen XML output to Markdown for use with static documentation tools.
 
 \htmlonly
 Go to the <a href="custcmd.html">next</a> section or return to the

src/doxygen.cpp

@@ -11140,7 +11140,7 @@ static void readDir(FileInfo *fi,
           FileName *fn=nullptr;
           if (!name.empty())
           {
-            fn = fnMap->add(name,fullName);
+            fn = fnMap->add(name);
             fn->push_back(std::move(fd));
           }
         }
@@ -11228,7 +11228,7 @@ void readFileOrDirectory(const QCString &s,
             auto fd = createFileDef(dirPath+"/",name);
             if (!name.empty())
             {
-              FileName *fn = fnMap->add(name,filePath);
+              FileName *fn = fnMap->add(name);
               fn->push_back(std::move(fd));
             }
           }
@@ -12424,12 +12424,6 @@ void searchInputFiles()
   }
 
   // Sort the FileDef objects by full path to get a predictable ordering over multiple runs
-  std::stable_sort(Doxygen::inputNameLinkedMap->begin(),
-            Doxygen::inputNameLinkedMap->end(),
-            [](const auto &f1,const auto &f2)
-            {
-              return  qstricmp_sort(f1->fullName(),f2->fullName())<0;
-            });
   for (auto &fileName : *Doxygen::inputNameLinkedMap)
   {
     if (fileName->size()>1)
@@ -12440,6 +12434,12 @@ void searchInputFiles()
         });
     }
   }
+  std::stable_sort(Doxygen::inputNameLinkedMap->begin(),
+            Doxygen::inputNameLinkedMap->end(),
+            [](const auto &f1,const auto &f2)
+            {
+              return qstricmp_sort(f1->front()->absFilePath(),f2->front()->absFilePath())<0;
+            });
   if (Doxygen::inputNameLinkedMap->empty())
   {
     warn_uncond("No files to be processed, please check your settings, in particular INPUT, FILE_PATTERNS, and RECURSIVE\n");

src/filename.h

@@ -29,15 +29,11 @@ class FileDef;
 class FileName : public std::vector< std::unique_ptr<FileDef> >
 {
   public:
-    FileName(const QCString &nm,const QCString &fn) : m_name(nm), m_fName(fn), m_pathName("tmp") {}
+    explicit FileName(const QCString &nm) : m_name(nm) {}
     QCString fileName() const { return m_name; }
-    QCString fullName() const { return m_fName; }
-    QCString path() const { return m_pathName; }
 
   private:
     QCString m_name;
-    QCString m_fName;
-    QCString m_pathName;
 };
 
 //! Custom combined key compare and hash functor that uses a lower case string in

src/tagreader.cpp

@@ -1676,7 +1676,7 @@ void TagFileParser::buildLists(const std::shared_ptr<Entry> &root)
       }
       else
       {
-        mn = Doxygen::inputNameLinkedMap->add(tfi->name,fullName);
+        mn = Doxygen::inputNameLinkedMap->add(tfi->name);
         mn->push_back(std::move(fd));
       }
       buildMemberList(fe,tfi->members);