search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

@inherits compatibility issue - fix? #24

Closed mgalloy closed 12 years ago

mgalloy commented 12 years ago

I used the following to find and remove all lines with @inherits in them. This appears to be a safe option to deal with the resultant warnings. My understanding is that inheritance is automatically found from the IDL code now.

# in every *.pro file find lines with @inherits and delete them
find . -type f -name '*.pro' -exec sed -i '/@inherits/ D' {} \;
mgalloy commented 12 years ago

Yes, inheritance is handled automatically now as long as automatic structure definition is used to define the class instance variables. It should be able to handle multiple class definitions in a single file as well.

The find command is handy. But be careful of the case where the @inherits is spread across multiple lines. For example, some people comment in this style:

; @inherits
;   SomeClass1, SomeClass2

There was already a warning for @uses tag at the routine level, I added a warning at the file level in r433.

mgalloy commented 12 years ago

Author: anonymous Thanks for adding compatability comments ot ISSUES. I suggest that you add a comment there about @inherits (and other deprecated tags if there are any).

mgalloy commented 12 years ago

Fixed in r448, I added an item in ISSUES for the "inherits" tag and another for the ASSISTANT and PREFORMAT keywords that are obsoleted.