Template.h File Reference

#include "DjVuGlobal.h"
#include <string.h>
#include "GException.h"

Include dependency graph for Template.h:

Go to the source code of this file.

Classes
class	ExampleClass
	One-line class description. More...
Functions
Template.h
Files #"Template.h"# and #"Template.cpp"# are not used for anything but the current programming and documentation standards in the DjVu reference library. This doc++ comment briefly describes the abstractions defined in this files. It must mention all the files involved in implementing this features, as well as references to the main classes {classname}. This comment may contain additional sections as follows: { Algorithmic Remarks} --- Comments about the algorithms, their performance and their limitations. { Historical Remarks} --- Comments about the successive revisions of this file and other anecdotical details. This is where we can amuse the reader with funny details. { ToDo} --- Things that we have been thinking to do but did not fully implement yet. It should explain how we plan to modify the current code could be modified to implement these things. People who change this code thus should avoid jeopardizing these plans. { Example} --- It would be cool to demonstrate how these functions can be used by providing a small segment of C/C++ code. {verbatim} ExampleClass toto(3,4); toto.draw(mywin); {verbatim} This main doc++ comment is followed by a few doc++ entries. {itemize} the "memo" field contains a single line description of the file. the "version" field contains a cvs magic expression. the author fields contains a list of authors and email addresses. (the #\# termination breaks the line.) {itemize} Template header file Version: $Id: Template.h,v 1.8 2003/11/07 22:08:22 leonb Exp $# Author: : L\'eon Bottou <leonb@research.att.com> -- initial implementation \ Andrew Erofeev <eaf@geocities.com> -- implemented EXTERNAL_TEMPLATES
ExampleClass	combine_example_classes (const ExampleClass &, const ExampleClass &b)

---

Function Documentation

ExampleClass combine_example_classes	(	const ExampleClass &	,
		const ExampleClass &	b
	)

One-line function description.

Long description. Public external functions should be documented as classes. Note that a family of public external function can be introduced by a generic entry (see below)