| Inheriting Properties (or something similar) in IDLDOC [message #80787] |
Mon, 09 July 2012 17:05  |
Matt Francis
Messages: 94
Registered: May 2010
|
Member |
|
|
I've just started a project of re-commenting a large IDL code into
IDLDOC format and moving some external text file documentation into
those comments.
One issue I have is that the code uses IDL custom object, and in
particular inheritance, extensively. I would like the documentation
for derived classes to inherit appropriate info from the parent class
documentation.
In particular, the functionality of a lot of the object functions,
such as threshold levels and other parameters and switches are
controlled by config files. A base class may have some behaviour
controlled by some 'tag' in a config file and a derived class may be
controlled by additional tags. I would like a way to summarise all of
the config file tags that control an object (i.e. are looked at by any
of the objects functions) and then have derived classes documentation
inherit the summary from the superclass.
Looking over the IDLDOC reference guide, I though perhaps
the :Properties: tag in the file comments might allow this. So I have
comments in the base class <obj_name>__define.pro file that look
something like this:
;+
; Abstract Base class for handling input data for mapping.
; Provides a common interface for different data sources.
;
; :Properties:
; data_type : property name
; The IDL data type to use for the data storage array pointed to
by self.data
; somthing_else :
; Some other property
;-
This produces a nice summary of 'properties' in the IDLDOC produced
docs. However, this does not show up the doc page for derived classes
(not that I was expected to, just hoping....).
Is there any way to achieve what I'm trying to do? For comparison the
way IDLDOC handles the actual class members is exactly the behaviour I
want, but for a 'user defined' set of properties of objects. Is this
possible?
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
