Skip to content

Implement a "Class/Record view" for chpldoc #5953

Open
@lydia-duncan

Description

@lydia-duncan

Today, our chpldoc html documentation takes a module-oriented approach. This means that if a class or record has methods defined outside of its initial declaration, they may be spread far from the original type in the documentation. It would be nice to have a view that could be used to conglomerate all the information about a class or record into a single screen.

This view would be expected to cover fields, primary methods, secondary methods, secondary methods in other modules, information about its direct parent (if any), and anything inherited from a parent type. It would not alter the presence of private information (when that is supported on fields/methods).

It is expected that this view would look similar to a functional ordering (#5911), but that this would fall naturally out of the definition order - i.e. all primary methods will precede all secondary methods since they must be defined within the declaration of the class, etc. (I believe that it isn't possible to intersperse fields and methods, but I haven't tried it)

This view would be reachable by clicking on a link embedded in the class/record name, either from the module view or from a type which inherits from it. It would not replace module view as the default mode.

Note: This feature is significantly less useful without a good documentation story for inheritance (#5954).

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Implement a "Class/Record view" for chpldoc · Issue #5953 · chapel-lang/chapel