{5} Assigned, Active Tickets by Owner (Full Description) (22 matches)

List tickets assigned, group by ticket owner. This report demonstrates the use of full-row display.

mgalloy

Ticket Summary Component Milestone Type Created
Description
#46 Invalid ENTITY's in DocBook output when there are files in top directory output IDLdoc 3.2 defect 07/24/08

There are invalid ENTITY directives in the DocBook output when there are files in the top-level directory.

#1 Compute complexity statistics parsing IDLdoc 3.2 enhancement 12/21/07

McCabe complexity statistics (McCabe cyclic, McCabe essential, McCabe modular design) were computed in the IDLdoc 2.0 code base. This functionality should be added to the IDLdoc 3.0 code base, though possibly in a simplified manner (i.e. reporting just one number).

Also, there should be user-defined limits for marking a routine as "complex" on the warnings page.

References for more information about the McCabe complexity statistics:

#2 Advanced search output IDLdoc 3.2 enhancement 12/23/07

Add an advanced search on the search tab where criterion such as: categories, author, parameters, etc. can be specified separately.

#3 Properties should have a type core IDLdoc 3.2 enhancement 12/23/07

Suggested syntax: 

:Properties:
  propname : type=string
    name of the property

@property propname {type=string} name of the property
#4 Allow multiple copies of some tags parsing IDLdoc 3.2 enhancement 12/23/07

I'm not sure if all tags should be allowed to have multiple copies or just special tags. Restrictions and author are two that seem like they should allow multiple tags. The behavior here should probably be to append to the current value of the tag.

Other tags should give a warning if used twice, such as the boolean tags like abstract, obsolete, etc.

#5 Improve rst markup support parsing IDLdoc 3.2 enhancement 12/25/07

The rst markup was only partly implemented for IDLdoc 3.0. Missing markup that should be implemented:

  • lists (numbered, bulleted, and definition)
  • emphasis and bold
  • inline code
  • links: single word and phrase links (HTML and internal links)
  • images

There is other markup that is not as important for header documentation that could also be implemented for a separate ticket later.
#6 Improve source code chromocoding output IDLdoc 3.2 enhancement 12/25/07

The chromocoding for the source code link should style:

  • highlight headers (pro/function routine_name and parameters)
  • literal strings
#8 Add runtime warnings to the warnings page core IDLdoc 3.2 enhancement 12/25/07

Anything going to doc_system::warning should be remembered and set to a "Runtime warnings" section during output.

#9 In the IDL format, attach aspects of a file level comment to the last routine core IDLdoc 3.2 enhancement 12/25/07

Inputs and outputs, return value, etc. for a file level comment before any routine should be associated with the last routine in the file.

This is an attempt to parse/output more of the comments for code in the lib directory of the IDL distribution.

#11 Create a "man page" front end for IDLdoc core IDLdoc 3.2 enhancement 12/27/07

Create a "man page" front end for IDLdoc that, given an individual routine name, would output the documentation for that routine.

The syntax for it would be something like: 

  IDL> man, 'idldoc'
  /Users/mgalloy/projects/idldoc/trunk/idldoc/src/idldoc.pro

  idldoc, root=string [, output=string] [, /quiet] [, /silent] [, n_warnings=long] 
    [, log_file=string] [, /assistant] [, /embed] [, overview=string] [, footer=string] 
    [, title=string] [, subtitle=string] [, /nonavbar] [, /nosource] [, /user] [, /statistics] 
    [, format_style=string] [, markup_style=string] [, comment_style=string] 
    [, /preformat] [, /browse_routines] [, template_prefix=string] 
    [, template_location=string] [, charset=string] [, error=long] [, /help] [, /version]

  Generate documentation for IDL code. This is a wrapper routine for the doc_system 
  class; this routine only handles errors, saving/restoring !path, and creating the 
  doc_system object.

  etc...
#13 Allow multiple separate words in search output IDLdoc 3.2 enhancement 12/28/07

Currently, the search phrase is currently found "as a phrase" instead of as individual words (that might be in separate locations in the item). It would be better if items that had each word in the phrase, but not necessarily together, were also found.

#14 Create a set of more interactive templates output IDLdoc 3.2 enhancement 12/28/07

Routine descriptions could be expanded as needed. The syntax for each routine would be shown, but details would be shown if a phrase or icon was selected.

This should not be the default set of templates because of the reliance on Javascript.

#15 Improve "Customizing output" section of help project IDLdoc 3.2 enhancement 12/28/07

This section should include:

  • how to use the template object
  • what variables are available in which templates
  • how to use TEMPLATE_PREFIX and TEMPLATE_LOCATION
  • how to add another output type, creating an output class and using COMMENT_STYLE
#16 Create a DocBook set of templates output IDLdoc 3.2 enhancement 12/28/07

A DocBook set of templates would be useful for including in books. Use xinclude to create one large document from all the individual documents.

#26 Allow tabs in rst format markup parsing IDLdoc 3.2 enhancement 01/06/08

Tabs can be converted to an equivalent number of spaces. IDLdoc should have a keyword to specify the number of spaces for a tab.

#28 Directory level comments parsing IDLdoc 3.2 enhancement 01/07/08

There should be a mechanism to allow "directory level" comments. In version pre-3.0, a file named directory-overview in the directory contained the directory overview comments, but the feature was broken in several of the releases. Some file and routine level tags would make sense of the directory level, such as copyright, history, author.

#29 DLM documentation parsing IDLdoc 3.2 enhancement 01/07/08

There should be a mechanism for adding comments for a DLM. This should allow for output documentation that looks similar to normal IDL code (but marked as DLM, of course), documenting params, keywords, return values, etc.

#30 Support for doctests core IDLdoc 3.2 enhancement 01/10/08

Doctests are simple tests embedded in the documentation.

Inside a "tests" tag, any line that starts with "IDL> " would be executed and the output compared to the following line(s) that don't start with "IDL> ".

For example: 

;+
; Factorial function.
; 
; :Tests:
;    IDL> a = factorial(5)
;    IDL> print, a
;        120
;-

The commands in a single :Tests: tag should run in a single scope (so the a variable above is seen by the second command).

#31 Define overview style for IDL format parsing IDLdoc 3.2 enhancement 01/10/08

Overview files in the IDL format should look like: 

Overview comments.

DIRECTORIES:
  ./: Description goes here. This must be followed by a blank line.

  collection/: Description goes here. Note that the description can flow
               onto following lines. It is the blank line that delimits
               directories.
#7 Get unit tests working again project IDLdoc 3.2 task 12/25/07

It would be nice to get decent coverage of at least the underlying libraries:

  • templating,
  • textmarkup,
  • math,
  • collection, and
  • util packages.
#32 Optional indexing output IDLdoc 3.2 enhancement 01/13/08

It would be very useful if indexing was only performed on files, classes, and routines. For large code bases including parameters, fields, and keywords can make the index too large to be usable.

#37 Use IDL 7.0 icon for idldoc.ico output IDLdoc 3.2 enhancement 01/30/08

Let's use the new IDL 7.0 icon from the IDL resource/bitmaps directory for the IDLdoc icon.

Note: See TracReports for help on using and creating reports.