ND+ - - Index

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

L
	Languages
	Levelling format\ bullets.txt format\ definitions.txt format\ numbered.txt
	License introduction.txt plugin\ hilite\ hilite.txt
	Line prefixes
	Linkage
	Linked Text
	Links
M
	ManDoc
	Manual Levelling
	Marked regions
	Member documentation
	Microsoft
	Mixed format\ bullets.txt format\ definitions.txt format\ numbered.txt
	ModeLine Example
	Modelines
	More Stuff CTest1:: Package1 CTest1:: Package2 CTest1:: Package3 PerlClassA:: Child1 PerlClassA:: Child2 PerlClassA:: Child3 PerlClassA:: Child4 PerlClassA:: Parent
	Mscgen
	Mscgen Source
	My Test Table
	MyFunction
	mynamespace:: Base
	mynamespace:: DerivedA
	mynamespace:: DerivedB
	mynamespace:: Top
	MyStruct, MyStruct
N
	Natural Docs Resources
	ND Basic Table Format
	ND Table Format
	ND+-The extended Natural Docs package
	NothrowFunction, mynamespace:: Base
	Numbered Lists
O
	ONE, mynamespace:: Base:: ReturnValue
	overflow, Stack< T, size >
	Overview Global format\ bullets.txt format\ definitions.txt format\ modeline.txt format\ numbered.txt CTest1:: Package1 CTest1:: Package2 CTest1:: Package3 PerlClassA:: Child1 PerlClassA:: Child2 PerlClassA:: Child3 PerlClassA:: Child4 PerlClassA:: Parent Repeated
P
	Packages
	Page Footer
	PerlClassA
	PerlClassA:: Child1
	PerlClassA:: Child2
	PerlClassA:: Child3
	PerlClassA:: Child4
	PerlClassA:: Parent
	PlantUML
	PlantUML Source
	Plugin Source Information
	Plugins
	pop, Stack< T, size >
	Possible Additions
	Prototypes
	push, Stack< T, size >
Q
	Quote regions
R
	readme
	Repeated
	ReturnValue, mynamespace:: Base
	ReturnValueFunction, mynamespace:: Base
	RRDiagram
S
	Scalable Vector Graphics
	SDEdit
	SDEdit Source
	Signal handlers
	Simple Table Format
	Specials
	Stack Global Stack
~	Stack, Stack
	StaticFunction, mynamespace:: Base
	String
	Sub Tables
	SubHeaders and markups
	SyntaxHighlighter
	SyntaxHighlighter Source
T
	Tables
	Test
	Text markups
	Text Markups
	THREE, mynamespace:: Base:: ReturnValue
	ThrowFunction, mynamespace:: Base
	timing-gen
	Title table\ table_format2.txt table\ table_format3.txt
	Title1
	Title2
~	Top, mynamespace
	Topic Options
	toString, abc. data. Input
	TWO, mynamespace:: Base:: ReturnValue
	TypeA, TypeA
	TypeB, TypeB
	TypeC_t
	Types Global MyStruct TypeA
U
	underflow, Stack< T, size >
	UnnamedClass Global UnnamedClass
~	UnnamedClass, UnnamedClass
V
	VectorFunction, mynamespace:: Base
	VirtualConst, mynamespace:: Base

Here’s a list of supported languages and their aliases.

Bullet lists can represent multiple levels of elements directed by the indentation of each line, for example;

ND+ is licensed under the GPL-2.0, the same terms and conditions as Natural Docs 1.4.

Code sections using line prefixes (>), (|) or (:) as the first non whitespace character shall be treated in the same fashion as (code)/(end) code snippets, examples.

Module to test support for C and C++ explicit linkage declarations

blah blah ...

email: nobody@earth.org

mandoc is a suite of tools compiling mdoc, the roff macro language of choice for BSD manual pages, and man, the predominant historical language for UNIX manuals.

Unlike Bullet Lists and Definition Lists, numbered list allow manual leveling by means of a dot notation represents the desired structure.

Start section using regions marked within ([start] code) ..

For languages with Full Language Support (e.g.

class Microsoft : public Corporation, public Enemy<(number) 1>

Big brother

Bullet lists can be mixed within other ND list constructs.

The source information of this document has the following ND configuration, with the result following.

You can embed per file configuration details within an individual source image to allow fine tunning of its representation.

blah blah

Mscgen is a small program that parses Message Sequence Chart descriptions and produces PNG, SVG, EPS or server side image maps (ismaps) as the output.

Basic planet details

void MyFunction ( int arg1,
int arg1 )

The MyFunction definition is using an explicit prototype.

class Base

Base class

class DerivedA : virtual public Base

DerivedA class

class DerivedB : virtual public Base

DerivedB class

class Top : public DerivedA, public DerivedB

Top class

struct MyStruct{ std:: string name;
std:: string address;
};

Structure My

A number of other Natural Docs resources which you may find useful.

Similar to the ND format, is the basic layout, which uses a fixed format column defined by the header like the ND format.

Following in the design spirit of Natural Docs this table format has a layout within the original source files which shall read just as easily as the generated documentation.

int NothrowFunction( ) throw()

A nothrow function

You can define a Numbered list by using the format below, specifically text within a leading number.

enum one .

template<class T, int size> void Stack<T, size> ::overflow()

Stack overflow signal

The standard ND bullet syntax is supported plus a number of extensions including Levelling, Continuation and Mixed usage.

blah blah

The simplest and most obvious use of multiple inheritance is to “glue” not related classes together, as part of the implementation of a third class.

ND+ has new features and options to deal with packages which are split across a number of source files.

You can set a global page footer which is appended to the end of each generated page.

PerlClassA

PerlClassA::Root

PlantUMLis a Java component that allows you to quickly write.

template<class T, int size> T Stack<T, size> ::pop()

Pop a stack element

In addition to the above, the following are being considered as future enhancements; following AsciiDoc and several Wiki’s.

You can explicity inline the prototype for the given topic.

template<class T, int size> void Stack<T, size> ::push( T item )

Push a stack element

Similar to nature code sections are quote regions in that they retain there line breaks, yet have an alternative stype applied.

Here’s some text

Repeated inheritance example.

enum ReturnValue {

Return value enumeration

Base::ReturnValue ReturnValueFunction()

A function with a typed return value

Generate railroad diagrams from code or BNF.

Quick Sequence Diagram Editor

The table Simple or wiki format uses a similar syntax to a number of Wiki’s which is an effective yet easy method of creating tables.

A number of automatic special character conversions shall occur when their text equivilent is used;

template<class T, int size = 10> class Stack

Basic stack templete class

Stack()

Public constructor

~Stack()

Public destructor

const unsigned StaticFunction()

Static function returning a const value

string package.

And last but not least it is possible to embed a table definition within a cell; with a few minor limitations.

SyntaxHighlighter version 3.0.83

Tables may be embedded within topic bodies.

Here’s some text

The design spirit of Natural Docs is that document layout within the original source files which shall generally read just as easily as the generated documentation.

The total set of ND markups and extensions are;

enum three enum three cont

int ThrowFunction( ) throw(A, B)

A throw function

Timing-gen is a Linux tool to generate high quality Postscript timing diagrams from text input files.

Public destructor

The following topic options define the behaviour when multiple topics referencing the same name are encountered within seperate source pages (e.g.

public function toString() : String

toString TODO:...

enum two

typedef struct { int afield1;
int afield2;
int afield3;
int afield4;
int afield5;
} TypeA;

CTest1::Package1::TypeA

struct TypeB{ int bfield1;
int bfield2;
int bfield3;
int bfield4;
int bfield5;
};

CTest1::Package1::TypeB

CTest1::Package1::TypeC

template<class T, int size> void Stack<T, size> ::underflow()

Stack underflow signal

class UnnamedClass

A namespace defines a new scope.

UnnamedClass()

Constructor

~UnnamedClass()

Destructor

const std::vector<int> & VectorFunction()

A function returning a vector of ints

void VirtualConst() const = 0

A const pure virtual function