Changeset 632 for trunk/idldoc/src/doc_system__define.pro

Timestamp:

02/26/10 13:14:41 (2 years ago)

Author:

mgalloy

Message:

Added author, copyright, history, and version tags for overview file in rst and IDLdoc formats.

Files:

• trunk/idldoc/src/doc_system__define.pro (modified) (10 diffs)

trunk/idldoc/src/doc_system__define.pro

@@ -79 +79 @@
     'system': return, self
     
-    'idldoc_version': return, self.version
+    'idldoc_version': return, self.idldoc_version
     'charset': return, self.charset
     'date': return, systime()
@@ -99 +99 @@
     'output_root': return, self.output
     'relative_root': return, ''
+
+    'has_author_info': return, self.hasAuthorInfo
+    
+    'has_author': return, obj_valid(self.author)
+    'author': return, self->processComments(self.author)
+    'plain_author': return, self->processPlainComments(self.author)
+
+    'has_copyright': return, obj_valid(self.copyright)
+    'copyright': return, self->processComments(self.copyright)
+    
+    'has_history': return, obj_valid(self.history)
+    'history': return, self->processComments(self.history)
+
+    'has_version': return, obj_valid(self.version)
+    'version': return, self->processComments(self.version)
         
     'n_dirs': return, self.directories->count()
@@ -292 +307 @@
 ; Set properties of the system.
 ;-
-pro doc_system::setProperty, overview_comments=overviewComments
+pro doc_system::setProperty, overview_comments=overviewComments, $
+                             author=author, copyright=copyright, $
+                             history=history, version=version
   compile_opt strictarr, hidden
 
@@ -298 +315 @@
     self.overviewComments = overviewComments
   endif
+  
+  ; "author info" attributes
+  if (n_elements(author) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.author = author
+  endif
+
+  if (n_elements(copyright) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.copyright = copyright
+  endif
+  
+  if (n_elements(history) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.history = history
+  endif
+
+  if (n_elements(version) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.version = version
+  endif  
 end
 
@@ -377 +415 @@
   compile_opt strictarr, hidden
   
-  msg = ['IDLdoc ' + self.version, $
+  msg = ['IDLdoc ' + self.idldoc_version, $
          '', $
          'Usage:', $
@@ -1158 +1196 @@
   if (nCategories gt 0) then obj_destroy, categoryLists
   obj_destroy, self.categories
-  
+
+  obj_destroy, [self.author, self.copyright, self.history, self.version]
+    
   obj_destroy, self.overviewComments
   
@@ -1273 +1313 @@
   compile_opt strictarr, hidden
   
-  self.version = idldoc_version()
+  self.idldoc_version = idldoc_version()
   
   self.isTty = keyword_set(colorOutputlog) ? 1B : self->_findIfTty()
   
   if (keyword_set(version)) then begin
-    self->print, 'IDLdoc ' + self.version
+    self->print, 'IDLdoc ' + self.idldoc_version
     return, 0
   endif
@@ -1467 +1507 @@
 ;
 ; :Fields:
-;    version
+;    idldoc_version
 ;       IDLdoc version
 ;    root 
@@ -1528 +1568 @@
   
   define = { DOC_System, $
-             version: '', $
+             idldoc_version: '', $
              
              root: '', $
@@ -1539 +1579 @@
              
              sourceLocation: '', $
-             
+
+             hasAuthorInfo: 0B, $
+             author: obj_new(), $
+             copyright: obj_new(), $
+             history: obj_new(), $
+             version: obj_new(), $
+                          
              directories: obj_new(), $