Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4640750
Votes 0
Synopsis Indent is lacking in bulleted exception items
Category customdoclets:mifdoclet
Reported Against 1.2beta1
Release Fixed 1.2beta2
State 10-Fix Delivered, bug
Priority: 3-Medium
Related Bugs
Submit Date 21-FEB-2002
Description
Would you please add two indented bulleted styles for members
and one for classes?  [Added 3/5/ customer    xxxxx@xxxxx  ]

There is a lack of indentation of bulleted exception items that appear
beneath the exception class name: 

Throws:
  SystemException - with the following reason code: 
* SystemException.ILLEGAL_VALUE if the bLength parameter is less than 5 or
   greater than 16. 
* SystemException.ILLEGAL_AID if the specified instance AID bytes are in use 
  or if the applet instance has previously successfully registered with the 
  JCRE via one of the register() methods or if a JCRE initiated install() method 
  execution is not in  customer . 

The standard doclet indents the bulleted list here, which makes it clear
that the items are "subordinate" to (in this case) SystemException. 

On the other hand, the MIF doclet doesn't indent here. See the example
under method register(byte[], short, byte) on page 39 of the attached
javacard.framework.fm [actually in 
/home/dkramer/javadoc/mifdoclet/1.2b2/bug-4640750-indent/javacard.framework.fm
rather than attached to this bug report]

What is apparantly needed is a new paragraph tag, possibly called
MemberBullet2 which would be indented more than MemberBullet. The MIF 
doclet could possibly identify when to use MemberBullet2 by looking at the 
markup tags in the Java source. This case could be identified by noting
a <ul> construct containing the listed exceptions occuring immediately 
following a @exception construct.

See the following markup that occurs in source code file: javacard.framework.Applet.java

This corresponds to the example on page 39 of the attached
javacard.framework.fm 


package javacard.framework;

abstract public class Applet
.
.
.
    protected final void register() throws SystemException


    /**
     * This method is used by the applet to register <code>this</code> applet instance...
     * [snip]
     * @param bArray the byte array containing the AID bytes.
     * @param bOffset the start of AID bytes in bArray.
     * @param bLength the length of the AID bytes in bArray.
     * @exception SystemException with the following reason code:<ul>
     * <li><code>SystemException.ILLEGAL_VALUE</code> if the <code>bLength</code> parameter is
     * less than <code>5</code> or greater than <code>16</code>.
     * <li><code>SystemException.ILLEGAL_AID</code> if the specified instance AID bytes are in use
     * or if the applet instance has previously successfully registered with the JCRE via one of 
     * the <code>register()</code> methods or if a JCRE initiated <code>install()</code> method
     * execution is not in  customer .
     * </ul>
     * @see #install(byte[],short,byte)
     */
Work Around
N/A
Evaluation
Yes, I agree we should add a new bullet style.   I suggest calling it
MemberBulletIndent or MemberSubBullet, or MemberBulletSub, as it is 
for bullets corresponding to subheads.
(The conventions for numbers have other meanings: 1 and 2 are meant 
for "first" and "subsequent".)
  xxxxx@xxxxx   2002-02-20

I'd prefer not to clutter the style menu with unneeded styles.  
I created these three levels:

  MemberBullet
    MemberBulletSub
       MemberBulletSubSub

I also created a new style for class bullets:

  ClassBullet
     ClassBulletSub

I know the naming is wierd, but numbers in other
styles mean 1st and 2nd in a series at the same indent level, 
not nesting, so I'd prefer not to overload those meanings.  
Also, these are subordinate bullets, just like 
headings have subheads.  

I used "MemberBulletSub" rather than "MemberSubBullet"
so they would all sort together -- otherwise, the latter
would fall after MemberHead.

  xxxxx@xxxxx   2002-03-04

Added to stylemap.properties:

MemberTextBulletSub    "MemberBulletSub"     # Indented bullets in member
MemberTextBulletSubSub "MemberBulletSubSub"  # Double-indented bullets in member 

ClassTextBulletSub     "ClassBulletSub"      # Indented bullets in class   

  xxxxx@xxxxx   2002-03-05

This bug has been fixed.  The correct styles are now applied to indented bullets.  Location of fix:

HtmlToMIF.java
  xxxxx@xxxxx   2002-03-09

  xxxxx@xxxxx   improved the fix to insert MemberBulletSub for the first bullet
in the text of @throws.
  xxxxx@xxxxx   2002-03-10
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang