SyntaxRules

Most of the rules can be found at OddMuse:Text_Formatting_Rules. There are however a few additions.

It is possible to link to the C++, Java and IDL documentation by using the CDoc, JDoc and IDoc constructs:

• <CDoc Namespace::Namespace::ClassName>
• <JDoc c Package::Package::ClassName>
• <JDoc i Package::Package::InterfaceName>
• <IDoc i Package::Package::InterfaceName>
• <IDoc s Package::Package::StructName>
• <IDoc e Package::Package::ExceptionName>

Notice the use of c, i, s, e or n to indicate whether the documentation refers to a class, interface, struct, exception or namespace.

Basically the pattern is : <[CJI]Doc [cinse]? Namespace::Package::Name> If the character c, i, n, s or e is omitted, it defaults to c.

These link to the atlasdaq webpage documentation, so we'd best keep it up to date.

Here are some examples:

• <CDoc Sct::SctNames> <SctNames>
• <CDoc SctCalibrationController::Ipc::RequestException> <RequestException>
• <JDoc i GuiComponents::scripting::NameCompleter> <NameCompleter>
• <IDoc s sctConf::ABCDModule> <ABCDModule>
• <IDoc e sctConf::ConfigurationException> <ConfigurationException>
• <CDoc n sctConf> <sctConf>