"Prefix" key: a NSString with the prefix to be used before the name in order to get the selector name. "Name" key: a NSString with the member name (this is the same name as the key in the parent dictionary). " " key: contains a NSMutableDictionary with member description: The keys for the dictionary are simply method names: This is mainly used for nicer links generation. ![]() "Members" key: contains a NSMutableDictionary with the descriptions of all object members. This document is updated through different steps and always contains the last object data. "CleanedMarkup" key: contains an NSXMLDocument with clean XML. Note that the key is also missing for categories which "parent" class cannot be determined (not likely, but be prepared just in case). This is key is missing for other objects. At the moment this is only used for categories to map to the class that the category extends. "ObjectClass key: an NSString which contains the name of the class to which the object "belongs". "ObjectKind" key: an NSString which has the value "class" if the object is a class, "category" if the object is category and "protocol" if the object is a protocol. "ObjectName" key: an NSString with the object name (this is the same name as used for the key in the root dictionary). " " key: contains a NSMutableDictionary with object data: This is usefull for enumerating over all documented objects: "Objects" key: contains a NSMutableDictionary with object descriptions. The dictionary has the same structure as the main "Hierarchies" dictionary: If the object doesn't have any children, empty dictionary is used. "Children" key: contains a NSMutableDictionary with all children of this object. Note that this is nil if the object is not documented. "ObjectData" key: contains a pointer to the object's data under the main "Objects" key list. It still serves a purpose for the non-documented objects which are part of the hierarchy - for there we can't use the "ObjectData" key since we have no entry. This is the same name as used for the key in the parent dictionary. "ObjectName" key: contains the object name. " " key: contains a NSMutableDictionary describing the object: "Hierarchies" key: contains a NSMutableDictionary with classes hierarchy tree. "Hierarchy" key: contains a NSXMLDocument with clean hierarchy XML. ![]() "Index" key: contains a NSXMLDocument with clean index XML. ![]() The database is a standard NSDictionary of the following layout: In the first steps the objects database is generated which is used in later steps to get and handle the list of documented objects. Optionally, the DocSet bundle is created.Īll temporary files are optionally removed. Optionally, all cleaned xml files are converted to xhtml. All index xml files are created as well.Īll references in the cleaned xml files are checked so that they point to the correct files and members. The generated xml files are parsed and converted to clean versions which are used for creating the rest of the documentation. If Doxyfile doesn't exist or doxygen configuration file is not passed over via the command line parameters, the default file is created using the doxygen itself, then the configuration file options are set so that correct output is used.ĭoxygen is started with the configuration file which results in xml files being created at the desired output path. The conversion happens through several steps: This class handles the doxygen xml output files and converts them to DocSet. DoxygenConverter class reference Inherits from
0 Comments
Leave a Reply. |