[idldoc] restrictions tag missing

Françoise Pinsard Francoise.Pinsard at locean-ipsl.upmc.fr
Thu Dec 6 03:21:10 PST 2007


On Wed, December 5, 2007 4:59 pm, Michael Galloy wrote:
> On Dec 4, 2007, at 3:38 AM, Françoise Pinsard wrote:
>> We are working on idldoc upgrade. good news for us !
>> I noticed that "restrictions" tag is not anymore available in IDLdoc
>> set
>> of tags. some advice to replace it ?
>



> It should be there, you could send me an example of what's happening?

In fact the problem is more general than the one pointed above.
"restrictions" tag  is not available in file level comments. some for "todo"
, etc.
 so how can we introduce these type of informations in batch files as there
are no either FUNCTION ou PRO statement so no rouine level comments

for exemple :

;+
; module :
; test to point out the lack of restrictions or todo tag in file level
comments
;
;
; @restrictions
; use this only for test
;
; @todo
; add comments (ranges, usage, convention, etc)
;
;-

; here no pro, no function because it is a batch file launch with @

common geo lat,long
common compdate hour,min,sec

When I run idldoc 3.0b3 on the pb_batch.pro, I see
  Parsing pb_batch.pro...
% IDLDOC: unknown tag "restrictions" in file pb_batch.pro
% IDLDOC: unknown tag "todo" in file pb_batch.pro

We have many batch files of this type in our tool SAXO
(http://forge.ipsl.jussieu.fr/saxo) and it will great to be able to
provide a beautifull documentation !


-- 

Françoise Pinsard
LOCEAN - IPSL
UMR 7159 CNRS/IRD/UPMC/MNHN
Université Pierre et Marie Curie aile 45-55 5 étage pièce 516
Case 100 - 4 Place Jussieu  75252 Paris cedex 05
Tél. +33 1 44 27 47 65  Fax +33 1 44 27 71 59
mailto:Francoise.Pinsard at locean-ipsl.upmc.fr
http://www.locean-ipsl.upmc.fr/





More information about the idldoc mailing list