DOC: xref_comment/[3,4] not in docs

Is there a reason why xref_comment/[3,4] is not in the docs? There seem to be other predicates of the prolog_xref module not in the docs.

My answer, which may not be correct, is that it is a helper predicate for the Cross-referencer tool. The predicate xref_comment/[3,4] was not created to be used standalone and thus not documented.

If xref_comment/[3,4] is a helper, then why is it exported?

1 Like

Good question. Don’t have a good solid answer. :slightly_smiling_face:

There must have been some kind of bug that was fixed in the current git version.

xref_comment/[3,4] docs appear in the git version using doc_browser; but if you run doc_browser with 8.1.10 the docs for prolog_xref don’t appear in the index, but they are found if you do a search:

If you do a search:

1 Like

Most libraries are documented in the manual. Others, notably old, deprecated or mostly internal-use libraries are not. Their PlDoc comments should show up in the online PlDoc browser and notably on the website as this makes sure the PlDoc comments of all provided libraries is included.

For short, use the website to find these predicates.

The main point is that they don’t show up on the website:

looks like a bug. Type-ahead works :slight_smile:

They also don’t show up on the main page for the prolog_xref library (if you click on library(prolog_xref): Cross-reference data collection library.

That probably explains what is wrong. The library is documented using the old LaTeX documentation, but this hasn’t been updated for a long time. This should be replaced by the PlDoc documentation.