Re: [E-devel] Usage of @ref on docs

[Carsten H. (T. R. <ra...@ra...>]

On Fri, 29 Jun 2012 16:29:36 -0300 Bruno Dilly <bd...@pr...> said:

> Hi,
> 
> I've just applied Daniel's fix on elm docs, and I saw that he found a
> function with a wrong name, somethings like elm_elm_function instead
> of elm_function. Also, probably, a lot of things will be broken when
> we remove deprecated functions, since people don't use to update docs.
> 
> What do you think of using @ref on all of the documentation bodies
> (@see already warns if it's not a valid function).
> I'm using that on ephysics, maybe we should adopt for all the projects.
> 
> Thoughts ?

you mean
  @ref elm_function()
as opposed to:
  elm_function()

ie to force doxygen warnings if the ref cant be found? :)

-- 
------------- Codito, ergo sum - "I code, therefore I am" --------------
The Rasterman (Carsten Haitzler)    ra...@ra...