Filtering private API

General Usage
, ,
1

A bit of a naive question regarding documenter indexing :

I have a package with a public API, and some internal developer functions that are mostly of no interest to users, with a few potential exceptions for power users.

I’d like to create a page detailing some of the internals for those exceptions. But there doesn’t seem to be a straightforward way of tagging functions with some tag that could then be used with @index in some way or another as far as I can see ?

The way I’ve thought of going about this is to create a dummy module, export the relevant functions and use that module as a filter.

Is this the standard way of doing this or am I missing some more straightforward way of accomplishing the same goal ?

2 Likes
2

I also have an even more awkward use case :

There is a method exported with two different ‘main’ user entry points which are documented, but it has other overloads, one of which might be occasionally useful to power users.

I’d like to document that function without interfering with the public API, and without hard-writing it into the documentation, and I don’t think the module approach works there, so I’m throwing that bonus question in the mix.