1.1 --- a/epoc32/include/xml/dom/xmlengoutputstream.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/xml/dom/xmlengoutputstream.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,64 +1,60 @@
     1.4 -/*
     1.5 -* Copyright (c) 2004-2005 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 -* All rights reserved.
     1.7 -* This component and the accompanying materials are made available
     1.8 -* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 -* which accompanies this distribution, and is available
    1.10 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 -*
    1.12 -* Initial Contributors:
    1.13 -* Nokia Corporation - initial contribution.
    1.14 -*
    1.15 -* Contributors:
    1.16 -*
    1.17 -* Description:       Interface class describing class that may be used as
    1.18 -*                 output stream for dom tree
    1.19 -*
    1.20 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
    1.21 +// All rights reserved.
    1.22 +// This component and the accompanying materials are made available
    1.23 +// under the terms of "Eclipse Public License v1.0"
    1.24 +// which accompanies this distribution, and is available
    1.25 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.26 +//
    1.27 +// Initial Contributors:
    1.28 +// Nokia Corporation - initial contribution.
    1.29 +//
    1.30 +// Contributors:
    1.31 +//
    1.32 +// Description:
    1.33 +// Interface class describing class that may be used as
    1.34 +// output stream for dom tree
    1.35 +//
    1.36 +
    1.37 +
    1.38 +
    1.39 +/**
    1.40 + @file
    1.41 + @publishedAll
    1.42 + @released
    1.43  */
    1.44 -
    1.45 -
    1.46 -
    1.47 -
    1.48 -
    1.49 -
    1.50 -
    1.51 -#ifndef XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
    1.52 -#define XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
    1.53 +#ifndef XMLENGMOUTPUTSTREAM_H
    1.54 +#define XMLENGMOUTPUTSTREAM_H
    1.55  
    1.56  #include <e32base.h>
    1.57  
    1.58  
    1.59  
    1.60  /**
    1.61 - * MXmlEngOutputStream is used by XML Engine to write serialized XML data
    1.62 - * to stream. This interface should be implemented by client application
    1.63 - * when RXmlEngDocument::SaveL() method is used to serialize xml data to stream.
    1.64 - *
    1.65 - * @lib XmlEngineDOM.lib
    1.66 - * @since S60 v3.1
    1.67 - */
    1.68 +Provides an interface for writing serialized XML data to a stream.  This
    1.69 +interface should be implemented by client applications when the
    1.70 +RXmlEngDocument::SaveL() method is used to serialize XML data to a stream.
    1.71 +
    1.72 +No ownership is transferred by RXmlEngDocument::SaveL(), thus an object
    1.73 +of the implementing class should be freed after use.
    1.74 +
    1.75 +@see RXmlEngDocument::SaveL()
    1.76 +*/
    1.77  class MXmlEngOutputStream
    1.78      {
    1.79  public:
    1.80      /**
    1.81 -     * Callback for writing a buffer with data to output stream
    1.82 -     *
    1.83 -     * @since S60 v3.1
    1.84 -     * @return number of bytes written or -1 in case of error
    1.85 -     */
    1.86 +	Writes the specified buffer to the output stream.
    1.87 +	@param aBuffer The data to write
    1.88 +    @return The number of bytes written or -1 in the case of an error
    1.89 +    */
    1.90      virtual TInt Write(const TDesC8& aBuffer) = 0;
    1.91  
    1.92      /**
    1.93 -     * Callback for closing output stream
    1.94 -     *
    1.95 -     * @since S60 v3.1
    1.96 -     * @return 
    1.97 -     *       0 is succeeded, 
    1.98 -     *      -1 in case of error
    1.99 -     */
   1.100 +	Closes the output stream.
   1.101 +	@return 0 if successful or -1 in the case of an error
   1.102 +    */
   1.103      virtual TInt Close() = 0;
   1.104      };
   1.105  
   1.106 +#endif /* XMLENGMOUTPUTSTREAM_H */  
   1.107  
   1.108 -
   1.109 -#endif /* XMLENGINE_MOUTPUTSTREAM_H_INCLUDED */