Re: [Htmlparser-developer] toPlainTextString() feedback requested

[Sam J. <ga...@yh...>]

Hi,

I realise that unless I get specific on the issue of documentation I am 
unlikely to be taken seriously

http://htmlparser.sourceforge.net/javadoc/org/htmlparser/tags/HTMLTag.html

is from the java docs  - here are some javadoc comments

Hashtable getParsed()
          "Gets the parsed"
static java.util.Vector getStrictTags()
          "Gets the strictTags"
 java.lang.String getTagLine()
          "Returns the tagLine"
 java.lang.String getTagName()
            ""

Personally I would like to see a good couple of lines of text for each 
of these.  Some are more important than others.  I mean getTagName might 
seem self explanatory, but I would like to see more, e.g.

Hashtable getParsed()
          "Gets a hashtable of attribute-value pairs from the html tag, 
e.g. type-->hidden, name-->address, value-->default"
static java.util.Vector getStrictTags()
          "<not sure what strict tags are, would be nice if there was a 
description>"
 java.lang.String getTagLine()
          "Returns the line from the document that this tag was found on?"
 java.lang.String getTagName()
            "get the name of the tag itself, e.g. BODY, TR, TABLE etc."

Personally I found the lack of javadocs on getParsed() particularly 
frustrating.  I had to go into the code in some depth to find out what 
it was, and that it was the thing I needed.  Naturally the beauty of 
open source is that I can actually do that.  But I would have preferred 
to have discovered the information I needed from the javadocs.  And I 
would prefer as a *user* that you would expend your efforts updating the 
documentation on the existing code base rather than refactoring.  

CHEERS> SAM


Sam Joseph wrote:

> Somik replied to my issues about documentation saying that he had been 
> working on it and asking me to point out other places where the 
> documentation could be improved.  I don't have time right now to go 
> through and make those points,