parameters: (self)
docstring: Generates the unabridged (full) API listing into ``self.unabridged_api_file``.
          This is necessary as some items may not show up in either hierarchy view,
          depending on:
  
          1. The item.  For example, if a namespace has only one member which is a
             variable, then neither the namespace nor the variable will be declared in the
             class view hierarchy.  It will be present in the file page it was declared in
             but not on the main library page.
  
          2. The configurations of Doxygen.  For example, see the warning in
             :func:`exhale.ExhaleRoot.fileRefDiscovery`.  Items whose parents cannot be
             rediscovered withouth the programlisting will still be documented, their link
             appearing in the unabridged API listing.
  
          Currently, the API is generated in the following (somewhat arbitrary) order:
  
          - Namespaces
          - Classes and Structs
          - Enums
          - Unions
          - Functions
          - Variables
          - Defines
          - Typedefs
          - Directories
          - Files
  
          If you want to change the ordering, just change the order of the calls to
          :func:`exhale.ExhaleRoot.enumerateAll` in this method.
docstring_summary: Generates the unabridged (full) API listing into ``self.unabridged_api_file``.
          This is necessary as some items may not show up in either hierarchy view,
          depending on:
docstring_tokens: Generates the unabridged ( full ) API listing into self . unabridged_api_file . This is necessary as some items may not show up in either hierarchy view depending on :
function: def generateUnabridgedAPI(self):
          '''
          Generates the unabridged (full) API listing into ``self.unabridged_api_file``.
          This is necessary as some items may not show up in either hierarchy view,
          depending on:
  
          1. The item.  For example, if a namespace has only one member which is a
             variable, then neither the namespace nor the variable will be declared in the
             class view hierarchy.  It will be present in the file page it was declared in
             but not on the main library page.
  
          2. The configurations of Doxygen.  For example, see the warning in
             :func:`exhale.ExhaleRoot.fileRefDiscovery`.  Items whose parents cannot be
             rediscovered withouth the programlisting will still be documented, their link
             appearing in the unabridged API listing.
  
          Currently, the API is generated in the following (somewhat arbitrary) order:
  
          - Namespaces
          - Classes and Structs
          - Enums
          - Unions
          - Functions
          - Variables
          - Defines
          - Typedefs
          - Directories
          - Files
  
          If you want to change the ordering, just change the order of the calls to
          :func:`exhale.ExhaleRoot.enumerateAll` in this method.
          '''
          try:
              with open(self.unabridged_api_file, "w") as full_api_file:
                  # write the header
                  full_api_file.write("Full API\n{}\n\n".format(EXHALE_SECTION_HEADING))
  
                  # recover all namespaces that were reparented
                  all_namespaces = []
                  for n in self.namespaces:
                      n.findNestedNamespaces(all_namespaces)
  
                  # recover all directories that were reparented
                  all_directories = []
                  for d in self.dirs:
                      d.findNestedDirectories(all_directories)
  
                  # recover classes and structs that were reparented
                  all_class_like = []
                  for cl in self.class_like:
                      cl.findNestedClassLike(all_class_like)
  
                  # write everything to file: reorder these lines for different outcomes
                  self.enumerateAll("Namespaces", all_namespaces, full_api_file)
                  self.enumerateAll("Classes and Structs", all_class_like, full_api_file)
                  self.enumerateAll("Enums", self.enums, full_api_file)
                  self.enumerateAll("Unions", self.unions, full_api_file)
                  self.enumerateAll("Functions", self.functions, full_api_file)
                  self.enumerateAll("Variables", self.variables, full_api_file)
                  self.enumerateAll("Defines", self.defines, full_api_file)
                  self.enumerateAll("Typedefs", self.typedefs, full_api_file)
                  self.enumerateAll("Directories", all_directories, full_api_file)
                  self.enumerateAll("Files", self.files, full_api_file)
          except Exception as e:
              exclaimError("Error writing the unabridged API: {}".format(e))
function_tokens: def generateUnabridgedAPI ( self ) : try : with open ( self . unabridged_api_file , "w" ) as full_api_file : # write the header full_api_file . write ( "Full API\n{}\n\n" . format ( EXHALE_SECTION_HEADING ) ) # recover all namespaces that were reparented all_namespaces = [ ] for n in self . namespaces : n . findNestedNamespaces ( all_namespaces ) # recover all directories that were reparented all_directories = [ ] for d in self . dirs : d . findNestedDirectories ( all_directories ) # recover classes and structs that were reparented all_class_like = [ ] for cl in self . class_like : cl . findNestedClassLike ( all_class_like ) # write everything to file: reorder these lines for different outcomes self . enumerateAll ( "Namespaces" , all_namespaces , full_api_file ) self . enumerateAll ( "Classes and Structs" , all_class_like , full_api_file ) self . enumerateAll ( "Enums" , self . enums , full_api_file ) self . enumerateAll ( "Unions" , self . unions , full_api_file ) self . enumerateAll ( "Functions" , self . functions , full_api_file ) self . enumerateAll ( "Variables" , self . variables , full_api_file ) self . enumerateAll ( "Defines" , self . defines , full_api_file ) self . enumerateAll ( "Typedefs" , self . typedefs , full_api_file ) self . enumerateAll ( "Directories" , all_directories , full_api_file ) self . enumerateAll ( "Files" , self . files , full_api_file ) except Exception as e : exclaimError ( "Error writing the unabridged API: {}" . format ( e ) )