Module docs_view 

Documentation as one reader can use it: the callables whose capabilities the reader may hold, the types those callables still reach, and the Markdown regions whose conditions hold.

The engine does not know the policy. An embedder answers through DocAvailability, and Unscoped answers for an author reading everything. A projection is a copy for documentation: the declaration a program compiles against is never changed.

Structs

Projection

A declaration narrowed to what a reader can use.

Unscoped

Everything available: documentation as its author reads it.

Enums

Availability

Whether a reader could use a capability.

Traits

DocAvailability

The reader’s side of documentation: which capabilities it could use.

Functions

known_context

The context fields a tag’s literal bindings fix, in the form the runtime checks them. A literal the runtime would refuse, a relative path, which the runtime resolves against the session’s working directory, or a number that does not parse, is left out, which leaves the field unknown.

project_declaration

Narrow defs to what availability allows. A callable stays when every capability its tags name is available, since a call checks each of them. A type stays when a remaining callable reaches it, or when no callable ever did, as with a type a package exports on its own.

scoped_documentation

markdown with the regions whose conditions fail removed, or the directives that make it malformed.