Abdelrazak Younes <[EMAIL PROTECTED]> writes: | Lars Gullik Bjønnes wrote: | > 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. | | I know and I was using that until someone told me that the LyX way is | to use FIXME. I could have bet this someone was you, not sure... | Sometimes when I have enough energy I put "\todo FIXME"...
But that is just stupid. We began using FIXME way before we began using doxygen. If we want to take advantage of doxygen we should use its ways (and change ours). And then it would be "\todo This fuction should not be public, this is something we should fix." (not "\todo FIXME ...." btw.) | Feel free to fix. | | > | + 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. | | I don't really care. And suddenly you showed me why I stay away from this list. -- Lgb