All Identifiers
| Name | Unit | Description |
|---|---|---|
| Bar | ok_cdecl_external |
|
| Bar | ok_directive_as_identifier |
|
| BytePos | ok_complicated_record | enumeration used in variant record |
| Cdecl | ok_directive_as_identifier |
|
| ConvertDouble | ok_complicated_record |
|
| EBar | ok_expanding_descriptions |
|
| EFoo | ok_expanding_descriptions |
|
| EFoo | ok_tag_params_no_parens |
|
| EXyz | ok_expanding_descriptions |
|
| Foo | ok_cdecl_external |
|
| Foo | ok_directive_as_identifier |
|
| Foo | ok_link_class_unit_level |
|
| Foo | ok_paragraph_in_single_line_comment | This is the 1st paragraph. |
| Foo | warning_tags_no_parameters | Some tags are not allowed to have parameters. |
| Foo1 | ok_directive_as_identifier | Some other test for THTMLDocGenerator.WriteCodeWithLinks, while I'm at it: Note that link to TMyClass should be correctly made. |
| MyConst | ok_deprecated_tag |
|
| MyConst | ok_nodescription_printing |
|
| MyOtherProc | ok_links_2 |
|
| MyProc | ok_deprecated_tag |
|
| MyProc | ok_links | Link to self : MyProc, and a second one: ok_links.MyProc, link to MyProc in other unit: ok_links_2.MyProc. |
| MyProc | ok_links_2 |
|
| MyProc | ok_link_explicite_name | Some testing proc. |
| MyProc | ok_nodescription_printing |
|
| MyVar | ok_deprecated_tag |
|
| MyVariable | ok_nodescription_printing |
|
| PDoubleEndianCnvRec | ok_complicated_record |
|
| RecursiveTwoAt | ok_expanding_descriptions | aa aaaaa aa aaa At some point, this test caused the bug: final </code> tag was inserted in converted form (processed with ConvertString) into html output. |
| Register | ok_directive_as_identifier |
|
| SomeProc | ok_tag_params_no_parens | Note that this rule allows you to not specify () for *any* tag that has parameters. |
| SwapDoubleBytes | ok_complicated_record |
|
| TAbstractTerminationClass | warning_abstract_termination | (This abstract tag lacks the closing parenthesis. |
| TBar | ok_link_class_unit_level | These are links from class' description to an identifiers inside the same class. |
| TClass1 | ok_nodescription_printing |
|
| TDoubleEndianCnvRec | ok_complicated_record |
|
| TestConstCombined | ok_hint_directives |
|
| TestConstDeprecated | ok_hint_directives |
|
| TestConstLibrary | ok_hint_directives |
|
| TestConstPlatform | ok_hint_directives |
|
| TestFuncCombined | ok_hint_directives |
|
| TestFuncDeprecated | ok_hint_directives |
|
| TestFuncPlatform | ok_hint_directives |
|
| TestHtmlAndLatexTags | ok_expanding_descriptions | This is some dummy html code, just to show that inside @html tag of pasdoc (note that I used single @ char in this sentence) nothing is expanded by pasdoc. No paragraphs are created by pasdoc. (This text is still in the 1st, not in the 2nd, paragraph in html output) You must explicitly write <p> to get paragraph. No tags work, e.g. @link(TestLongCode).
Note that text inside @html / @latex tags is absolutely not touched by pasdoc. |
| TestLineBreak | ok_line_break | 1st paragraph. |
| TestLongCode | ok_expanding_descriptions | Note that inside @longcode below I should be able to write singe @ char to get it in the output, no need to double it (like @@). |
| TestPasMethodTags | ok_expanding_descriptions | This is a test of tags expanded by TPasRoutine handlers. |
| TestProcCombined | ok_hint_directives |
|
| TestProcDeprecated | ok_hint_directives |
|
| TestProcExperimental | ok_hint_directives |
|
| TestProcPlatform | ok_hint_directives |
|
| TestProcUnimplemented | ok_hint_directives |
|
| TestRecursiveTag | ok_expanding_descriptions | @code and @returns (and some others) tags are recursive, you can freely put other tags inside. |
| TestVarCombined | ok_hint_directives |
|
| TestVarDeprecated | ok_hint_directives |
|
| TestVarLibrary | ok_hint_directives |
|
| TestVarPlatform | ok_hint_directives |
|
| TestWarnings | warning_not_existing_tags | pasdoc should complain (display warnings) about wrong tags : @firstwarning(blah blah), |
| TMyClass | ok_deprecated_tag | Deprecated class. |
| TMyClass | ok_directive_as_identifier |
|
| TMyClass | ok_expanding_descriptions | These are some tags that are not allowed to have parameters: name |
| TMyClass | ok_value_member_tags |
|
| TMyClass | warning_value_member_tags |
This should cause 3 warnings: MyField1 has two descriptions, MyField2 has two descriptions, and NotExistsingMember does not exist. |
| TMyClassAncestor | ok_expanding_descriptions |
|
| TMyEnum | ok_value_member_tags |
|
| TMyEnum | warning_value_member_tags |
This should cause 3 warnings: meOne has two descriptions, meTwo has two descriptions, and meNotExisting does not exist. |
| TMyRecord | ok_nodescription_printing |
|
| TMyRecord | ok_value_member_tags |
|
| TMyRecord2 | ok_nodescription_printing | This record has a description, but still LaTeX output will not list it in it's summary list (in the "Overview" section). |
| TMyRecord3 | ok_nodescription_printing |
|
| TMySimpleType | ok_nodescription_printing |
|
| TMyType | ok_deprecated_tag | Normal type deprecated. |
| TSomeClass | ok_links |
|
| TSomeClass | ok_links_2 |
|
| TSomeOtherClass | ok_links_2 |
|
| TTestClassDeprecated | ok_hint_directives |
|
| TTestingClass | ok_link_explicite_name | I'm a testing class, oh ! And don't forget to look at my method ! |
| TTestRecordDeprecated | ok_hint_directives |
|
| TwoAt | ok_expanding_descriptions | Write two at chars, like this @@, to get one @ in output. |
| Xyz | ok_cdecl_external |
|
| Xyz | ok_link_class_unit_level |
|