[vtk-developers] Hinting proposal

[Michael Halle]

Since VTK already uses simpler text-style comment directives (//BTX, 
etc.), perhaps you could just choose something like (choose your combo):

// PRAGMA:NewReference
or
// HINT:NewReference
or
or an extended version:
// HINT:NewReference=true,ReturnElementCount=3

(names could also be VTK_PRAGMA or VTK_HINT).

On first glance, I find the HTML comment style to be confusing, because 
it's only ever seen in HTML, not in C++ code or plain text.  It's also 
not especially pretty. :)  Perhaps it has an advantage I'm not seeing....

--Mike


On 04/27/2011 04:15 PM, David Gobbi wrote:
> As a follow up to the recent discussion on wrapping factory methods,
> I'd like to put forth a proposal for adding wrapping hints to VTK:
> Hints could be placed inside the method descriptions, as html-style
> comments:
>
> // Description:
> // Return a new object instance.
> //<!--- hint newref='true' -->
> vtkObjectBase *NewInstance();
>
> Size hints could replace the hints file currently used by the wrappers.
> I'm also keen to provide size hints for operator[] methods, since
> these operators cannot be properly wrapped in python until there
> is a hint to tell python what method to call to get the index range.
>
>   - David
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>