using doxygen

[Angus Leeming]

What's the doxygen way of saying Dialog::hide? Ie, is there 
an @method identifier or something?

        /** Invoked by Dialog::hide, allowing the Controller to
         *  clean up its data structures.
         */
        virtual void clearParams() = 0;

Angus (attempting to make this stuff comprehensible).

class Dialog::Controller : boost::noncopyable {
public:
        Controller(Dialog & parent) : parent_(parent) {}
        virtual ~Controller() {}
        //@{
        /** These few methods are all that a generic dialog needs of a
         *  controller.
         */
        /** @param data The controller is passed a string encoding of the
         *  parameters that the dialog is to display.
         *  @return true if the translation was successful.
         */
        virtual bool initialiseParams(string const & data) = 0;
        /** Invoked when the dialog is hidden, allowing the controller to
         *  clean up its data structures.
         */
        virtual void clearParams() = 0;
        ///
        virtual void dispatchParams() = 0;