File /obj/handlers/autodoc/autodoc_file.c

See also:
/obj/handlers/autodoc/autodoc_handler.c

Written by Pinkfish

Started Fri Oct 24 16:03:57 EDT 1997

Method index

• load_file()
  Loads up the currently set file name from the archives.
• parse_file(string, function, int)
  Parses the input file figuring out all the documentation bits of it.
• query_changed()
  Did the file change?
• query_class_docs()
  The documentation for the classes.
• query_define_docs()
  The documentation for the defines.
• query_defines()
  The defines which were setup in the class.
• query_file_name()
  The file name being processed.
• query_includes()
  The files included by this one.
• query_inherits()
  Returns the inherits mapping of the system.
• query_main_docs()
  Returns the main docs for the class.
• query_num_failed_tries()
  This method returns the number of times the file was attempted to be read and it was discovered not to exist at all.
• query_private_functions()
  The mapping of private functions.
• query_protected_functions()
  The mapping of protected functions.
• query_public_functions()
  The mapping of public functions.
• save_file()
  Saves the current file name to the archives.

Public Functions

These are functions that everyone can access.

.

load_file

void load_file()


Loads up the currently set file name from the archives.
parse_file

void parse_file(string name,
                function func,
                int only_load)


Parses the input file figuring out all the documentation bits of it.

• Parameters:
  name - the name of the file to parse
  func - the function to call when the parsing is finished
  only_load - a flag telling us to only load the information

query_changed

int query_changed()


Did the file change? Checks to see if the file changed since it was last read.

• Returns:
  1 if it changed, 0 if it has not changed
  query_class_docs

  mapping query_class_docs()
  

  
  The documentation for the classes.
  
  • Returns:
    the mapping of the class names to documentation
    query_define_docs

    mapping query_define_docs()
    

    
    The documentation for the defines. This is mostly used by the include file documentation system.
    
    • Returns:
      the mapping of define names to documentation
      query_defines

      mapping query_defines()
      

      
      The defines which were setup in the class. This is the mapping of the defines which were processed. The format of the mapping is ([ "name" : "value" ]), where the name is the name of the define and the value is what to replace it with.
      
      • Returns:
        the mapping of defines
        query_file_name

        string query_file_name()
        

        
        The file name being processed.
        
        • Returns:
          the name of the file being processed
          query_includes

          string * query_includes()
          

          
          The files included by this one.
          
          • Returns:
            an array of included files
            query_inherits

            mapping query_inherits()
            

            
            Returns the inherits mapping of the system. This returns a mapping of the form ([ inherit_name : ({ flags }) ]). Where the name of the inherit is something like "/std/object" and the flags are things you can apply to an inherit, like "protected" or "private". If there are no flags then the flags will be an empty array.
            
            • Returns:
              a mapping of things inherited by this file
              query_main_docs

              mapping query_main_docs()
              

              
              Returns the main docs for the class. The mapping is of the form ([ "tag" : ({ data }) ]), where each reference to a tag creates a new element in the data array.
              
              • Returns:
                a mapping containing the main docs for the file
                query_num_failed_tries

                int query_num_failed_tries()
                

                
                This method returns the number of times the file was attempted to be read and it was discovered not to exist at all.
                
                • Returns:
                  the number of times it was unable to be read
                  query_private_functions

                  mapping query_private_functions()
                  

                  
                  The mapping of private functions. The mapping is of the form ([ func_name : ({ type, args, docs }) ]). The type bit is an array of the type name, ie: ({ "int" }) or ({ "mixed", "*" }). The args bit looks like ({ "name", type }), where the type is the same as in the previous array. The docs is a mapping of the form ([ "tag" : ({ data }) ]), where each reference to a tag creates a new element in the data array.
                  
                  • Returns:
                    a mapping containing the private functions
                    query_protected_functions

                    mapping query_protected_functions()
                    

                    
                    The mapping of protected functions. The mapping is of the form ([ func_name : ({ type, args, docs }) ]). The type bit is an array of the type name, ie: ({ "int" }) or ({ "mixed", "*" }). The args bit looks like ({ "name", type }), where the type is the same as in the previous array. The docs is a mapping of the form ([ "tag" : ({ data }) ]), where each reference to a tag creates a new element in the data array.
                    
                    • Returns:
                      a mapping containing the protected functions
                      query_public_functions

                      mapping query_public_functions()
                      

                      
                      The mapping of public functions. The mapping is of the form ([ func_name : ({ type, args, docs }) ]). The type bit is an array of the type name, ie: ({ "int" }) or ({ "mixed", "*" }). The args bit looks like ({ "name", type }), where the type is the same as in the previous array. The docs is a mapping of the form ([ "tag" : ({ data }) ]), where each reference to a tag creates a new element in the data array.
                      
                      • Returns:
                        a mapping containing the public functions
                        save_file

                        void save_file()
                        

                        
                        Saves the current file name to the archives.