Skip to content

Commit

Permalink
[PERFECTIVE] Change formatting of header file comments to work with d…
Browse files Browse the repository at this point in the history 
…oxygen
  • Loading branch information
@hagantsa
hagantsa committed Jan 21, 2025
1 parent 852a5bb commit 34ba763
Show file tree
Hide file tree
Showing 1,281 changed files with 22,494 additions and 22,494 deletions.
10 changes: 5 additions & 5 deletions Help/HelpSystem/ContextHelpBrowser.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ class ContextHelpBrowser : public QTextBrowser
/*!
* Constructor.
*
* @param [in] engine The help engine containing the documentation.
* @param [in] urlPrefix A prefix used automatically for all URLs.
* @param [in] parent The parent widget.
* @param [in] engine The help engine containing the documentation.
* @param [in] urlPrefix A prefix used automatically for all URLs.
* @param [in] parent The parent widget.
*/
ContextHelpBrowser(QHelpEngine* engine, QString const& urlPrefix, QWidget* parent = 0);

Expand All @@ -45,15 +45,15 @@ class ContextHelpBrowser : public QTextBrowser
/*!
* Sets the content for the browser.
*
* @param [in] url The url to the content to set.
* @param [in] url The url to the content to set.
*/
virtual void setSource(QUrl const& url);

public slots:
/*!
* Shows the given help page.
*
* @param [in] url The URL of the page to show. This will be appended to the given URL prefix.
* @param [in] url The URL of the page to show. This will be appended to the given URL prefix.
*/
void onHelpRequested(QString const& url);

Expand Down
4 changes: 2 additions & 2 deletions Help/HelpSystem/HelpWindow.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ class HelpWindow : public QMainWindow
/*!
* Constructor.
*
* @param [in] engine The help engine.
* @param [in] parent The parent widget.
* @param [in] engine The help engine.
* @param [in] parent The parent widget.
*/
HelpWindow(QHelpEngine* engine, QWidget* parent = 0);

Expand Down
52 changes: 26 additions & 26 deletions IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,49 +46,49 @@ class IPXACTMODELS_EXPORT AbstractionDefinition: public Document
/*!
* Creates a perfect copy of the Bus Definition.
*
* @return Copy of the bus definition.
* @return Copy of the bus definition.
*/
virtual QSharedPointer<Document> clone() const;

/*! Set the VLNV for the bus definition.
*
* @param [in] vlnv The vlnv to set
* @param [in] vlnv The vlnv to set
*/
void setVlnv(const VLNV& vlnv) final;

/*! Get the vlnv tag of the bus definition that this abstraction definition details.
*
* @return The VLNV this abstraction definition details.
* @return The VLNV this abstraction definition details.
*/
VLNV getBusType() const;

/*! Set the bus definition detailed in this abstraction definition.
*
* @param [in] targetBus The vlnv of the target bus definition.
* @param [in] targetBus The vlnv of the target bus definition.
*/
void setBusType(VLNV const& targetBus);

/*! Get the vlnv tag of the bus definition that this definition extends.
*
* @return The VLNV this bus extends or empty VLNV if this bus does not extend another.
* @return The VLNV this bus extends or empty VLNV if this bus does not extend another.
*/
VLNV getExtends() const;

/*! Set the bus to extend another.
*
* @param [in] extends The vlnv of the extended bus definition.
* @param [in] extends The vlnv of the extended bus definition.
*/
void setExtends(VLNV const& extends);

/*! Get the VLNVs that this busDefinition depends on.
*
* @return The dependency VLNVs.
* @return The dependency VLNVs.
*/
virtual QList<VLNV> getDependentVLNVs() const;

/*! Get the file dependencies of this busDefinition.
*
* @return The dependency files.
* @return The dependency files.
*
* @remark This function never returns anything because busDefinition only has VLNV dependencies.
*/
Expand All @@ -97,59 +97,59 @@ class IPXACTMODELS_EXPORT AbstractionDefinition: public Document
/*!
* Checks if the abstraction definition has a definition for a port in a given mode.
*
* @param [in] portName The name of the port to check.
* @param [in] mode The mode to check for. Is undefined by default, matching any port with a wire.
* @param [in] portName The name of the port to check.
* @param [in] mode The mode to check for. Is undefined by default, matching any port with a wire.
*
* @return True, if the port definition is found, otherwise false.
* @return True, if the port definition is found, otherwise false.
*/
bool hasPort(QString const& portName, General::InterfaceMode mode=General::INTERFACE_MODE_COUNT) const;

/*!
* Gets the names of the ports defined in the abstraction definition.
*
* @param [in] mode The interface mode to find ports for.
* @param [in] mode The interface mode to find ports for.
*
* @return The names of the ports in the given mode.
* @return The names of the ports in the given mode.
*/
QStringList getPortNames(General::InterfaceMode mode) const;

/*!
* Gets the direction for a port in a given mode.
*
* @param [in] portName The name of the port to get the direction for.
* @param [in] mode The mode to get the direction for.
* @param [in] newSystemGroup Used system group of the new bus interface.
* @param [in] portName The name of the port to get the direction for.
* @param [in] mode The mode to get the direction for.
* @param [in] newSystemGroup Used system group of the new bus interface.
*
* @return The direction for the port in the given mode.
* @return The direction for the port in the given mode.
*/
DirectionTypes::Direction getPortDirection(QString const& portName, General::InterfaceMode mode,
QString const& newSystemGroup) const;

/*!
* Gets the initiative for a port in the selected interface mode.
*
* @param [in] portName Name of the selected port.
* @param [in] mode Interface mode for the selected port.
* @param [in] systemGroup The used system group.
* @param [in] portName Name of the selected port.
* @param [in] mode Interface mode for the selected port.
* @param [in] systemGroup The used system group.
*
* @return Initiative for the port in the given mode.
* @return Initiative for the port in the given mode.
*/
QString getPortInitiative(QString const& portName, General::InterfaceMode mode, QString const& systemGroup)
const;

/*!
* Gets a logical port with the given name.
*
* @param [in] portName The name of the port to get.
* @param [in] portName The name of the port to get.
*
* @return The port with the given name.
* @return The port with the given name.
*/
QSharedPointer<PortAbstraction> getPort(QString const& portName) const;

/*!
* Gets the logical ports in the abstraction description.
*
* @return The logical ports.
* @return The logical ports.
*/
QSharedPointer<QList<QSharedPointer<PortAbstraction> > > getLogicalPorts() const;

Expand All @@ -160,14 +160,14 @@ class IPXACTMODELS_EXPORT AbstractionDefinition: public Document
/*!
* Sets the choices of the abstraction definition.
*
* @param [in] choices Description
* @param [in] choices Description
*/
void setChoices(QSharedPointer<QList<QSharedPointer<Choice> > > choices);

/*!
* Gets the choices of the abstraction description.
*
* @return The choices.
* @return The choices.
*/
QSharedPointer<QList<QSharedPointer<Choice> > > getChoices() const;

Expand Down
32 changes: 16 additions & 16 deletions IPXACTmodels/AbstractionDefinition/AbstractionDefinitionReader.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ namespace AbstractionDefinitionReader
/*!
* Creates an abstraction definition from XML description.
*
* @param [in] document The XML document to create the abstraction definition from.
* @param [in] document The XML document to create the abstraction definition from.
*
* @return The created abstraction definition.
* @return The created abstraction definition.
*/
IPXACTMODELS_EXPORT QSharedPointer<AbstractionDefinition> createAbstractionDefinitionFrom(QDomNode const& document);

Expand All @@ -42,60 +42,60 @@ namespace AbstractionDefinitionReader
/*!
* Reads the bus type from XML to an abstraction definition.
*
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] busDefinition The abstraction definition to insert the extends property into.
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] busDefinition The abstraction definition to insert the extends property into.
*/
void parseBusType(QDomNode const& definitionNode,
QSharedPointer<AbstractionDefinition> abstractionDefinion);

/*!
* Reads the extends property from XML to an abstraction definition.
*
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] abstractionDefinion The abstraction definition to insert the extends property into.
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] abstractionDefinion The abstraction definition to insert the extends property into.
*/
void parseExtends(QDomNode const& definitionNode,
QSharedPointer<AbstractionDefinition> abstractionDefinion);

/*!
* Reads the logical ports from XML to an abstraction definition.
*
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] abstractionDefinion The abstraction definition to insert the ports into.
* @param [in] definitionNode The XML description of the abstraction definition.
* @param [in/out] abstractionDefinion The abstraction definition to insert the ports into.
*/
void parsePorts(QDomNode definitionNode, QSharedPointer<AbstractionDefinition> abstractionDefinion,
Document::Revision revision);

/*!
* Read a logical ports from XML to an abstraction definition.
*
* @param [in] portNode The XML description of the logical port.
* @param [in] portNode The XML description of the logical port.
*
* @return The read logical port.
* @return The read logical port.
*/
QSharedPointer<PortAbstraction> parsePort(QDomNode const& portNode, Document::Revision revision);

/*!
* Reads port packets from XML.
*
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the packets into.
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the packets into.
*/
void parsePackets(QDomNode const& portNode, QSharedPointer<PortAbstraction> port);

/*!
* Reads the wire description from XML to a logical port definition.
*
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the wire into.
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the wire into.
*/
void parseWire(QDomNode const& portNode, QSharedPointer<PortAbstraction> port, Document::Revision revision);

/*!
* Reads the transactional description from XML to a logical port definition.
*
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the transactional into.
* @param [in] portNode The XML description of the logical port.
* @param [in/out] port The logical port definition to insert the transactional into.
*/
void parseTransactional(QDomNode const& portNode, QSharedPointer<PortAbstraction> port,
Document::Revision revision);
Expand Down
28 changes: 14 additions & 14 deletions IPXACTmodels/AbstractionDefinition/AbstractionDefinitionWriter.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ namespace AbstractionDefinitionWriter
/*!
* Writes the given abstraction definition into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition to write.
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition to write.
*/
IPXACTMODELS_EXPORT void writeAbstractionDefinition(QXmlStreamWriter& writer,
QSharedPointer<AbstractionDefinition> abstractionDefinition);
Expand All @@ -46,50 +46,50 @@ namespace AbstractionDefinitionWriter
/*!
* Writes the bus type (VLNV) detailed in the given abstraction definition into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose bus type to write.
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose bus type to write.
*/
void writeBusType(QXmlStreamWriter& writer, QSharedPointer<AbstractionDefinition> abstractionDefinition);

/*!
* Writes the abstraction definition (VLNV) extended in the given abstraction definition into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose extended VLVN to write.
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose extended VLVN to write.
*/
void writeExtends(QXmlStreamWriter& writer, QSharedPointer<AbstractionDefinition> busDefinition);

/*!
* Writes the port definitions in the given abstraction definition into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose ports to write.
* @param [in] writer The XML writer to use.
* @param [in] abstractionDefinition The abstraction definition whose ports to write.
*/
void writePorts(QXmlStreamWriter& writer, QSharedPointer<AbstractionDefinition> abstractionDefinition);

/*!
* Writes a port definitions into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port to write.
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port to write.
*/
void writePort(QXmlStreamWriter& writer, QSharedPointer<PortAbstraction> logicalPort,
Document::Revision revision);

/*!
* Writes the wire definition in a port definitions into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port whose wire definition to write.
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port whose wire definition to write.
*/
void writeWire(QXmlStreamWriter& writer, QSharedPointer<PortAbstraction> logicalPort,
Document::Revision revision);

/*!
* Writes the transactional definition in a port definitions into XML.
*
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port whose transactional definition to write.
* @param [in] writer The XML writer to use.
* @param [in] logicalPort The port whose transactional definition to write.
*/
void writeTransactional(QXmlStreamWriter& writer, QSharedPointer<PortAbstraction> logicalPort,
Document::Revision revision);
Expand Down
8 changes: 4 additions & 4 deletions IPXACTmodels/AbstractionDefinition/Packet.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,28 @@ class IPXACTMODELS_EXPORT Packet : public NameGroup, public Extendable
/*!
* Get the packet endianness.
*
* @return The packet endianness.
* @return The packet endianness.
*/
QString getEndianness() const;

/*!
* Set the packet endianness.
*
* @param [in] endianness The new packet endianness.
* @param [in] endianness The new packet endianness.
*/
void setEndianness(QString const& endianness);

/*!
* Get the packet fields.
*
* @return The packet fields.
* @return The packet fields.
*/
QSharedPointer<QList<QSharedPointer<PacketField> > > getPacketFields() const;

/*!
* Set the packet fields.
*
* @param [in] packetFields The new packet fields.
* @param [in] packetFields The new packet fields.
*/
void setPacketFields(QSharedPointer<QList<QSharedPointer<PacketField> > > packetFields);

Expand Down
Loading

0 comments on commit 34ba763

Please sign in to comment.