Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Utils / Console / ParsedCommand.cc
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief ParsedCommand non-inline non-template implementation */
25
26 #include "ParsedCommand.hh"
27 #include "ParsedCommand.ih"
28
29 // Custom includes
30
31 #include "ParsedCommand.mpp"
32 #define prefix_
33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
34
35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
36 // senf::console::detail::ArgumentInfoBase
37
38 prefix_ senf::console::detail::ArgumentInfoBase::~ArgumentInfoBase()
39 {}
40
41 //-/////////////////////////////////////////////////////////////////////////////////////////////////
42 // senf::console::ParsedCommandOverloadBase
43
44 prefix_ unsigned senf::console::ParsedCommandOverloadBase::v_numArguments()
45     const
46 {
47     return parameters_.size();
48 }
49
50 prefix_ void senf::console::ParsedCommandOverloadBase::v_argumentDoc(unsigned index,
51                                                                      ArgumentDoc & doc)
52     const
53 {
54     BOOST_ASSERT( index < parameters_.size() );
55     detail::ArgumentInfoBase & arg (*parameters_[index]);
56     doc.name = arg.name.empty()
57         ? (boost::format("arg%d%d") % overloadIndex() % (index+1)).str()
58         : arg.name;
59     doc.type = arg.type;
60     if (arg.hasDefault) {
61         doc.defaultValue = arg.defaultDoc.empty()
62             ? arg.defaultValueStr()
63             : arg.defaultDoc;
64         if (doc.defaultValue.empty())
65             doc.defaultValue = "(empty)";
66     }
67     doc.doc = arg.doc;
68     doc.singleToken = arg.singleToken;
69 }
70
71 prefix_ std::string senf::console::ParsedCommandOverloadBase::v_doc()
72     const
73 {
74     return doc_;
75 }
76
77 //-/////////////////////////////////////////////////////////////////////////////////////////////////
78 #undef prefix_
79 #include "ParsedCommand.mpp"
80
81 \f
82 // Local Variables:
83 // mode: c++
84 // fill-column: 100
85 // comment-column: 40
86 // c-file-style: "senf"
87 // indent-tabs-mode: nil
88 // ispell-local-dictionary: "american"
89 // compile-command: "scons -u test"
90 // End: