Ferreteria/v0.5/@cls: Difference between revisions
< Ferreteria | v0.5
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
==Meta: Paradigm== | ==Meta: Paradigm== | ||
This is the class documentation paradigm I'm currently trying. | This is the class documentation paradigm I'm currently trying. | ||
* Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace. | * Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace, and include only as much of the namespace as needed to disambiguate. | ||
* The <nowiki>{{</nowiki>{{lt|l/ver/class}}|{{arg|class name}}}} template can be used to point to the documentation page for a classlike type. | * The <nowiki>{{</nowiki>{{lt|l/ver/class}}|{{arg|class name}}}} template can be used to point to the documentation page for a classlike type. | ||
* If a classlike page title could refer to more than one class, there will be a disambiguation page. | * If a classlike page title could refer to more than one class, there will be a disambiguation page. | ||
Revision as of 00:37, 2 July 2022
|
Ferreteria v0.5 classes «ferret» namespace
|
Classes
- caApp application class family
Sub-Namespaces
Meta: Paradigm
This is the class documentation paradigm I'm currently trying.
- Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace, and include only as much of the namespace as needed to disambiguate.
- The {{l/ver/class|<class name>}} template can be used to point to the documentation page for a classlike type.
- If a classlike page title could refer to more than one class, there will be a disambiguation page.