@see Tag

Adds a link into See Also list. A VBdocman comment may contain any number of @see tags

Syntax

@see reference [label]

It adds a link, with visible text label, that points to the documentation for the specified reference. Warning appears during compilation if reference points to non-existing target. The label is optional. If omitted, instead of it the reference appears as the visible text. Use the label when you want the visible text to be abbreviated or different from the reference. It can contain whitespaces.

Reference Format

Reference can point to two different types of location:

  1. File on current file system.
  2. Documentation for some object in current VB project.

Reference to a file starts with double quote ". The file name follows immediately without any space between them. No whitespace is allowed within the file name. The path is relative to generated file. It is recommended to copy all external files (pictures, sounds, texts, ...) which will be used (referenced) in documentation into documentation output directory.

Example:

'**
'@see "title.bmp
'@see "c:\MyPics\example.txt Example of ExecuteQuery Method

This generates 2 links pointing to specified files:

See Also

Reference to Name in VB

It adds a link to the documentation for specified name in VB project. Name reference has several formats and consists of 3 fields:

module module name, can be a class, standard module, form or a control module.

name object name.

prop property type, can have values "set", "let" or "get". If it is not specified and the object is property, VBdocman firstly looks for property Set, if it cannot be found, it looks for Let, and finally if nothing was found, it looks for Get.

The possible combinations are:

1.

module.name'prop

It points to the documentation of an object with name in module. If the object is property, then you can also specify its type by prop.

Example:

@see PlayField.size'get

Points to documentation of size property get in PlayField class.

@see PlayField.size'let Size property

It points to the documentation of size property let in PlayField class. The label is "Size property"

2.

module.name

It points to the documentation of an object with name in module. If the object is property, then property type is assumed to be as described above.

Example:

@see PlayField.size

It points to the documentation of size property set/let/get (what is found as the first) in PlayField class.

@see PlayField.getWinner

It points to the documentation of getWinner method in PlayField class.

3.

module.

It points to the documentation of an object in module with the same name as current object.

Example:

in SmartPlayer module:

'**
'@see RandomPlayer.
Public Property Get playerName() As String
End Property

It points to the documentation of playerName property get in RandomPlayer class.

4.

module

It points to the module documentation.

Example:

'**
'@see RandomPlayer

It points to the documentation of RandomPlayer class.

5.

.name'prop

It points to the documentation of an object with name in current module. If the object is property, then you can also specify its type with prop.

Example:

in PlayField module:

@see .size'get

It points to the documentation of size property get in PlayField class.

6.

.name

It points to the documentation of an object with name in current module. If the object is property, then property type is assumed to be as described above.

Example:

in PlayField module:

@see .size

It points to the documentation of size property set/let/get (what is found as the first) in PlayField class.

@see .getWinner

It points to the documentation of getWinner method in PlayField class.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.