|  Home |  Back |  Contents |  Next | 
|  
/**
    This is a javadoc style comment.
    <pre>
        <b>Here is some HTML markup.</b>
        <p/>
        Here is some more.
    </pre>
    @author Pat Niemeyer
*/
 | 
| java bsh.Interpreter bshdoc.bsh myfile.bsh [ myfile2.bsh ] [ ... ] > output.xml | 
| <!-- This file was auto-generated by the bshdoc.bsh script -->
<BshDoc>
  <File>
    <Name>foo</Name>
    <Method>
      <Name>doFoo</Name>
      <Sig>doFoo ( int x )</Sig>
      <Comment>
        <Text><![CDATA[ doFoo() method comment. ]]></Text>
        <Tags>
        </Tags>
      </Comment>
    </Method>
    <Comment>
        <Text><![CDATA[ foo file comment. ]]></Text>
        <Tags>
        </Tags>
    </Comment>
  </File>
</BshDoc> | 
| 
/**
    BshDoc for the foo() command.
    Explicitly supply the signature to be displayed for the foo() method.
    @method foo( int | Integer ) and other text...
*/
foo( arg ) { ... }
 | 
| Tip: BshDoc uses the bsh.Parser API to parse the BeanShell script files without actually running them. bshdoc.bsh is not very complex. Take a look at it to learn how to use the parser API. | 
|  Home |  Back |  Contents |  Next |