[C++-sig] adding a doc_string to the overloaded functions

Naceur Meskini Naceur.Meskini at sophia.inria.fr
Fri May 19 09:48:10 CEST 2006


Ralf W. Grosse-Kunstleve wrote:

>--- Naceur Meskini <Naceur.Meskini at sophia.inria.fr> wrote:
>
>  
>
>>Perhaps Someone of you had already encountered this probleme,
>>How can I add a doc_string to the overloaded functions when we expose 
>>them, example I have this function:
>>
>>const char* nearest_vertex_doc = "the doc of my function"
>>
>>.def("nearest_vertex", &Triangulation_3::nearest_vertex,
>>nearest_vertex_overloads_1_2())
>>    
>>
>
>This should work:
>
>.def("nearest_vertex", &Triangulation_3::nearest_vertex,
>nearest_vertex_overloads_1_2(nearest_vertex_doc))
>
>I think the docstring only shows up for one overload.
>  
>
Thank you Ralf it works very well.


------------------------
Naceur
INRIA Sophia Antipolis



More information about the Cplusplus-sig mailing list