doc_for_dir(+Dir, +Options) is det- Write summary index for all files in Dir to Out. The result
consists of the
README file (if any), a table holding with
links to objects and summary sentences and finaly the TODO
file (if any).
- dir_index(+Dir, +Options)//
- Create an index for all Prolog files appearing in Dir or in
any directory contained in Dir. Options:
- members(+Members)
- Documented members. See
doc_files.pl
- title(+Title)
- Title to use for the index page
- dir_source_files(+Dir, -Files, +Options) is det[private]
- Create a list of source-files to be documented as part of Dir.
- subdir_links(+Dir, +Options)// is det[private]
- Create links to subdirectories
- dir_header(+Dir, +Options)// is det[private]
- Create header for directory. Options:
- readme(File)
- Include File as introduction to the directory header.
- dir_footer(+Dir, +Options)// is det[private]
- Create footer for directory. The footer contains the
TODO file
if provided. Options:
- todo(File)
- Include File as
TODO file in the footer.
- wiki_file(+Dir, +Type, +Options)// is semidet[private]
- Include text from a Wiki text-file.
- wiki_file_type(+Category, -File) is nondet[private]
- Declare file pattern names that are included for
README and TODO
for a directory. Files are matched case-insensitively.
- file_indices(+Files, +Options)// is det[private]
- Provide a file-by-file index of the contents of each member of
Files.
- file_index(+File, +Options)// is det[private]
- Create an index for File.
- file_index_header(+File, +Options)// is det
- Create an entry in a summary-table for File.
- doc_file_href(+File, -HREF, +Options) is det[private]
- HREF is reference to documentation of File.
- doc_file_href(+Path, -HREF) is det
- Create a /doc HREF from Path. There are some nasty things we
should take care of.
- Windows paths may start with
L: (mapped to /L:)
- Paths may contain spaces and other weird stuff
- ensure_slash_start(+File0, -File) is det[private]
- Ensure File starts with a /. This maps C:/foobar into
/C:/foobar, so our paths start with /doc/ again ...
- object_summaries(+Objects, +Section, +Options)// is det
- Create entries in a summary table for Objects.
- object_summary(+Object, +Section, +Options)// is det[private]
- Create a summary for Object. Summary consists of a link to
the Object and a summary text as a table-row.
- To be done
- - Hacky interface. Do we demand Summary to be in Wiki?
- doc_links(+Directory, +Options)// is det
- Provide overview links and search facilities.
- version// is det[private]
- Prolog version
- places_menu(Current)// is det
- Create a
select menu with entries for all loaded directories
- source_directory(+Dir) is semidet
- source_directory(-Dir) is nondet
- True if Dir is a directory from which we have loaded Prolog
sources.
