umbrello API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

CodeComment Class Reference

class CodeComment Text which will be comments. More...

#include <codecomment.h>

Inheritance diagram for CodeComment:

TextBlock CPPCodeComment CPPCodeDocumentation JavaCodeComment JavaCodeDocumentation RubyCodeComment RubyCodeDocumentation XMLCodeComment List of all members.

Public Member Functions

 CodeComment (CodeDocument *doc, const QString &comment="")
 Empty Constructor.
virtual ~CodeComment ()
 Empty Destructor.
virtual void saveToXMI (QDomDocument &doc, QDomElement &root)
 Save the XMI representation of this object.
virtual void loadFromXMI (QDomElement &root)
 load params from the appropriate XMI element node.

Detailed Description

class CodeComment Text which will be comments.

These should be bracketed by what ever code type comment the language requires.

Definition at line 31 of file codecomment.h.

Constructor & Destructor Documentation

CodeComment::CodeComment (  CodeDocument *  doc,
const QString &  comment = ""
)  [explicit]
 

Empty Constructor.

Definition at line 23 of file codecomment.cpp.

CodeComment::~CodeComment (   )  [virtual]
 

Empty Destructor.

Definition at line 29 of file codecomment.cpp.

Member Function Documentation

void CodeComment::saveToXMI (  QDomDocument &  doc,
QDomElement &  root
)  [virtual]
 

Save the XMI representation of this object.

Implements TextBlock.

Reimplemented in CPPCodeComment, CPPCodeDocumentation, JavaCodeDocumentation, and RubyCodeDocumentation.

Definition at line 46 of file codecomment.cpp.

References TextBlock::setAttributesOnNode().

Referenced by CodeParameter::setAttributesOnNode(), CodeDocument::setAttributesOnNode(), and CodeBlockWithComments::setAttributesOnNode().

void CodeComment::loadFromXMI (  QDomElement &  root  )  [virtual]
 

load params from the appropriate XMI element node.

Implements TextBlock.

Definition at line 57 of file codecomment.cpp.

References TextBlock::setAttributesFromNode().

Referenced by RubyClassifierCodeDocument::loadChildTextBlocksFromNode(), JavaClassifierCodeDocument::loadChildTextBlocksFromNode(), JavaANTCodeDocument::loadChildTextBlocksFromNode(), CPPHeaderCodeDocument::loadChildTextBlocksFromNode(), CodeGenObjectWithTextBlocks::loadChildTextBlocksFromNode(), CodeParameter::setAttributesFromNode(), CodeDocument::setAttributesFromNode(), and CodeBlockWithComments::setAttributesFromNode().

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:04 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003