Add a way to figure out whether a parameter is documented.

git-svn-id: https://svn.dealii.org/trunk@11104 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h
index 0e7325ef2c5da8fd021fbe71451c29c7037bf910..c97c055d873c026ada5bab42c42d9d40a0c8f63d 100644 (file)
--- a/deal.II/base/include/base/parameter_handler.h
+++ b/deal.II/base/include/base/parameter_handler.h
@@ -1532,6 +1532,12 @@ class ParameterHandler
             std::string            value;
             std::string            documentation;
             Patterns::PatternBase *pattern;
+
+                                             /**
+                                              * Return whether this entry has
+                                              * some form of documentation.
+                                              */
+            bool has_documentation () const;
         };
         
                                          /**

diff --git a/deal.II/base/source/parameter_handler.cc b/deal.II/base/source/parameter_handler.cc
index 30d2a6657f16075943490578c25a1d9f1bda60a1..8c5cdae1492143084c4775149386b6eaeaa90f56 100644 (file)
--- a/deal.II/base/source/parameter_handler.cc
+++ b/deal.II/base/source/parameter_handler.cc
@@ -1002,6 +1002,7 @@ ParameterHandler::print_parameters_section (std::ostream      &out,
        ptrss != pd->subsections.end(); ++ptrss)
     if (ptrss->second->accumulated_no_of_entries() != 0)
       {
+                                         // first print the subsection header
         switch (style) 
           {
             case Text:
@@ -1019,6 +1020,9 @@ ParameterHandler::print_parameters_section (std::ostream      &out,
             default:
                   Assert (false, ExcNotImplemented());
           };
+
+                                         // then the contents of the
+                                         // subsection
         enter_subsection (ptrss->first);
         print_parameters_section (out, style, indent_level+1);
         leave_subsection ();
@@ -1375,6 +1379,15 @@ ParameterHandler::Section::memory_consumption () const
 
 
 
+bool
+ParameterHandler::Section::EntryContent::
+has_documentation () const
+{
+  return documentation != "";
+}
+
+
+
 MultipleParameterLoop::UserClass::~UserClass ()
 {}