discuss.visual-prolog.com

Posted: **28 Feb 2024 18:46**

Where can we find the current syntax guide for the Help documentation tags?

The ancient ProDoc documentation does not correspond with ViP 11 tagging.

Code: Select all

class predicates
    fileNameWithEllipses : (string PNE, charCount MaxChars) -> string ShortenedPNE determ.
    % @short Shorten a fully-qualified file name, prefixing the right-most part with ellipses.
    % @detailed <== not valid
    % @fail <== not valid
    % @exception
    % @example
    % @withdomain
    % @overview <== not valid
    % @end

Posted: **29 Feb 2024 13:16**

I am afraid that it is not documented anywhere. Furthermore, it is "under reconstruction" here (but I am afraid that that will not reach you for a long time). I would stick to @short and @end and perhaps @detailed and then use #Variable in your descriptions.

Posted: **29 Feb 2024 17:05**

OK.
Here's a tally of the Help tags used in the Vip11 PFC folders

Code: Select all

Tag                Frequency
@short          (17085)
@end            (16997)
@detail         (2505)
@noformat       (1443)
@exception      (624)
@withdomain     (92)
@example        (80)
@fail           (41)
@Short          (14)
@Fail           (11)
@desc           (8)
@control        (7)
@details        (4)
@wothdomain     (1)
@shorts         (1)
@package        (1)
@overview       (1)

Posted: **2 Mar 2024 18:40**

Some of that is clearly wrong. And some doesn't really have a meaning anymore.

@noformat disables auto-formatting of the file, it is emitted by code generating tools. It doesn't have a documentation semantics.

discuss.visual-prolog.com

Help documentation syntax guide

Help documentation syntax guide

Re: Help documentation syntax guide

Re: Help documentation syntax guide

Re: Help documentation syntax guide