PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Overview
  • Which comments are taken into account?
  • When is the component documentation generated?
  • How to access the component documentation?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
An external component must necessarily be supplied with a documentation.
WINDEV, WEBDEV and WINDEV Mobile simplify the creation of this documentation by proposing:
  • A general overview of component. This general overview is typed when generating the component.
    When the component is used in a WINDEV application, this overview will be visible when hovering the component found in the "Wizards, Examples and Components" pane. See Managing the components from the "Wizards, Examples and Components" pane for more details.
  • An automatic generation of technical documentation from the comments inserted into the code of component elements.
Which comments are taken into account?
The following comments are automatically taken into account for the component documentation:
  • The comments found at the beginning of WLanguage procedures.
  • The comments found at the beginning of the following events:
    • Initialization code of windows or pages,
    • Initialization code of reports,
    • Initialization code of classes,
    • Initialization code of sets of procedures.
When is the component documentation generated?
The documentation of the component is generated during the first component generation ("Workshop .. External Component .. Generate a component").The component documentation is generated during the first component generation: click the generation icon among the quick access buttons.
When generating the documentation:
  • the comments found in the code are used to create the documentation.
  • if no comment is found in your code, the accessible elements of the component will be automatically documented by specifying the input/output parameters expected by each element. The corresponding comments are automatically created in the different elements.
Note: You have the ability to regenerate the documentation associated with the component whenever the component is regenerated ("Regenerate" button).

Caution: The modifications performed in the generation wizard will be deleted if you click the "Regenerate" button.
How to access the component documentation?
The general component overview is automatically displayed when the component found in the "Wizards, Examples and Components" pane is hovered by the mouse cursor.The general component overview is automatically displayed in the description window of component.
The technical documentation of component is available:
  • when a component is included in a project ("Workshop .. External component .. Import a component into the project").when a component is included in a project: on the "Project" pane, in the "Project" group, expand "Import" and select "An external component".
    • in the description of components included in the project ("Workshop .. External component .. List of components imported into the project"). The [Description] button is used to get information and documentation about the component.
    in the description of components included in the project.
    In the project explorer:
    • Select the "External components" folder.
    • Display the popup menu (right mouse click).
    • Select "List of components included in the project".
      The [Description] button is used to get information and documentation about the component.
The documentation specific to an element of component (window, ...) is available:
  • by double-clicking on this element (from the "Project explorer" pane or the project graph) or by pressing the F2 key from the code of this element.either by double-clicking on this element from the Project Explorer pane or by pressing the F2 key from the code of this element.
  • in the list of components included in the project ("Workshop .. External component .. List of components imported into the project").from the project explorer:
    • select the "External components" folder.
    • Display the popup menu (right mouse click).
    • Select "List of components included in the project".
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment