You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by ar...@locus.apache.org on 2000/02/12 02:27:20 UTC

cvs commit: xml-xerces/c/src/sax SAXParseException.hpp InputSource.hpp HandlerBase.hpp ErrorHandler.hpp EntityResolver.hpp DTDHandler.hpp DocumentHandler.hpp AttributeList.hpp

aruna1      00/02/11 17:27:20

  Modified:    c/src/sax SAXParseException.hpp InputSource.hpp
                        HandlerBase.hpp ErrorHandler.hpp EntityResolver.hpp
                        DTDHandler.hpp DocumentHandler.hpp
                        AttributeList.hpp
  Log:
  Documentation updated
  
  Revision  Changes    Path
  1.4       +10 -7     xml-xerces/c/src/sax/SAXParseException.hpp
  
  Index: SAXParseException.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/SAXParseException.hpp,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- SAXParseException.hpp	2000/02/09 19:24:49	1.3
  +++ SAXParseException.hpp	2000/02/12 01:27:19	1.4
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: SAXParseException.hpp,v $
  + * Revision 1.4  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.3  2000/02/09 19:24:49  abagchi
    * Inserted documentation for constructors and destructors
    *
  @@ -210,17 +213,17 @@
       //@}
   
   private:
  -    /** @name Data Members */
  -    //@{
  -    /** The column in the source text where the error occured. */
  +    /* Data Members */
  +    
  +    /* The column in the source text where the error occured. */
       unsigned int    fColumnNumber;
  -    /** The line in the source text where the error occured. */
  +    /* The line in the source text where the error occured. */
       unsigned int    fLineNumber;
  -    /** The public id of the file where the error occured. */
  +    /* The public id of the file where the error occured. */
       XMLCh*          fPublicId;
  -    /** The system id of the file where the error occured. */
  +    /* The system id of the file where the error occured. */
       XMLCh*          fSystemId;
  -    //@}
  +    
   
   };
   
  
  
  
  1.5       +32 -0     xml-xerces/c/src/sax/InputSource.hpp
  
  Index: InputSource.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/InputSource.hpp,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- InputSource.hpp	2000/02/09 02:15:28	1.4
  +++ InputSource.hpp	2000/02/12 01:27:19	1.5
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: InputSource.hpp,v $
  + * Revision 1.5  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.4  2000/02/09 02:15:28  abagchi
    * Documented destructor
    *
  @@ -111,6 +114,9 @@
     * around beyond the call.</p>
     *
     * $Log: InputSource.hpp,v $
  +  * Revision 1.5  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.4  2000/02/09 02:15:28  abagchi
     * Documented destructor
     *
  @@ -257,19 +263,45 @@
       // -----------------------------------------------------------------------
       //  Hidden constructors
       // -----------------------------------------------------------------------
  +    /** @name Constructors and Destructor */
  +    //@{
  +    /** Default constructor */
       InputSource();
  +
  +    /** Constructor with a system identifier as XMLCh type.
  +    * @param systemId The system identifier (URI).
  +    */
       InputSource(const XMLCh* const systemId);
  +
  +    /** Constructor with a system and public identifiers 
  +    * @param systemId The system identifier (URI).
  +    * @param publicId The public identifier as in the entity definition.
  +    */
       InputSource
       (
           const   XMLCh* const    systemId
           , const XMLCh* const    publicId
       );
  +    
  +    /** Constructor witha system identifier as string 
  +    * @param systemId The system identifier (URI).
  +    */
       InputSource(const char* const systemId);
  +    
  +    /** Constructor witha system and public identifiers. Both as string 
  +    * @param systemId The system identifier (URI).
  +    * @param publicId The public identifier as in the entity definition.
  +    */
       InputSource
       (
           const   char* const systemId
           , const char* const publicId
       );
  +    
  +    //@}
  +
  +
  +    
   
   
   private:
  
  
  
  1.3       +21 -0     xml-xerces/c/src/sax/HandlerBase.hpp
  
  Index: HandlerBase.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/HandlerBase.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- HandlerBase.hpp	2000/02/06 07:47:57	1.2
  +++ HandlerBase.hpp	2000/02/12 01:27:19	1.3
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: HandlerBase.hpp,v $
  + * Revision 1.3  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.2  2000/02/06 07:47:57  rahulj
    * Year 2K copyright swat.
    *
  @@ -95,6 +98,9 @@
     * <p>Note that the use of this class is optional.</p>
     *
     * $Log: HandlerBase.hpp,v $
  +  * Revision 1.3  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.2  2000/02/06 07:47:57  rahulj
     * Year 2K copyright swat.
     *
  @@ -210,6 +216,11 @@
           , const XMLCh* const    data
       );
   
  +    /**
  +    * Reset the Docuemnt object on its reuse
  +    *
  +    * @see DocumentHandler#resetDocument
  +    */
       virtual void resetDocument();
       //@}
   
  @@ -348,6 +359,11 @@
       */
       virtual void warning(const SAXParseException& exception);
   
  +    /**
  +    * Reset the Error handler object on its reuse
  +    *
  +    * @see ErrorHandler#resetErrors
  +    */
       virtual void resetErrors();
   
       //@}
  @@ -376,6 +392,11 @@
           , const XMLCh* const    systemId
       );
   
  +    /**
  +    * Reset the DTD object on its reuse
  +    *
  +    * @see DTDHandler#resetDocType
  +    */
       virtual void resetDocType();
   
     /**
  
  
  
  1.3       +21 -5     xml-xerces/c/src/sax/ErrorHandler.hpp
  
  Index: ErrorHandler.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/ErrorHandler.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- ErrorHandler.hpp	2000/02/06 07:47:57	1.2
  +++ ErrorHandler.hpp	2000/02/12 01:27:19	1.3
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: ErrorHandler.hpp,v $
  + * Revision 1.3  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.2  2000/02/06 07:47:57  rahulj
    * Year 2K copyright swat.
    *
  @@ -97,6 +100,9 @@
     * itself.</p>
     *
     * $Log: ErrorHandler.hpp,v $
  +  * Revision 1.3  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.2  2000/02/06 07:47:57  rahulj
     * Year 2K copyright swat.
     *
  @@ -193,18 +199,28 @@
       * @see SAXParseException#SAXParseException
       */
       virtual void fatalError(const SAXParseException& exception) = 0;
  +    
  +    /**
  +    * Reset the Error handler object on its reuse
  +    *
  +    * <p>This method helps in reseting the Error handler object
  +    * implementational defaults each time the Error handler is begun.</p>
  +    *
  +    */
  +    virtual void resetErrors() = 0;
  +
   
       //@}
   
   private :
  -    /** @name Unimplemented constructors and operators */
  -    //@{
  -    /** Copy constructor */
  +    /* Unimplemented constructors and operators */
  +    
  +    /* Copy constructor */
       ErrorHandler(const ErrorHandler&);
   
  -    /** Assignment operator */
  +    /* Assignment operator */
       void operator=(const ErrorHandler&);
  -    //@}
  +    
   };
   
   #endif
  
  
  
  1.3       +10 -6     xml-xerces/c/src/sax/EntityResolver.hpp
  
  Index: EntityResolver.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/EntityResolver.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- EntityResolver.hpp	2000/02/06 07:47:57	1.2
  +++ EntityResolver.hpp	2000/02/12 01:27:19	1.3
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: EntityResolver.hpp,v $
  + * Revision 1.3  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.2  2000/02/06 07:47:57  rahulj
    * Year 2K copyright swat.
    *
  @@ -127,6 +130,9 @@
     * that the parser use the default system identifier).</p>
     *
     * $Log: EntityResolver.hpp,v $
  +  * Revision 1.3  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.2  2000/02/06 07:47:57  rahulj
     * Year 2K copyright swat.
     *
  @@ -204,17 +210,15 @@
       //@}
   
   private :
  -    /** Unimplemented constructors and operators */
  +    /* Unimplemented constructors and operators */
   
  -    //@{
  -
  -    /** Copy constructor */
  +    
  +    /* Copy constructor */
       EntityResolver(const EntityResolver&);
   
  -    /** Assignment operator */
  +    /* Assignment operator */
       void operator=(const EntityResolver&);
   
  -    //@}
   };
   
   #endif
  
  
  
  1.3       +18 -5     xml-xerces/c/src/sax/DTDHandler.hpp
  
  Index: DTDHandler.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/DTDHandler.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- DTDHandler.hpp	2000/02/06 07:47:57	1.2
  +++ DTDHandler.hpp	2000/02/12 01:27:19	1.3
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: DTDHandler.hpp,v $
  + * Revision 1.3  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.2  2000/02/06 07:47:57  rahulj
    * Year 2K copyright swat.
    *
  @@ -98,6 +101,9 @@
     * of this interface, which simply ignores the events.</p>
     *
     * $Log: DTDHandler.hpp,v $
  +  * Revision 1.3  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.2  2000/02/06 07:47:57  rahulj
     * Year 2K copyright swat.
     *
  @@ -187,19 +193,26 @@
           , const XMLCh* const    notationName
       ) = 0;
   
  +    /**
  +    * Reset the DocType object on its reuse
  +    *
  +    * <p>This method helps in reseting the DTD object implementational
  +    * defaults each time the DTD is begun.</p>
  +    *
  +    */
       virtual void resetDocType() = 0;
   
       //@}
   
   private :
  -    /** @name Unimplemented constructors and operators */
  -    //@{
  -    /** Copy constructor */
  +    /* Unimplemented constructors and operators */
  +    
  +    /* Copy constructor */
       DTDHandler(const DTDHandler&);
   
  -    /** Assignment operator */
  +    /* Assignment operator */
       void operator=(const DTDHandler&);
  -    //@}
  +    
   };
   
   #endif
  
  
  
  1.3       +15 -4     xml-xerces/c/src/sax/DocumentHandler.hpp
  
  Index: DocumentHandler.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/DocumentHandler.hpp,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- DocumentHandler.hpp	2000/02/06 07:47:57	1.2
  +++ DocumentHandler.hpp	2000/02/12 01:27:19	1.3
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: DocumentHandler.hpp,v $
  + * Revision 1.3  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.2  2000/02/06 07:47:57  rahulj
    * Year 2K copyright swat.
    *
  @@ -100,6 +103,9 @@
     * supplied by the Parser through the setDocumentLocator method.</p>
     *
     * $Log: DocumentHandler.hpp,v $
  +  * Revision 1.3  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.2  2000/02/06 07:47:57  rahulj
     * Year 2K copyright swat.
     *
  @@ -246,6 +252,13 @@
           , const XMLCh* const    data
       ) = 0;
   
  +    /**
  +    * Reset the Docuemnt object on its reuse
  +    *
  +    * <p>This method helps in reseting the document implementational
  +    * defaults each time the document is begun.</p>
  +    *
  +    */
       virtual void resetDocument() = 0;
   
     /**
  @@ -319,13 +332,11 @@
       //@}
   
   private :
  -    /** @name Unimplemented Constructors and operators */
  -    //@{
  -    /** Copy constructor */
  +    /* Unimplemented Constructors and operators */
  +    /* Copy constructor */
       DocumentHandler(const DocumentHandler&);
       /** Assignment operator */
       void operator=(const DocumentHandler&);
  -    //@}
   };
   
   #endif
  
  
  
  1.5       +10 -5     xml-xerces/c/src/sax/AttributeList.hpp
  
  Index: AttributeList.hpp
  ===================================================================
  RCS file: /home/cvs/xml-xerces/c/src/sax/AttributeList.hpp,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- AttributeList.hpp	2000/02/09 02:12:21	1.4
  +++ AttributeList.hpp	2000/02/12 01:27:19	1.5
  @@ -56,6 +56,9 @@
   
   /**
    * $Log: AttributeList.hpp,v $
  + * Revision 1.5  2000/02/12 01:27:19  aruna1
  + * Documentation updated
  + *
    * Revision 1.4  2000/02/09 02:12:21  abagchi
    * Added getValue docs
    *
  @@ -127,6 +130,9 @@
     * implementation for use by parser or application writers.
     *
     * $Log: AttributeList.hpp,v $
  +  * Revision 1.5  2000/02/12 01:27:19  aruna1
  +  * Documentation updated
  +  *
     * Revision 1.4  2000/02/09 02:12:21  abagchi
     * Added getValue docs
     *
  @@ -289,13 +295,12 @@
       //@}
   
   private :
  -    /** @name Constructors and operators */
  -    //@{
  -    /** Copy constructor */
  +    /* Constructors and operators */
  +    /* Copy constructor */
       AttributeList(const AttributeList&);
  -    /** Assignment operator */
  +    /* Assignment operator */
       void operator=(const AttributeList&);
  -    //@}
  +    
   };
   
   #endif