documentation: Doxygen post fixes

doc/doxygen.warnings.report.sh

@@ -393,23 +393,34 @@ echo "Net result of all filters:"
 
 verbose -n "Filtering the doxygen log"
 
-# List of module directories (e.g, "src/core/model")
-undocmods=$(                \
-    filter_log            | \
-    cut -d ':' -f 1       | \
-    sed "s|$ROOT/||g"     | \
-    cut -d '/' -f 1-3     | \
-    sort                  | \
-    uniq -c               | \
-    sort -nr                \
-    )
+filter_log_results=$(filter_log)
 
-# Number of directories
-modcount=$(                         \
-    echo "$undocmods"             | \
-    wc -l                         | \
-    sed 's/^[ \t]*//;s/[ \t]*$//'   \
-    )
+# List of module directories (e.g, "src/core/model")
+if [ ! -z "$filter_log_results" ]
+then
+    undocmods=$(                \
+        filter_log            | \
+        cut -d ':' -f 1       | \
+        sed "s|$ROOT/||g"     | \
+        cut -d '/' -f 1-3     | \
+        sort                  | \
+        uniq -c               | \
+        sort -nr                \
+        )
+    modcount=$(                         \
+        echo "$undocmods"             | \
+        wc -l                         | \
+        sed 's/^[ \t]*//;s/[ \t]*$//'   \
+        )
+    modwarncount=$(                               \
+        echo "$undocmods"                       | \
+        awk '{total += $1}; END {print total}'    \
+        )
+else
+    undocmods=""
+    modcount=0
+    modwarncount=0
+fi
 
 # For a function with multiple undocumented parameters,
 # Doxygen prints the additional parameters on separate lines,
@@ -423,32 +434,38 @@ addlparam=$(                                  \
     )
 
 # Total number of warnings
-warncount=$(                                  \
-    echo "$undocmods"                       | \
-    awk '{total += $1}; END {print total}'    \
-    )
-warncount=$((warncount + addlparam))
+warncount=$((modwarncount + addlparam))
 
 # List of files appearing in the log
-undocfiles=$(               \
-    filter_log            | \
-    cut -d ':' -f 1       | \
-    sed "s|$ROOT||g"      | \
-    cut -d '/' -f 2-      | \
-    sort                  | \
-    uniq -c               | \
-    sort -k 2               \
-    )
+if [ ! -z "$filter_log_results" ]
+then
+    undocfiles=$(               \
+        filter_log            | \
+        cut -d ':' -f 1       | \
+        sed "s|$ROOT||g"      | \
+        cut -d '/' -f 2-      | \
+        sort                  | \
+        uniq -c               | \
+        sort -k 2               \
+        )
+else
+    undocfiles=""
+fi
 
 # Sorted by number, decreasing
 undocsort=$(echo "$undocfiles" | sort -k1nr,2 )
 
 # Total number of files
-filecount=$(                        \
-    echo "$undocfiles"            | \
-    wc -l                         | \
-    sed 's/^[ \t]*//;s/[ \t]*$//'   \
-    )
+if [ ! -z "$undocfiles" ]
+then
+    filecount=$(                        \
+        echo "$undocfiles"            | \
+        wc -l                         | \
+        sed 's/^[ \t]*//;s/[ \t]*$//'   \
+        )
+else
+    filecount=0
+fi
 
 # Filtered in warnings
 filterin=

src/core/model/attribute-container.h

@@ -40,9 +40,9 @@ class AttributeChecker;
 /**
  * A container for one type of attribute.
  * 
- * The container uses \ref A to parse items into elements.
+ * The container uses \p A to parse items into elements.
  * Internally the container is always a list but an instance
- * can return the items in a container specified by \ref C.
+ * can return the items in a container specified by \p C.
  * 
  * @tparam A AttributeValue type to be contained.
  * @tparam C Possibly templated container class returned by Get.
@@ -112,8 +112,8 @@ public:
   /**
    * Copy items from container c.
    * 
-   * This method assumes \ref c has stl-style begin and end methods.
-   * The AttributeContainerValue value is cleared before copying from \ref c.
+   * This method assumes \p c has stl-style begin and end methods.
+   * The AttributeContainerValue value is cleared before copying from \p c.
    * @tparam T type of container.
    * \param c Container from which to copy items.
    */

utils/print-introspected-doxygen.cc

@@ -1582,8 +1582,9 @@ PrintAttributeImplementations (std::ostream & os)
   PrintAttributeValueWithName (os, "Tuple", "std::tuple<Args...>", "tuple.h");
   PrintMakeChecker            (os, "Tuple", "tuple.h");
 
-  PrintAttributeValueSection  (os, "AttributeContainer", false);
-  PrintAttributeValueWithName (os, "AttributeContainer", "AttributeContainer", "attribute-container.h");
+  // AttributeContainer is already documented.
+  // PrintAttributeValueSection  (os, "AttributeContainer", false);
+  // PrintAttributeValueWithName (os, "AttributeContainer", "AttributeContainer", "attribute-container.h");
   PrintMakeChecker            (os, "AttributeContainer",  "attribute-container.h");
 }  // PrintAttributeImplementations ()
 

utils/tests/test-ns3.py

@@ -788,6 +788,7 @@ class NS3ConfigureTestCase(NS3BaseTestCase):
         """!
         Test if CMake target names for scratches and ns3 shortcuts
         are working correctly
+        @return None
         """
 
         test_files = ["scratch/main.cc",
@@ -858,6 +859,7 @@ class NS3ConfigureTestCase(NS3BaseTestCase):
     def test_14_MpiCommandTemplate(self):
         """!
         Test if ns3 is inserting additional arguments by MPICH and OpenMPI to run on the CI
+        @return None
         """
         # Skip test if mpi is not installed
         if shutil.which("mpiexec") is None: