pldoc_process:doc_file_name/3

SWI-Prolog Did You Know Did you know? You can configure your environment

Search Documentation:

Predicate doc_file_name/3

HOME
DOWNLOAD
DOCUMENTATION
- Manual
- Packages
- FAQ
- Command line
- PlDoc
- Bluffers▶
- License
- Publications
- Rev 7 Extensions
TUTORIALS
- Beginner▶
- Advanced▶
- Web applications▶
- Semantic web▶
  - ClioPatria
  - RDF namespaces
- Graphics▶
  - XPCE
  - GUI options
- Machine learning▶
  - Probabilistic Logic Programming
- External collections▶
  - Meta level tutorials
- For packagers▶
  - Linux packages
COMMUNITY
COMMERCIAL
WIKI
- Login
- View changes
- Sandbox
- Wiki help
- All tags

doc_file_name(+Source:atom, -Doc:atom, +Options:list) is det

Doc is the name of the file for documenting Source.

Arguments:

`Source`	- Prolog source to be documented
`Doc`	- the name of the file documenting `Source`.
`Options`	- Option list: format`(+Format)` Output format. One of `html` or `tex`

Errors

- permission_error(overwrite, Source)