Natural Docs Version 0.9 |
NaturalDocs:: ProjectA package that manages information about the files in the source tree, as well as the list of files that have to be parsed and built. Usage and Dependencies
Summary
supportedFiles
A hash of all the supported files in the input directory. The keys are the file names, and the values are NaturalDocs::Project::File objects. unbuiltFilesWithContent
An existence hashref of all the files that have Natural Docs content but are not part of filesToBuild. NaturalDocs. filesAn index of the state of the files as of the last parse. Used to determine if files were added, deleted, or changed. FormatThe first line is NaturalDocs::Settings::FileVersion(). The second line is the last modification time of NaturalDocs_Menu.txt. Each following line is [file name]\t[last modification time]\t[has ND content boolean]\t[default menu title]. LoadAndDetectChanges
Loads the project file from disk and compares it against the files in the input directory. Project is loaded from NaturalDocs.files. New and changed files will be added to FilesToParse(), and if they have content, FilesToBuild(). ReturnsReturns whether the project was changed in any way. Save
Saves the project file to disk. Everything is saved in NaturalDocs.files. NaturalDocs::Menu::Save() should be called prior to this function because its last modification time is saved here. UnbuiltFilesWithContent
Returns an existence hashref of files that have Natural Docs content but are not part of FilesToBuild(). This is not a copy of the data so don’t change it. StatusOf
Returns the status of the passed file. Will be onen of the File Status Constants. GetAllSupportedFiles
Gets all the supported files in the passed directory and its subdirectories and puts them into supportedFiles. The only attribute that will be set is NaturalDocs::Project::File->LastModified(). Parameters
|