Menu

#22 Do not output Empty Sections in Doc

closed
TridenT
5
2012-07-18
2004-08-20
Kingetje
No

Considering the follwing code ( only interface section
copied ) :

unit UUSGClasses;

interface

uses
{ Delphi Units }
Controls,
{ USG Components Units }
UUSGInterfaces;

Type
/// General interfaces used for Restorer Classes
IUSGRestorer = interface
['{90693D8E-A2F4-47CC-B492-CF41FB4494FD}']
end;

/// Class used for Storing / Restoring the Screen Cursor
TUSGCursorRestorer = class( TInterfacedObject,
IUSGRestorer )
private
FCursor : TCursor;
public
constructor Create; overload;
constructor Create( aNewCursor : TCursor );
overload;
destructor Destroy; override;
end;

implementation

...

The output will still generate an empty section for

  • Types
  • Constants
  • Variables
  • Functions

Wouldn't it be possible NOT to include these sections in
the output if they are empty ? I mean, if there are no
constants in a specific unit, there should be no
Constants section in the generated output.

Maybe add this as an option so the user can toggle it on
or off.

Discussion

  • TridenT

    TridenT - 2004-08-20

    Logged In: YES
    user_id=248829

    Yes, options will be add to select if the user want to create
    empty sections.

    • Types
    • Constants
    • Variables
    • Functions
    • Classes
    • Properties
    • Fields
    • Events
    • Parameters? Maybe simply hide this section if no
      parameters !
     
  • TridenT

    TridenT - 2004-09-12

    Logged In: YES
    user_id=248829

    Added in v0.8beta.2
    A new option was created 'HideEmptyOutputBlock'.
    If a block (constants, typoes, etc ...) is empty, and the
    option is ON, then ne section will not be display.

     

Anonymous
Anonymous

Add attachments
Cancel