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

$#!
	plugin\ hilite\ hilite.txt table\ table_format3.txt
	= mynamespace mynamespace:: DerivedA mynamespace:: DerivedB
A
	abc. data. Input
	Aconstant1, CTest1:: Package2
	Aconstant2, CTest1:: Package2
	Aconstant3, CTest1:: Package2
	Aconstant4, CTest1:: Package2
	Aconstant5, CTest1:: Package2
	Admonitions
	AsciiDoc
	ASCIIMathML
	AVALUEA, EnumA
	AVALUEB, EnumA
	AVALUEC, EnumA
	AVALUED, EnumA
	AVALUEE, EnumA
B
	Base, mynamespace:: Base
~	Base, mynamespace:: Base
	Bconstant1
	Bconstant2
	Bconstant3
	Bconstant4
	Bconstant5
	Bullet Lists
	BVALUEA, EnumB
	BVALUEB, EnumB
	BVALUEC, EnumB
	BVALUED, EnumB
	BVALUEE, EnumB
C
	c_string
	c1_func
	c2_func
	cbinding, mynamespace
	ClassA
	ClassA&ClassB
	ClassB
	Code Snippets
	Constants Global CTest1:: Package2
	ConstFunction, mynamespace:: Base
	ConstReturn, mynamespace:: Base
	Constructors, Stack
	Continuation format\ bullets.txt format\ definitions.txt format\ numbered.txt
	Copyright Example
	cpp_func
	createRecord, abc. data. Input
	CSV Table Format
	CTest1:: Package1
	CTest1:: Package2
	CTest1:: Package3
D
	Definition Lists
	Demo
	DerivedA, mynamespace:: DerivedA
~	DerivedA, mynamespace:: DerivedA
	DerivedB, mynamespace:: DerivedB
~	DerivedB, mynamespace:: DerivedB
	Diagrams
	Ditaa
	Ditaa Source
E
	Emacs Emulation
	empty, Stack
	EnumA
	EnumB
	Enumerations Global mynamespace:: Base
	Example 1
	Example Basic Table
	Example ND Table
F
	f1
	f2
	f3
	f4
	Features format\ modeline.txt plugin\ hilite\ hilite.txt plugin\ mscgen\ mscgen.txt
	Formats
	Formatting
	FOUR, mynamespace:: Base:: ReturnValue
	full, Stack
	FunctionA Global c\ test1_pkg1.c c\ test1_pkg2.c c\ test1_pkg3.c mixed\ mixed.c PerlClassA:: Child1 PerlClassA:: Child2 PerlClassA:: Child3 PerlClassA:: Child4 PerlClassA:: Parent
	FunctionA Return Values, CTest1:: Package2
	FunctionB Global c\ test1_pkg1.c c\ test1_pkg2.c c\ test1_pkg3.c mixed\ mixed.c PerlClassA:: Child1 PerlClassA:: Child2 PerlClassA:: Child3 PerlClassA:: Child4 PerlClassA:: Parent
	FunctionB Return Values
	FunctionC
	FunctionD
	FunctionE
	Functions Global c\ test1_pkg1.c c\ test1_pkg2.c c\ test1_pkg3.c cpp\ string.cpp format\ prototype.txt mixed\ mixed.c abc. data. Inputmynamespace cpp\ linkage.cpp cpp\ repeat.cpp mynamespace:: Base mynamespace:: DerivedA mynamespace:: DerivedB PerlClassA:: Child1 PerlClassA:: Child2 PerlClassA:: Child3 PerlClassA:: Child4 PerlClassA:: Parent Stack UnnamedClass
G
	General syntax rules table\ table_format0.txt table\ table_format1.txt table\ table_format2.txt table\ table_format3.txt
I
	init, abc. data. Input
	Input, abc. data. Input
	Introduction introduction.txt plugin\ ditaa\ ditaa.txt plugin\ hilite\ hilite.txt plugin\ mscgen\ mscgen.txt plugin\ plantuml\ plantuml.txt plugin\ plugins.txt plugin\ sdedit\ sdedit.txt plugin\ svg\ svg\ info.txt table\ table.txt

Base& Base::operator=( const Base& )

Assigment operator

DerivedA& operator=( const DerivedA& )

Assigment operator

DerivedB& operator=( const DerivedB& )

Assigment operator

abc.data.Input TODO:...

meaning 1

meaning 2

meaning 3

meaning 4

meaning 5

Admonition’s allow hilited reminders and notes.

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs.

Translating ASCII math notation to Presentation MathML

Base( int data )

Public constructor

~Base()

Public destructor

meaning 1

meaning 2

meaning 3

meaning 4

meaning 5

You can add bullet lists by starting a line one of the following four characters seperated by a space;

char* c_string( const string & s )

c_string function

extern "C" void c1_func()

extern "C" void c2_func()

extern "C" static void cbinding()

Primary

Tests for multiple class definitions within the same image.

Primary

Code sections allow example code etc to be placed unprocessed within the documentation.

unsigned ConstFunction() const

Const function returning a const value

char const* const ConstReturn()

Function returning a const * const value

Bullet list content maybe stated over a number of lines.

void cpp_func()

private function createRecord()

createRecord TODO:...

The table Comma Seperated Value (CSV) format uses a similar syntax as Simple Table Format with support for quoted columns of dating.

CTest1::Package1

CTest1::Package2

CTest1::Package3

You can add a definition list by using the format below, specifically text space dash space text.

A demo ASCII art to Scalable Vector Graphics (SVG)

DerivedA()

Public constructor

~DerivedA()

Public destructor

DerivedB()

Public constructor

~DerivedB()

Public destructor

The following diagrams will explain all

Ditaa diagram are defined by marked regions.

In addition, ND+ supports to number of emacs style modelines allowing either of two normal forms:

int empty() const

Determine whether the stack is empty.

enum EnumA {

CTest1::Package1::TypeA

For basic and advanced level languages the Prototype keywords allow a prototype to be embedded within the documentation.

This is an example of a ND style table

extern "C" int f1( int )

extern "C" int f2( int )

extern "C" int f3( int )

void f4()

The following features for any given source image can be controlled thru an embedded modeline.

ND+ supports a number of different table formatting styles for the table body, the default being nd:

You can add basic markups by using the following formats.

enum fourenum four count

int full() const

Determine whether the stack is full.

void FunctionA()

CTest1::Package1::FunctionA

sub FunctionA

Returns the character at the specified index.

sub FunctionA

PerlClassA::Child2::FunctionA

sub FunctionA

PerlClassA::Child3::FunctionA

sub FunctionA #( arg1,
arg2 )

PerlClassA::Child4::FunctionA

sub FunctionA

PerlClassA::Parent::FunctionA

void FunctionB()

CTest1::Package1::FunctionB

sub FunctionB

Returns the character at the specified index.

sub FunctionB #( arg1,
arg2 )

PerlClassA::Child2::FunctionB

sub FunctionB #( arg1,
arg2 )

PerlClassA::Child3::FunctionB

sub FunctionB #( arg1,
arg2 )

PerlClassA::Child4::FunctionB

sub FunctionB

PerlClassA::Parent::FunctionB

void FunctionC()

Class B::FunctionC

void FunctionD()

Class A::FunctionD

void FunctionE()

Class A::FunctionE

While no formal specification for CSV exists, RFC 4180 describes a common format and establishes “text/csv” as the MIME type registered with the IANA, with the CVS table syntax following these guidelines.

private function init( name : String,
id : Number,
date : Date ) : Object

init TODO:...

public function Input( name : String,
id : Number,
date : Date )

Input TODO:...

Natural Docs Plus package (ND+).