doc: doxy: Adjust introspected-command-line.h header to give a Doxygen warning note like introspected-doxygen.h

Author: Peter D. Barnes, Jr.

build-support/macros-and-definitions.cmake

@@ -967,11 +967,15 @@ macro(process_options)
 
       file(
         WRITE ${CMAKE_BINARY_DIR}/introspected-command-line-preamble.h
-        "/* This file is automatically generated by
-  CommandLine::PrintDoxygenUsage() from the CommandLine configuration
-  in various example programs.  Do not edit this file!  Edit the
-  CommandLine configuration in those files instead.
-  */\n"
+        "/**
+ * @file
+ * @ingroup utils
+ * Doxygen docs generated from the ns3::CommandLine options for each example.
+ * @note This file is automatically generated by
+ * ns3::CommandLine::PrintDoxygenUsage() from the ns3::CommandLine configuration
+ * in various example programs.  Do not edit this file!  Edit the
+ * ns3::CommandLine configuration in those files instead.
+ */\n"
       )
       add_custom_target(
         assemble-introspected-command-line

src/core/model/command-line.cc

@@ -473,7 +473,7 @@ CommandLine::PrintDoxygenUsage() const
 
     std::fstream os(outf, std::fstream::out);
 
-    os << "/**\n \\file " << m_shortName << ".cc\n"
+    os << "/**\n @file " << m_shortName << ".cc\n"
        << "<h3>Usage</h3>\n"
        << "<code>$ ./ns3 run \"" << m_shortName << (!m_options.empty() ? " [Program Options]" : "")
        << (!nonOptions.empty() ? " [Program Arguments]" : "") << "\"</code>\n";
@@ -501,12 +501,12 @@ CommandLine::PrintDoxygenUsage() const
 
     if (!m_options.empty())
     {
-        listOptions("Program Options", m_options, "\\c --");
+        listOptions("Program Options", m_options, "@c --");
     }
 
     if (!nonOptions.empty())
     {
-        listOptions("Program Arguments", nonOptions, "\\c ");
+        listOptions("Program Arguments", nonOptions, "@c ");
     }
 
     os << "*/" << std::endl;

utils/print-introspected-doxygen.cc

@@ -1715,7 +1715,7 @@ main(int argc, char* argv[])
     std::cout << std::endl;
     std::cout << commentStart << file << "\n"
               << sectionStart << "utils\n"
-              << "Doxygen docs generated from the TypeId database.\n"
+              << "Doxygen docs generated from the ns3::TypeId database.\n"
               << note << "This file is automatically generated by " << codeWord
               << "print-introspected-doxygen.cc. Do not edit this file! "
               << "Edit that file instead.\n"