Console: Overhaul documentation
[senf.git] / Console / ParsedCommand.cci
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 inline non-template implementation */
25
26 #include "ParsedCommand.ih"
27
28 // Custom includes
29
30 #define prefix_ inline
31 ///////////////////////////////cci.p///////////////////////////////////////
32
33 ///////////////////////////////////////////////////////////////////////////
34 // senf::console::ParsedCommandOverloadBase
35
36 prefix_ senf::console::ParsedCommandOverloadBase::ParsedCommandOverloadBase()
37 {}
38
39 prefix_ senf::console::detail::ArgumentInfoBase &
40 senf::console::ParsedCommandOverloadBase::arg(unsigned n)
41     const
42 {
43     BOOST_ASSERT(n < parameters_.size());
44     return * parameters_[n];
45 }
46
47 prefix_ void senf::console::ParsedCommandOverloadBase::doc(std::string const & d)
48 {
49     doc_ = d;
50 }
51
52 ///////////////////////////////////////////////////////////////////////////
53 // senf::console::ParsedCommandAttributorBase
54
55 prefix_ senf::console::OverloadedCommandNode &
56 senf::console::ParsedCommandAttributorBase::node()
57     const
58 {
59     return overload_.node();
60 }
61
62 prefix_ senf::console::ParsedCommandAttributorBase::operator OverloadedCommandNode &()
63     const
64 {
65     return node();
66 }
67
68 prefix_ senf::console::ParsedCommandAttributorBase::
69 ParsedCommandAttributorBase(ParsedCommandOverloadBase & overload, unsigned index)
70     : overload_ (overload), index_ (index)
71 {}
72
73 prefix_ void senf::console::ParsedCommandAttributorBase::argName(std::string const & name)
74     const
75 {
76     overload().arg(index_).name = name;
77 }
78
79 prefix_ void senf::console::ParsedCommandAttributorBase::argDoc(std::string const & doc)
80     const
81 {
82     overload().arg(index_).doc = doc;
83 }
84
85 prefix_ void senf::console::ParsedCommandAttributorBase::typeName(std::string const & doc)
86     const
87 {
88     overload().arg(index_).type = doc;
89 }
90
91 prefix_ void senf::console::ParsedCommandAttributorBase::defaultDoc(std::string const & doc)
92     const
93 {
94     overload().arg(index_).defaultDoc = doc;
95 }
96
97 prefix_ senf::console::ParsedCommandOverloadBase &
98 senf::console::ParsedCommandAttributorBase::overload()
99     const
100 {
101     return overload_;
102 }
103
104 prefix_ void senf::console::ParsedCommandAttributorBase::overloadDoc(std::string const & doc)
105     const
106 {
107     overload().doc(doc);
108 }
109
110 prefix_ void senf::console::ParsedCommandAttributorBase::nodeDoc(std::string const & doc)
111     const
112 {
113     node().doc(doc);
114 }
115
116 ///////////////////////////////cci.e///////////////////////////////////////
117 #undef prefix_
118
119 \f
120 // Local Variables:
121 // mode: c++
122 // fill-column: 100
123 // comment-column: 40
124 // c-file-style: "senf"
125 // indent-tabs-mode: nil
126 // ispell-local-dictionary: "american"
127 // compile-command: "scons -u test"
128 // End: