mirror of
https://gitlab.com/fbb-git/cppannotations
synced 2024-11-16 07:48:44 +01:00
WIP
git-svn-id: https://cppannotations.svn.sourceforge.net/svnroot/cppannotations/trunk@290 f6dd340e-d3f9-0310-b409-bdd246841980
This commit is contained in:
parent
cfc63f9f65
commit
a382114385
6 changed files with 20 additions and 16 deletions
|
@ -190,16 +190,16 @@ void latexdoc(string us)
|
|||
|
||||
void docs()
|
||||
{
|
||||
man();
|
||||
// man();
|
||||
|
||||
programs(1);
|
||||
|
||||
md("tmp/docs/txt tmp/docs/html tmp/docs/latex");
|
||||
|
||||
txtdoc();
|
||||
htmldoc();
|
||||
// txtdoc();
|
||||
// htmldoc();
|
||||
latexdoc("");
|
||||
latexdoc("us");
|
||||
// latexdoc("us");
|
||||
|
||||
exit(0);
|
||||
}
|
||||
|
|
|
@ -67,9 +67,10 @@ modify the internal data of the objects. By convention, manipulators
|
|||
start with tt(set). E.g., tt(setName).
|
||||
it() With em(accessors), a tt(get)-prefix is still frequently encountered,
|
||||
e.g., tt(getName). However, following the conventions promoted by the bi(Qt)
|
||||
emi(Graphical User Interface Toolkit) (see ti(http://www.trolltech.com)), the
|
||||
tt(get)-prefix is now deprecated. So, rather than defining the member
|
||||
tt(getAddress), it should simply be named tt(address).
|
||||
(see ti(http://www.trolltech.com))
|
||||
emi(Graphical User Interface Toolkit), the tt(get)-prefix is now
|
||||
deprecated. So, rather than defining the member tt(getAddress), it should
|
||||
simply be named tt(address).
|
||||
it() Normally (exceptions exist) the public member functions of a class
|
||||
are listed first, immediately following the class's data members, They are the
|
||||
important elements of the interface as they define the features the class is
|
||||
|
|
|
@ -117,7 +117,7 @@ hi(noshowbase)tt(std::noshowbase). Example:
|
|||
)
|
||||
ithtq(showpos)(ios::showpos)
|
||||
(to display the tt(+) sign with positive decimal (only)
|
||||
values. Complementary flag: tt(ios::noshowpos). Manipulators:
|
||||
values. Complementary flag:nl()tt(ios::noshowpos). Manipulators:
|
||||
tt(std::showpos) and hi(noshowpos)tt(std::noshowpos). Example:
|
||||
verb(
|
||||
cout.setf(ios::showpos);
|
||||
|
|
|
@ -34,7 +34,7 @@ is:
|
|||
)
|
||||
rowline()
|
||||
)
|
||||
))
|
||||
)
|
||||
Example: for an tt(int x) argument a function tt(fun(int &)) is selected
|
||||
rather than a function tt(fun(int const &)). If no tt(fun(int &)) is available
|
||||
the tt(fun(int const &)) function is used. If neither is available the
|
||||
|
@ -61,9 +61,9 @@ compiler reports an error.
|
|||
))
|
||||
Example: for an tt(int arg()) argument a function tt(fun(int &&)) is
|
||||
selected rather than a function tt(fun(int const &&)). If both functions are
|
||||
unavailable but a tt(fun(int const &) is available, that function is used. If
|
||||
none of these functions is available the compiler reports an error.
|
||||
)
|
||||
unavailable but a tt(fun(int const &)) is available, that function is used.
|
||||
If none of these functions is available the compiler reports an error.
|
||||
)
|
||||
The tables show that eventually em(all) arguments can be used with a
|
||||
function specifying a tt(T const &) parameter. For em(anonymous) arguments a
|
||||
similar em(catch all) is available having a higher priority: tt(T const &&)
|
||||
|
|
|
@ -10,7 +10,8 @@ within the region of namespace tt(A).
|
|||
|
||||
Assume the type tt(int INT8[8]) is defined in the tt(CppAnnotations::Virtual)
|
||||
namespace. Furthermore assume that is is our intent to define a function
|
||||
tt(squares), inside the namespace tt(CppAnnotations::Virtual) that returns a
|
||||
tt(squares), inside the namespace nl()
|
||||
tt(CppAnnotations::Virtual) returning a
|
||||
pointer to tt(CppAnnotations::Virtual::INT8).
|
||||
|
||||
Having defined the prerequisites within the tt(CppAnnotations::)tt(Virtual)
|
||||
|
|
|
@ -11,9 +11,11 @@ tt(string) this way no argument list may be specified;)
|
|||
(initializes tt(object) with tt(count) characters tt(ch);)
|
||||
ittq(string object(string const &argument))
|
||||
(initializes tt(object) with tt(argument);)
|
||||
ittq(string object(std::string const &argument, string::size_type apos,
|
||||
string::size_type an))
|
||||
(initializes tt(object) with tt(argument).)
|
||||
itt(string object+OPENPARstd::string const &argument, string::size_type
|
||||
apos,)
|
||||
linebreak()
|
||||
tt(string::size_type an+CLOSEPAR):
|
||||
quote(initializes tt(object) with tt(argument).)
|
||||
ittq(string object(InputIterator begin, InputIterator end))
|
||||
(initializes tt(object) with the characters in the range of characters
|
||||
defined by the two tt(InputIterators).)
|
||||
|
|
Loading…
Reference in a new issue