NetworkedPlanet | TMCore Engine API Guide |
This document uses a number of typographical convetions to highlight particular types of words or sections of text.
Namespace, class and interface names are all displayed in a
monospaced font. e.g
NetworkedPlanet.TMAPI
,
ITopic
.
Method names are displayed in a monospaced font. When
referring to a particular overload of a method, the method
parameters are displayed, otherwise they are omitted. The first time
a method is referred to in the text, the method name is qualified by
the interface or class that it is a member of e.g.
ITopic.CreateTopicName()
File names are shown in bold monospaced font e.g.
App.config
In addition the following conventions are used to highlight sections of the text:
This is a note. A note highlights or expands on something mentioned in the text.
This is a warning. A warning alerts you to a critical piece of information.
[1] // This is a program listing [2] // It contains a code snippet which is relevant to the text [3] // Lines may be numbered for references from the text
This is computer output
It shows the text output that results
from running a command-line application.