Console: Overhaul documentation
[senf.git] / 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 ///////////////////////////////cc.p////////////////////////////////////////
34
35 ///////////////////////////////////////////////////////////////////////////
36 // senf::console::ParsedCommandOverloadBase
37
38 prefix_ unsigned senf::console::ParsedCommandOverloadBase::v_numArguments()
39     const
40 {
41     return parameters_.size();
42 }
43
44 prefix_ void senf::console::ParsedCommandOverloadBase::v_argumentDoc(unsigned index,
45                                                                      ArgumentDoc & doc)
46     const
47 {
48     BOOST_ASSERT( index < parameters_.size() );
49     detail::ArgumentInfoBase & arg (*parameters_[index]);
50     doc.name = arg.name.empty() 
51         ? (boost::format("arg%d%d") % overloadIndex() % (index+1)).str()
52         : arg.name;
53     doc.type = arg.type;
54     if (arg.hasDefault) {
55         doc.defaultValue = arg.defaultDoc.empty()
56             ? arg.defaultValueStr()
57             : arg.defaultDoc;
58         if (doc.defaultValue.empty())
59             doc.defaultValue = "(empty)";
60     }
61     doc.doc = arg.doc;
62 }
63
64 prefix_ std::string senf::console::ParsedCommandOverloadBase::v_doc()
65     const
66 {
67     return doc_;
68 }
69
70 ///////////////////////////////cc.e////////////////////////////////////////
71 #undef prefix_
72 #include "ParsedCommand.mpp"
73
74 \f
75 // Local Variables:
76 // mode: c++
77 // fill-column: 100
78 // comment-column: 40
79 // c-file-style: "senf"
80 // indent-tabs-mode: nil
81 // ispell-local-dictionary: "american"
82 // compile-command: "scons -u test"
83 // End: