Skip to content

Where exactly do AutoDoc comments for declarations have to appear? #267

@zickgraf

Description

@zickgraf

We sometimes use something like to following for documenting an operation which has already been declared in a more general version (note the line if false then between the AutoDoc comments and the Declare...):

#! @Description
#!  Delegates to <C>ObjectInFpCategory</C>( <A>C</A>,  <A>V</A> ).
#! @Arguments V, A
#! @Returns an object in a &CAP; category
if false then
DeclareOperation( "\/", [ IsQuiverVertex, IsFpCategory ] );
fi;

This seems to work fine in general but I have now encountered issues with this when using @Group.

Thus the question: Should this be supported, or do AutoDoc comments have to appear right before the Declare...? If this should be supported, I will create a bug report for my issues, else I will update the AutoDoc documentation to explicitly say that comments have to appear right before the Declare....

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions