Abdelrazak Younes <[EMAIL PROTECTED]> writes: | Lars Gullik Bjønnes wrote: | | + ListingsParam(string v, bool o, param_type t, string i, docstring h) | > | + : value_(v), onoff_(o), type_(t), info_(i), hint_(h) | > const ref strings please. | | I've done that and added/fixed some more Doxygen comments.
Note that "FIXME" also exists in doxygen. There it is called "todo" and you can get doxygen to create lists/reports for you. | Modified: lyx-devel/trunk/src/insets/InsetListingsParams.cpp | URL: | http://www.lyx.org/trac/file/lyx-devel/trunk/src/insets/InsetListingsParams.cpp?rev=18536 | ============================================================================== | --- lyx-devel/trunk/src/insets/InsetListingsParams.cpp (original) | +++ lyx-devel/trunk/src/insets/InsetListingsParams.cpp Mon May 28 | 00:46:09 2007 | @@ -53,48 +53,55 @@ | }; | | | -/** Information about each parameter | - */ | +/// Listings package parameter information. | +// FIXME: make this class visible outside of this file so that | +// FIXME: it can be used directly in the frontend and in the LyX format | +// FIXME: parsing. | class ListingsParam { | public: | - /// | - ListingsParam(): onoff_(false), type_(ALL) {} | - /// | - ListingsParam(string v, bool o, param_type t, string i, docstring h) | + /// Default ctor for STL containers. | + ListingsParam(): onoff_(false), type_(ALL) | + {} | + /// Main ctor. Why is one ctor more main than the other? And very possibly the documetatin for the args should be here as well... /** Main ctor * \param v something * \param o This controlls on-off, true means xxx, false mean yyy. * \param t * \param i * \param h */ Btw. did I say that these names of args has something to be desired? | + ListingsParam(string const & v, bool o, param_type t, | + string const & i, docstring const & h) | : value_(v), onoff_(o), type_(t), info_(i), hint_(h) | {} | - /// | + /// Validate a paramater. | + /// \retval an empty string if \c par is valid. | + /// \retval otherwise an explanation WRT to \c par invalidity. | docstring validate(string const & par) const; Are multiline comments usgin '//' really nice? I'd say that /* */ is better suited for multiline comments. -- Lgb
