[wx-dev] Re: Ok() and IsOk()

Bill Baxter wbaxter at gmail.com
Thu Oct 5 10:22:47 PDT 2006


On 10/6/06, Francesco Montorsi <f18m_cpp217828 at yahoo.it> wrote:
> Bill Baxter ha scritto:
> > On 10/5/06, Francesco Montorsi

> > What's wrong with some classes having only IsOK, and some having both,
> > with all Ok()'s having no docstrings but regular comments that
> > indicate they are deprecated.
> I'm not sure what you mean by regular comments but my patch (or more
> precisely "script") changes all Ok() occurrences in docs with IsOk().
> So that Ok() functions are not documented anymore.

I mean just something like:

     // This method is deprecated.  Use IsOk instead
     bool Ok() const;

So that someone looking at the header for info about the class can
tell that's not the right method.  With no comment it would look to me
like an equivalent to IsOk that someone just forgot to document.

--bb




More information about the wx-dev mailing list