Software: Apache/2.2.3 (CentOS). PHP/5.1.6 

uname -a: Linux mx-ll-110-164-51-230.static.3bb.co.th 2.6.18-194.el5PAE #1 SMP Fri Apr 2 15:37:44
EDT 2010 i686 

uid=48(apache) gid=48(apache) groups=48(apache) 

Safe-mode: OFF (not secure)

/usr/bin/   drwxr-xr-x
Free 52.23 GB of 127.8 GB (40.86%)
                            Encoder    Tools    Proc.    FTP brute    Sec.    SQL    PHP-code    Update    Feedback    Self remove    Logout    

Viewing file:     bshdoc (4.45 KB)      -rwxr-xr-x

bshdoc reads a javadoc style comment and method signatures from one or more files and generates XML output representing their contents. An XSL stylesheet bshcommands.xsl (supplied with the user manual source) can be used to render this to an indexed HTML page describing the commands.

Method signatures may be supplied expliticly via javadoc style @method tags in the comment. For example you might do this to provide a more verbose description for loosely typed arguments. The bshcommands.xsl stylesheet supplied with the user manual source will use the tag signatures in lieu of autogenerated ones when they are present. So you can use this tag to determine exactly which methods from a file are listed if you wish.

Output goes to standard out. Comments may include normal HTML tags. Javadoc style @tags are only recognized at the start of a line and terminate the comment.

Note: bshdoc generates full method and comment information for the file but bshdoc.xsl uses only file comments and method signatures to create the command index.

The bshdoc command requires Java 1.4 for regular expressions.

@method void bshdoc( String filename, String text ) @method void bshdoc( String [] filenames ) */ import bsh.*; import java.util.regex.*; // The ASTs are not currently public. We'll probably move them to another // package soon to do that. setAccessibility(true); // Trivial support for formatting the XML tabs=0; tab() { super.tabs++; } untab() { super.tabs--; } print( arg ) { for(int i=0; i"); Matcher matcher = commentTextPattern.matcher( text ); if ( matcher.find() ) print(""); print(""); Matcher matcher = tagsPattern.matcher( text ); while ( matcher.find() ) { this.tagname=matcher.group(1); this.tagvalue=matcher.group(2); print("<"+tagname+">"+ tagvalue +""); } print(""); print(""); } /** bshdoc file comment. */ bshdoc( filename ) { print(""); tab(); if ( filename.endsWith(".bsh") ) this.name=filename.substring(0,filename.length()-4); if ( (i=name.lastIndexOf("/")) != -1 ) this.name=name.substring(i+1); print(""+name+""); this.parser = new Parser( new FileReader(filename) ); parser.setRetainComments(true); this.lastNode = null; this.firstComment = null; while( !parser.Line() ) { this.node = parser.popNode(); if ( node instanceof BSHFormalComment && firstComment == null ) firstComment = node; if ( node instanceof BSHMethodDeclaration ) { this.sig=node.getText(); int i=sig.indexOf('{'); if ( i > -1 ) sig=sig.substring(0,i); print(""); tab(); print(""+node.name+""); print(""+sig+""); if ( lastNode instanceof BSHFormalComment ) { printComment( lastNode.text ); if ( firstComment == lastNode ) firstComment = null; } untab(); print(""); } lastNode = node; } if ( firstComment != null ) { tab(); printComment(firstComment.text); untab(); } untab(); print(""); } /** bshdoc list comment. */ bshdoc( String [] filenames ) { print(""); print(""); print(""); print(""); tab(); for( int i=0; i"); } list=bsh.args; if ( list.length == 0 ) { print("usage: bshdoc file [ file ] [ ... ]"); return; } bshdoc( list );