Re: [Doxygen-users] Linking to function pointer arguments

[Dimitri v. H. <do...@gm...>]

Hi Peter,

I'd say that '@see Functor(void(*)(void))' is the one that should have worked,
but I see it doesn't. Feel free to submit a bug report for this.

A workaround (that also helps a bit with readability IMHO):

/** A functor
 *  @see Functor() or Functor(Function)
 */
class Functor
{
  public:
    /** A typedef */
    typedef void(*Function)(void);

    /** Creates a functor object */
    Functor();

    /** Overloaded constructor taking a function pointer as argument */
    Functor(Function function);
};

Regards,
  Dimitri

> On 29 Jul 2015, at 1:44 , Barnes, Peter D. <bar...@ll...> wrote:
> 
> Hello Folks,
> 
> I want to link to an overloaded function with this signature:
> 
> 
> Functor(void(*function)(void));
> 
> Because Functor is overloaded, I have to give the full signature, but I can’t figure out how doxygen wants it expressed.  I’ve tried all of these:
> 
>  @see Functor(*)
>  @see Functor((*))
>  @see Functor(*())
>  @see Functor((*)())
>  @see Functor(void*)
>  @see Functor(void(*))
>  @see Functor(void*())
>  @see Functor(void(*)())
>  @see Functor(void*(void))
>  @see Functor(void(*)(void))
> 
> But none of them work.
> 
> Any ideas?
> 
> Thanks,
> Peter
> _______________________________________________________________________
> Dr. Peter D. Barnes, Jr.                Physics Division
> Lawrence Livermore National Laboratory  Physical and Life Sciences
> 7000 East Avenue, L-50                  email:  pdb...@ll...
> P. O. Box 808                           Voice:  (925) 422-3384
> Livermore, California 94550             Fax:    (925) 423-3371
> 
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users