parameters: (self)
docstring: This method creates the root library api file that will include all of the
          different hierarchy views and full api listing.  If ``self.root_directory`` is
          not a current directory, it is created first.  Afterward, the root API file is
          created and its title is written, as well as the value of
          ``self.root_file_description``.
docstring_summary: This method creates the root library api file that will include all of the
          different hierarchy views and full api listing.  If ``self.root_directory`` is
          not a current directory, it is created first.  Afterward, the root API file is
          created and its title is written, as well as the value of
          ``self.root_file_description``.
docstring_tokens: This method creates the root library api file that will include all of the different hierarchy views and full api listing . If self . root_directory is not a current directory it is created first . Afterward the root API file is created and its title is written as well as the value of self . root_file_description .
function: def generateAPIRootHeader(self):
          '''
          This method creates the root library api file that will include all of the
          different hierarchy views and full api listing.  If ``self.root_directory`` is
          not a current directory, it is created first.  Afterward, the root API file is
          created and its title is written, as well as the value of
          ``self.root_file_description``.
          '''
          try:
              if not os.path.isdir(self.root_directory):
                  os.mkdir(self.root_directory)
          except Exception as e:
              exclaimError("Cannot create the directory: {}\nError message: {}".format(self.root_directory, e))
              raise Exception("Fatal error generating the api root, cannot continue.")
          try:
              with open(self.full_root_file_path, "w") as generated_index:
                  generated_index.write("{}\n{}\n\n{}\n\n".format(
                      self.root_file_title, EXHALE_FILE_HEADING, self.root_file_description)
                  )
          except:
              exclaimError("Unable to create the root api file / header: {}".format(self.full_root_file_path))
              raise Exception("Fatal error generating the api root, cannot continue.")
function_tokens: def generateAPIRootHeader ( self ) : try : if not os . path . isdir ( self . root_directory ) : os . mkdir ( self . root_directory ) except Exception as e : exclaimError ( "Cannot create the directory: {}\nError message: {}" . format ( self . root_directory , e ) ) raise Exception ( "Fatal error generating the api root, cannot continue." ) try : with open ( self . full_root_file_path , "w" ) as generated_index : generated_index . write ( "{}\n{}\n\n{}\n\n" . format ( self . root_file_title , EXHALE_FILE_HEADING , self . root_file_description ) ) except : exclaimError ( "Unable to create the root api file / header: {}" . format ( self . full_root_file_path ) ) raise Exception ( "Fatal error generating the api root, cannot continue." )