1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
//C- -*- C++ -*-
//C- -------------------------------------------------------------------
//C- DjVuLibre-3.5
//C- Copyright (c) 2002 Leon Bottou and Yann Le Cun.
//C- Copyright (c) 2001 AT&T
//C-
//C- This software is subject to, and may be distributed under, the
//C- GNU General Public License, Version 2. The license should have
//C- accompanied the software or you may obtain a copy of the license
//C- from the Free Software Foundation at http://www.fsf.org .
//C-
//C- This program is distributed in the hope that it will be useful,
//C- but WITHOUT ANY WARRANTY; without even the implied warranty of
//C- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//C- GNU General Public License for more details.
//C-
//C- DjVuLibre-3.5 is derived from the DjVu(r) Reference Library
//C- distributed by Lizardtech Software. On July 19th 2002, Lizardtech
//C- Software authorized us to replace the original DjVu(r) Reference
//C- Library notice by the following text (see doc/lizard2002.djvu):
//C-
//C- ------------------------------------------------------------------
//C- | DjVu (r) Reference Library (v. 3.5)
//C- | Copyright (c) 1999-2001 LizardTech, Inc. All Rights Reserved.
//C- | The DjVu Reference Library is protected by U.S. Pat. No.
//C- | 6,058,214 and patents pending.
//C- |
//C- | This software is subject to, and may be distributed under, the
//C- | GNU General Public License, Version 2. The license should have
//C- | accompanied the software or you may obtain a copy of the license
//C- | from the Free Software Foundation at http://www.fsf.org .
//C- |
//C- | The computer code originally released by LizardTech under this
//C- | license and unmodified by other parties is deemed "the LIZARDTECH
//C- | ORIGINAL CODE." Subject to any third party intellectual property
//C- | claims, LizardTech grants recipient a worldwide, royalty-free,
//C- | non-exclusive license to make, use, sell, or otherwise dispose of
//C- | the LIZARDTECH ORIGINAL CODE or of programs derived from the
//C- | LIZARDTECH ORIGINAL CODE in compliance with the terms of the GNU
//C- | General Public License. This grant only confers the right to
//C- | infringe patent claims underlying the LIZARDTECH ORIGINAL CODE to
//C- | the extent such infringement is reasonably necessary to enable
//C- | recipient to make, have made, practice, sell, or otherwise dispose
//C- | of the LIZARDTECH ORIGINAL CODE (or portions thereof) and not to
//C- | any greater extent that may be necessary to utilize further
//C- | modifications or combinations.
//C- |
//C- | The LIZARDTECH ORIGINAL CODE is provided "AS IS" WITHOUT WARRANTY
//C- | OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
//C- | TO ANY WARRANTY OF NON-INFRINGEMENT, OR ANY IMPLIED WARRANTY OF
//C- | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
//C- +------------------------------------------------------------------
//
// $Id: Template.h,v 1.8 2003/11/07 22:08:22 leonb Exp $
// $Name: release_3_5_15 $
//T// This is a template for the header files in the
//T// DjVu reference library. It describes the general
//T// conventions as well as the documentation.
//T// Comments prefixed with '//T//' explain the template
//T// features and should be removed.
#ifndef _TEMPLATE_H_
#define _TEMPLATE_H_
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#if NEED_GNUG_PRAGMAS
# pragma interface
#endif
//T// Always include "DjVuGlobal.h"
#include "DjVuGlobal.h"
//T// Other include files
#include <string.h>
#include "GException.h"
//T// Begin name space
#ifdef HAVE_NAMESPACES
namespace DJVU {
# ifdef NOT_DEFINED // Just to fool emacs c++ mode
}
#endif
#endif
/** @name 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 \Ref{classname}.
This comment may contain additional sections as follows:
{\bf Algorithmic Remarks} --- Comments about the algorithms, their
performance and their limitations.
{\bf 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.
{\bf 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.
{\bf Example} --- It would be cool to demonstrate how these functions
can be used by providing a small segment of C/C++ code.
\begin{verbatim}
ExampleClass toto(3,4);
toto.draw(mywin);
\end{verbatim}
This main doc++ comment is followed by a few doc++ entries.
\begin{itemize}
\item the "memo" field contains a single line description of the file.
\item the "version" field contains a cvs magic expression.
\item the author fields contains a list of authors and email addresses.
(the #\\# termination breaks the line.)
\end{itemize}
@memo
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 */
//@{
//T// The magic doc++ comment above opens a doc++ context.
//T// Now comes the 'interface part' of the file.
//T// The c++ classes and public functions are defined there.
//T// Doc++ comments must be inserted for all functions
//T// intended to be used by other people.
//T//
//T// Quite often c++ sucks and it is necessary to have public or external symbols
//T// that actually are only there for implementation purposes.
//T// It is good to give a comment but this should not be a doc++ comment
//T// (see class GPool in GContainer.h). All other 'public' and 'protected'
//T// members should have a doc++ comment. There is no need to comment 'private'
//T// members, although a regular comment can be useful (not a doc++ comment).
/** One-line class description.
Long description. There is no need to repeat the class name in the
one-line description. The long description should describe the abstraction
and point the user to the main member functions. An example could be
inserted when this is informative and not redundant with the file
description. Templates should document which member functions are
required for their type argument. The availability of non availabilty of a
copy constructor/copy operator can be specified when appropriate.
See the doc++ documentation for available LaTeX constructs.
*/
class ExampleClass
{
public:
/** Virtual Destructor. */
~ExampleClass();
/** Null Constructor. */
ExampleClass();
/** Copy Constructor. */
ExampleClass(ExampleClass &ref);
/** Copy operator. */
ExampleClass& operator=(ExampleClass &ref);
/** Example of member function. The first sentence of the member
function description must be a short single line description.
The rest can be more verbose. Excerpts of C or C++ text should
be surrounded by dieze characters (as in #win#). The doc++ #@param#
construct should be used when there is a need for additional details
about the arguments. In that case all the arguments must be documented
with a #@param# directive.
@param win drawing window.
This window must be created with #CreateWindow# and must be visible when
function #draw# is called.
*/
void draw(Window win);
protected:
/** Minimal x-coordinate. */
int xmin;
/** Maximal x-coordinate. */
int xmax;
private:
int whatever;
float encode;
};
/** 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) */
ExampleClass combine_example_classes(const ExampleClass&,
const ExampleClass &b);
/** @name Generic entry.
Long description. there is sometimes a need to add documentation
entries for grouping things which are not connected by the C++
syntax (a family of functions, a family of defines, etc...).
The description starts with a very short name (introduced with #@name#)
followed by a long description. Because of doc++ limitations,
the one-line description must appear after the long description
in a #@memo# entry.
@memo One-line description
*/
//T// The following comments should be used when
//T// the preceding generic entry contains sub-entries
//@{
//T// Sub-entries (both DOC++ and C++) should be declared there.
//@}
//@}
//T// The magic doc++ comment above closes the doc++ file context.
//T// The rest of the file only contains implementation stuff.
// ------------ CLASSEXAMPLE INLINES
//T// This is where all the inline/template functions should be written
//T// This part of the file is segmented with comments.
inline void
ClassExample::width()
{
return xmax-xmin;
}
// ------------ THE END
//T// End name space
#ifdef HAVE_NAMESPACES
}
# ifndef NOT_USING_DJVU_NAMESPACE
using namespace DJVU;
# endif
#endif
#endif
//T// Terminates the multiple inclusion #ifndef
|
