--- a/epoc32/include/xml/dom/xmlengprocessinginstruction.h Wed Mar 31 12:27:01 2010 +0100
+++ b/epoc32/include/xml/dom/xmlengprocessinginstruction.h Wed Mar 31 12:33:34 2010 +0100
@@ -1,96 +1,85 @@
-/*
-* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies).
-* All rights reserved.
-* This component and the accompanying materials are made available
-* 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
-* which accompanies this distribution, and is available
-* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
-*
-* Initial Contributors:
-* Nokia Corporation - initial contribution.
-*
-* Contributors:
-*
-* Description: Processing instruction node functions
-*
-*/
+// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+// Processing instruction node functions
+//
-
-
-
+/**
+ @file
+ @publishedAll
+ @released
+*/
+#ifndef XMLENGPROCESSINGINSTRUCTION_H
+#define XMLENGPROCESSINGINSTRUCTION_H
-#ifndef XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
-#define XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED
-
-#include "xmlengnode.h"
+#include <xml/dom/xmlengnode.h>
/**
- * Instance of TXmlEngProcessingInstruction class represents an XML processing
- * instruction in the DOM tree.
- *
- * @lib XmlEngineDOM.lib
- * @since S60 v3.1
- */
+This class represents an XML processing instruction in the DOM tree. This class
+is usually instantiated through RXmlEngDocument::CreateProcessingInstruction().
+*/
class TXmlEngProcessingInstruction : public TXmlEngNode
{
public:
- /**
- * Default constructor
- *
- * @since S60 v3.1
- */
+ /** Default constructor */
inline TXmlEngProcessingInstruction();
/**
- * Get target of processing instruction.
- *
- * @since S60 v3.1
- * @return "Target" part of a processing instruction
- *
- * @code
- * <?target data?>
- * @endcode
- * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
- */
+ Gets a reference to the the target part of the processing instruction.
+
+ @code
+ <?target data?>
+ @endcode
+
+ @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
+ @return A reference to the target part
+ */
IMPORT_C TPtrC8 Target() const;
/**
- * Get data of processing instruction.
- *
- * @since S60 v3.1
- * @return "Data" part of a processing instruction
- *
- * @code
- * <?target data?>
- * @endcode
- * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
- */
+ Gets a reference to the data part of the processing instruction.
+
+ @code
+ <?target data?>
+ @endcode
+
+ @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi
+ @return A reference to the data part
+ */
IMPORT_C TPtrC8 Data() const;
/**
- * Sets data part of processing instruction
- *
- * @since S60 v3.1
- * @param aData New data part of processing instruction
- * @note PI contents should not contain "?>" sequence
- */
+ Copies the parameter and sets the data part of the processing instruction.
+ Note: The processing instruction contents should not contain the "?>"
+ sequence
+ @param aData The data part to set
+ @leave - One of the system-wide error codes
+ */
IMPORT_C void SetDataL(const TDesC8& aData);
protected:
/**
- * Constructor
- *
- * @since S60 v3.1
- * @param aInternal processing instruction pointer
- */
+ Constructor
+ @param aInternal Processing instruction pointer
+ */
inline TXmlEngProcessingInstruction(void* aInternal);
};
+#include <xml/dom/xmlengprocessinginstruction.inl>
+#endif /* XMLENGPROCESSINGINSTRUCTION_H */
-#include "xmlengprocessinginstruction.inl"
-#endif /* XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED */