Documentation of all tags supported by DocMaker v5.00.
| Tag | Description | ||
|---|---|---|---|
|
Will print the text in "" following the tag in bold letters. Example
|
||
|
Mark the start and the end of a code example section. Text between these tags will be displayed in fixed-font size, even linebreaks are not needed.
Example
@Code Debug "Test" @EndCode Parameter description
No parameters. |
||
|
|||
|
|||
|
This generates a box with a warning text in it: “This function is deprecated etc., etc.”. Example
Deprecated functions should be documented like i did with
Parameter description
I noticed that very new users have a problem when encountering a “This function is deprecated” warning from the compiler with code they got from the forum etc. (most often with The problem the new users are having is that there is no mention of these in the documentation (except maybe the history) so they do not know what to do with them at all. The docs should have an entry for such commands, so the page comes up if you press F1 on them, or search in the index. No information at all is not good IMHO. |
||
|
General description of the command (it’s purpose, etc.).
For further details also |
||
|
Generate a bold "Example" and indentation. |
||
|
Add a link to a PureBasic .pb code example in the "Examples" directory. After the tag the target OS must be added. Example
@ExampleFile All 2DDrawing.pb Parameter description
|
||
|
Shorter form of the normal Instead of Example
@FastLink "GetGadgetState()" |
||
|
Example
@FixedFont @ConstantColor "#PB_OnError_EAX" @EndFixedFont |
||
|
Conditional block, depending on the generated output format. More than one format can be specified. Example
@FormatIf HTML WEBSITE ; Here a block only for HTML and WEBSITE output @FormatEndif |
||
|
|||
|
|||
|
Will print the text in "" following the tag in green letters.
|
||
|
Add a preview picture to the description. Example
@Image openwindowedscreen2.png Parameter description
File name of the image (must be saved in "…\HelpPictures" path). |
||
|
Indent a block of text. |
||
|
Create a link to an internet site Example
@InternetLink "http://www.purebasic.com/OgreSources.zip" "OgreSources.zip". Parameter description
|
||
|
The following word or text section (inside "") will be displayed in bold+green letters, just like keywords in the PB IDE. Example
@Keyword "Global" |
||
|
Indicate the name of the library, normally placed at the start of a docmaker file. Example
@Library "onerror" "OnError Library" Parameter description
|
||
|
Create a link to the main page of a PB library. Example
@LibraryLink "console" "console programs" Parameter description
|
||
|
Forces a linebreak in description text. |
||
|
Create a link to another PB command. Example
@Link "Random" "Random()" @Link "Misc/RGB" "RGB()" Parameter description
|
||
|
|||
|
Generates “Parameters: This function has no parameters”. |
||
|
Generates “Return Value: This function does not return a value” for functions without a return value. |
||
|
Will print the text in "" following the tag in orange letters.
|
||
|
After this tag the “Operation System” (OS) can be specified. The text following after this tag will only be displayed, if the help is compiled for this OS. Example
@OS Windows Parameter description
You can currently use after
|
||
|
|||
|
Start description for a parameter (show the parameter name in bold/indented) Example
@Parameter <parametername> |
||
|
Optional: Start the parameter list … this will be done automatically, if one or more |
||
|
Will print the text in "" following the tag in red letters.
|
||
|
Create a link to a help page in the reference chapter (not in a library). Example
@ReferenceLink "newlist" "NewList" Parameter description
|
||
|
Additional information/tips about using the command.
(general description about the command will be written at the |
||
|
Description of the return value. |
||
|
Put a bold headline into the description and indent the following block of text (until a new |
||
|
Provides one or more link(s) to other related command(s). |
||
|
Parameter description
You can currently use after
|
||
|
|||
|
|||
|
Will underline the text specified in "" after the tag.
|
||
|
Faster command link, with built-in check to ensure the command exists. Example
@@CloseWindow
|
||
|
Faster constant coloring. Example
@#PB_Window_Invisible |
Contributing and Support
Feel free to contribute to this document by submitting your own fixes and improvements via Git and creating a pull request on the PureBasic Open Source repository:
If you have any questions, remarks or suggestions, just write to: <support@purebasic.com>.