epoc32/include/xml/dom/xmlengdataserializer.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
     1.1 --- a/epoc32/include/xml/dom/xmlengdataserializer.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/xml/dom/xmlengdataserializer.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,51 +1,50 @@
     1.4 -/*
     1.5 -* Copyright (c) 2006-2006 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 -*                serializer for binary data
    1.19 -*
    1.20 -*/
    1.21 +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
    1.22 +// All rights reserved.
    1.23 +// This component and the accompanying materials are made available
    1.24 +// under the terms of "Eclipse Public License v1.0"
    1.25 +// which accompanies this distribution, and is available
    1.26 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.27 +//
    1.28 +// Initial Contributors:
    1.29 +// Nokia Corporation - initial contribution.
    1.30 +//
    1.31 +// Contributors:
    1.32 +//
    1.33 +// Description:
    1.34 +// Interface class describing class that may be used as
    1.35 +// serializer for binary data
    1.36 +//
    1.37  
    1.38  
    1.39  
    1.40 -
    1.41 -
    1.42 -
    1.43 -
    1.44 -#ifndef XMLENGINE_MDATASERIALIZER_H_INCLUDED
    1.45 -#define XMLENGINE_MDATASERIALIZER_H_INCLUDED
    1.46 -
    1.47 -#include "xmlengnode.h"
    1.48 -
    1.49  /**
    1.50 - * MXmlEngDataSerializer interface used by XML Engine to serialize binary data for example binary data
    1.51 - * stored in node, external memory chunk (RChunk) or file. This interface may be implemented by client application.
    1.52 - *
    1.53 - * @lib XmlEngineDOM.lib
    1.54 - * @since S60 v3.2
    1.55 - */
    1.56 + @file
    1.57 + @publishedAll
    1.58 + @released
    1.59 +*/
    1.60 +#ifndef XMLENGMDATASERIALIZER_H
    1.61 +#define XMLENGMDATASERIALIZER_H
    1.62 +
    1.63 +#include <xml/dom/xmlengnode.h>
    1.64 +
    1.65 +/**
    1.66 +This interface is used to serialize binary data stored in a node, external
    1.67 +memory chunk (RChunk) or file.  This interface may be implemented by client
    1.68 +applications.
    1.69 +@see TXmlEngSerializationOptions
    1.70 +*/
    1.71  class MXmlEngDataSerializer
    1.72      {
    1.73  public:
    1.74 -    /**
    1.75 -     * Callback for serializing data
    1.76 -     *
    1.77 -     * @since S60 v3.1
    1.78 -     * @param aNode is a node to serialize
    1.79 -     * @return Replacement string for node data
    1.80 -     */
    1.81 +    /** 
    1.82 +	Serializes the node.  The implementor of this class must allocate and own
    1.83 +	the memory returned by this method until serialization is complete.
    1.84 +    @param aNode A node to serialize
    1.85 +    @return The serialized node
    1.86 +	@leave - One of the system-wide error codes
    1.87 +    */
    1.88      virtual TPtrC8 SerializeDataL(TXmlEngNode aNode) = 0;
    1.89      };
    1.90  
    1.91  
    1.92 -#endif /* XMLENGINE_MDATASERIALIZER_H_INCLUDED */  
    1.93 +#endif /* XMLENGMDATASERIALIZER_H */