True when Comment is a structured comment and Parsed is its
parsed representation. Parsed is a list of the following terms:
- section(Id, Title, Comment)
- Generated from /** <module> Title Comment */ comments.
- predicate(PI, Summary, Comment)
- Comment for predicate PI
- link(FromPI, ToPI)
- Indicate that FromPI shares its comment with ToPI. The actual
comment is in ToPI.
- mode(Head, Determinism)
- Mode declaration. Head is a term with Mode(Type) terms and
Determinism describes the associated determinism (
det,
etc.).
- object(Object, Summary, Comment)
- Comment for some other Object, produced by the hook
prolog:doc_compile_comment/6.
- signature(Object, Signature)
- Signature of Object as a string, produced by the hook
prolog:doc_compile_comment/6.
Term is the term that follows Comment and VarNames is a list
Name=Var for its variables. Both are passed to
prolog:doc_compile_comment/6.
