improved documentation in headers

parser/htmlparser/src/nsHTMLTokens.cpp

@@ -247,6 +247,28 @@ CHTMLToken::CHTMLToken(const nsString& aName) : CToken(aName) {
   mTagType=eHTMLTag_unknown;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+eHTMLTags CHTMLToken::GetHTMLTag() {
+  return mTagType;
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+void CHTMLToken::SetHTMLTag(eHTMLTags aTagType) {
+  mTagType=aTagType; 
+  return;
+}
 
 /**-------------------------------------------------------
  *  default constructor
@@ -272,6 +294,50 @@ eHTMLTags CStartToken::GetHTMLTag(){
   return mTagType;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CStartToken::GetClassName(void) {
+  return "start";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CStartToken::GetTokenType(void) {
+  return eToken_start;
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+void CStartToken::SetAttributed(PRBool aValue) {
+  mAttributed=aValue;
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRBool CStartToken::IsAttributed(void) {
+  return mAttributed;
+}
+
 /**-------------------------------------------------------
  *  Consume the identifier portion of the start tag
  *  
@@ -376,6 +442,27 @@ eHTMLTags CEndToken::GetHTMLTag(){
   return mTagType;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CEndToken::GetClassName(void) {
+  return "/end";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CEndToken::GetTokenType(void) {
+  return eToken_end;
+}
 
 /**-------------------------------------------------------
  *  Dump contents of this token to givne output stream
@@ -402,6 +489,28 @@ CTextToken::CTextToken(const nsString& aName) : CHTMLToken(aName) {
   mOrdinalValue=eToken_text;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CTextToken::GetClassName(void) {
+  return "text";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CTextToken::GetTokenType(void) {
+  return eToken_text;
+}
+
 /**-------------------------------------------------------
  *  Consume as much clear text from scanner as possible.
  *
@@ -483,11 +592,28 @@ PRInt32 CCommentToken::Consume(PRUnichar aChar, CScanner* aScanner) {
   return result;
 };
 
-const char* CCommentToken::GetClassName(void)
-{
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char* CCommentToken::GetClassName(void){
   return "/**/";
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CCommentToken::GetTokenType(void) {
+  return eToken_comment;
+}
+
 #ifdef TOKENIZE_CRLF
 /**-------------------------------------------------------
  *  default constructor
@@ -500,6 +626,28 @@ CNewlineToken::CNewlineToken(const nsString& aName) : CHTMLToken(aName) {
   mOrdinalValue=eToken_newline;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CNewlineToken::GetClassName(void) {
+  return "crlf";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CNewlineToken::GetTokenType(void) {
+  return eToken_newline;
+}
+
 /**-------------------------------------------------------
  *  Consume as many cr/lf pairs as you can find.
  *  
@@ -535,6 +683,28 @@ CAttributeToken::CAttributeToken(const nsString& aName) : CHTMLToken(aName),
   mOrdinalValue=eToken_attribute;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CAttributeToken::GetClassName(void) {
+  return "attr";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CAttributeToken::GetTokenType(void) {
+  return eToken_attribute;
+}
+
 /**-------------------------------------------------------
  *  Dump contents of this token to givne output stream
  *  
@@ -698,6 +868,28 @@ CWhitespaceToken::CWhitespaceToken(const nsString& aName) : CHTMLToken(aName) {
   mOrdinalValue=eToken_whitespace;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CWhitespaceToken::GetClassName(void) {
+  return "ws";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CWhitespaceToken::GetTokenType(void) {
+  return eToken_whitespace;
+}
+
 /**-------------------------------------------------------
  *  This general purpose method is used when you want to
  *  consume an aribrary sequence of whitespace. 
@@ -754,6 +946,28 @@ PRInt32 CEntityToken::Consume(PRUnichar aChar, CScanner* aScanner) {
   return result;
 };
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CEntityToken::GetClassName(void) {
+  return "&entity";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CEntityToken::GetTokenType(void) {
+  return eToken_entity;
+}
+
 /**-------------------------------------------------------
  *  This general purpose method is used when you want to
  *  consume an entity &xxxx;. Keep in mind that entities
@@ -919,6 +1133,50 @@ void CEntityToken::DebugDumpSource(ostream& out) {
   delete cp;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CScriptToken::GetClassName(void) {
+  return "script";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CScriptToken::GetTokenType(void) {
+  return eToken_script;
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CStyleToken::GetClassName(void) {
+  return "style";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CStyleToken::GetTokenType(void) {
+  return eToken_style;
+}
+
 
 /**-------------------------------------------------------
  *  default constructor
@@ -932,6 +1190,28 @@ CSkippedContentToken::CSkippedContentToken(const nsString& aName) : CAttributeTo
   mOrdinalValue=eToken_skippedcontent;
 }
 
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+const char*	CSkippedContentToken::GetClassName(void) {
+  return "skipped";
+}
+
+/**-------------------------------------------------------
+ *  
+ *  
+ *  @update  gess 3/25/98
+ *  @param   
+ *  @return  
+ *------------------------------------------------------*/
+PRInt32 CSkippedContentToken::GetTokenType(void) {
+  return eToken_skippedcontent;
+}
+
 /**-------------------------------------------------------
  *  Consume content until you find a sequence that matches
  *  this objects mTextValue.