True if Comment is the comment describing object. Comment is
returned as a string object containing the original from the
source-code. Object is one of
- Name/Arity
Predicate indicator
- Name//Arity
DCG rule indicator. Same as Name/Arity+2
module(ModuleTitle)
Comment appearing in a module.
- Other objects
Created by the hook doc_compile_comment/5, e.g.,
xpce(Class, Kind, Name) for members of xpce classes.
If Object is unbound and multiple objects share the same
description, Object is unified with a list of terms described
above.
- Arguments:
-
| Summary | - First sentence. Normalised spacing. |
| Comment | - Comment string from the source-code (untranslated) |