From 34ba763e04a31adfbebc5457307373ee3c8b9d35 Mon Sep 17 00:00:00 2001 From: hagantsa Date: Tue, 21 Jan 2025 12:49:57 +0200 Subject: [PATCH] [PERFECTIVE] Change formatting of header file comments to work with doxygen --- Help/HelpSystem/ContextHelpBrowser.h | 10 +- Help/HelpSystem/HelpWindow.h | 4 +- .../AbstractionDefinition.h | 52 +- .../AbstractionDefinitionReader.h | 32 +- .../AbstractionDefinitionWriter.h | 28 +- IPXACTmodels/AbstractionDefinition/Packet.h | 8 +- .../AbstractionDefinition/PacketField.h | 14 +- .../AbstractionDefinition/PacketReader.h | 16 +- .../AbstractionDefinition/PortAbstraction.h | 50 +- .../TransactionalAbstraction.h | 56 +- .../TransactionalAbstractionReader.h | 30 +- .../TransactionalAbstractionWriter.h | 46 +- .../AbstractionDefinition/TransactionalPort.h | 26 +- .../AbstractionDefinition/WireAbstraction.h | 68 +-- .../WireAbstractionReader.h | 52 +- .../WireAbstractionWriter.h | 58 +-- IPXACTmodels/AbstractionDefinition/WirePort.h | 42 +- .../AbstractionDefinitionValidator.h | 122 ++--- .../validators/PacketValidator.h | 42 +- .../validators/PortAbstractionValidator.h | 92 ++-- IPXACTmodels/BusDefinition/BusDefinition.h | 48 +- .../BusDefinition/BusDefinitionReader.h | 36 +- .../BusDefinition/BusDefinitionWriter.h | 36 +- .../validators/BusDefinitionValidator.h | 16 +- IPXACTmodels/Catalog/Catalog.h | 30 +- IPXACTmodels/Catalog/CatalogReader.h | 52 +- IPXACTmodels/Catalog/CatalogWriter.h | 4 +- IPXACTmodels/Catalog/IpxactFile.h | 12 +- .../Catalog/validators/CatalogValidator.h | 22 +- IPXACTmodels/Component/AbstractionType.h | 28 +- IPXACTmodels/Component/AccessPolicy.h | 4 +- IPXACTmodels/Component/AccessPolicyReader.h | 10 +- IPXACTmodels/Component/AccessPolicyWriter.h | 4 +- IPXACTmodels/Component/AddressBlock.h | 52 +- IPXACTmodels/Component/AddressBlockReader.h | 48 +- IPXACTmodels/Component/AddressBlockWriter.h | 32 +- IPXACTmodels/Component/AddressSpace.h | 42 +- IPXACTmodels/Component/AddressSpaceReader.h | 38 +- IPXACTmodels/Component/AddressSpaceWriter.h | 32 +- IPXACTmodels/Component/AlternateRegister.h | 14 +- IPXACTmodels/Component/BuildCommand.h | 8 +- IPXACTmodels/Component/BusInterface.h | 106 ++-- IPXACTmodels/Component/BusInterfaceReader.h | 74 +-- IPXACTmodels/Component/BusInterfaceWriter.h | 62 +-- IPXACTmodels/Component/CPUReader.h | 14 +- IPXACTmodels/Component/CPUWriter.h | 8 +- IPXACTmodels/Component/Channel.h | 8 +- IPXACTmodels/Component/ChannelReader.h | 10 +- IPXACTmodels/Component/ChannelWriter.h | 6 +- IPXACTmodels/Component/Component.h | 250 ++++----- IPXACTmodels/Component/ComponentGenerator.h | 30 +- .../Component/ComponentGeneratorReader.h | 32 +- .../Component/ComponentGeneratorWriter.h | 24 +- .../Component/ComponentInstantiation.h | 54 +- IPXACTmodels/Component/ComponentReader.h | 122 ++--- IPXACTmodels/Component/ComponentWriter.h | 72 +-- IPXACTmodels/Component/Cpu.h | 32 +- .../DesignConfigurationInstantiation.h | 24 +- IPXACTmodels/Component/DesignInstantiation.h | 10 +- IPXACTmodels/Component/Driver.h | 10 +- IPXACTmodels/Component/EnumeratedValue.h | 22 +- .../Component/EnumeratedValueReader.h | 16 +- .../Component/EnumeratedValueWriter.h | 16 +- IPXACTmodels/Component/ExecutableImage.h | 18 +- IPXACTmodels/Component/Field.h | 90 ++-- IPXACTmodels/Component/FieldAccessPolicy.h | 42 +- .../Component/FieldAccessPolicyReader.h | 46 +- .../Component/FieldAccessPolicyWriter.h | 4 +- IPXACTmodels/Component/FieldReader.h | 92 ++-- IPXACTmodels/Component/FieldReference.h | 8 +- IPXACTmodels/Component/FieldReferenceReader.h | 10 +- IPXACTmodels/Component/FieldReferenceWriter.h | 20 +- IPXACTmodels/Component/FieldReset.h | 12 +- IPXACTmodels/Component/FieldWriter.h | 68 +-- IPXACTmodels/Component/File.h | 106 ++-- IPXACTmodels/Component/FileReader.h | 74 +-- IPXACTmodels/Component/FileSet.h | 88 ++-- IPXACTmodels/Component/FileSetReader.h | 52 +- IPXACTmodels/Component/FileSetWriter.h | 54 +- IPXACTmodels/Component/FileWriter.h | 58 +-- IPXACTmodels/Component/Function.h | 50 +- IPXACTmodels/Component/IndirectInterface.h | 28 +- .../Component/IndirectInterfaceReader.h | 32 +- .../Component/IndirectInterfaceWriter.h | 16 +- IPXACTmodels/Component/InitiatorInterface.h | 12 +- IPXACTmodels/Component/InstantiationsReader.h | 46 +- IPXACTmodels/Component/InstantiationsWriter.h | 50 +- IPXACTmodels/Component/LanguageTools.h | 16 +- IPXACTmodels/Component/MemoryArray.h | 4 +- IPXACTmodels/Component/MemoryArrayReader.h | 18 +- IPXACTmodels/Component/MemoryArrayWriter.h | 20 +- IPXACTmodels/Component/MemoryBlockBase.h | 20 +- .../Component/MemoryBlockBaseReader.h | 16 +- .../Component/MemoryBlockBaseWriter.h | 8 +- IPXACTmodels/Component/MemoryMap.h | 24 +- IPXACTmodels/Component/MemoryMapBase.h | 22 +- IPXACTmodels/Component/MemoryMapBaseReader.h | 16 +- IPXACTmodels/Component/MemoryMapBaseWriter.h | 16 +- IPXACTmodels/Component/MemoryMapReader.h | 20 +- IPXACTmodels/Component/MemoryMapWriter.h | 28 +- IPXACTmodels/Component/MemoryRemap.h | 20 +- .../Component/MirroredTargetInterface.h | 10 +- IPXACTmodels/Component/Mode.h | 8 +- IPXACTmodels/Component/ModeReader.h | 20 +- IPXACTmodels/Component/ModeWriter.h | 16 +- IPXACTmodels/Component/Model.h | 62 +-- IPXACTmodels/Component/OtherClockDriver.h | 28 +- .../Component/OtherClockDriverReader.h | 14 +- .../Component/OtherClockDriverWriter.h | 14 +- IPXACTmodels/Component/Port.h | 86 +-- IPXACTmodels/Component/PortMap.h | 28 +- IPXACTmodels/Component/PortReader.h | 90 ++-- IPXACTmodels/Component/PortSlice.h | 12 +- IPXACTmodels/Component/PortWriter.h | 74 +-- IPXACTmodels/Component/PowerDomainReader.h | 4 +- IPXACTmodels/Component/PowerDomainWriter.h | 4 +- IPXACTmodels/Component/Region.h | 10 +- IPXACTmodels/Component/Register.h | 22 +- IPXACTmodels/Component/RegisterBase.h | 32 +- IPXACTmodels/Component/RegisterDefinition.h | 16 +- IPXACTmodels/Component/RegisterFile.h | 22 +- IPXACTmodels/Component/RegisterReader.h | 92 ++-- IPXACTmodels/Component/RegisterWriter.h | 60 +-- IPXACTmodels/Component/RemapPort.h | 12 +- IPXACTmodels/Component/RemapState.h | 12 +- IPXACTmodels/Component/RemapStateReader.h | 20 +- IPXACTmodels/Component/RemapStateWriter.h | 16 +- IPXACTmodels/Component/Segment.h | 18 +- IPXACTmodels/Component/Structured.h | 18 +- IPXACTmodels/Component/SubPort.h | 16 +- IPXACTmodels/Component/SubSpaceMap.h | 16 +- IPXACTmodels/Component/SubSpaceMapWriter.h | 12 +- IPXACTmodels/Component/SubspaceMapReader.h | 12 +- IPXACTmodels/Component/TargetInterface.h | 12 +- IPXACTmodels/Component/Transactional.h | 60 +-- IPXACTmodels/Component/TransparentBridge.h | 14 +- IPXACTmodels/Component/View.h | 28 +- IPXACTmodels/Component/ViewReader.h | 18 +- IPXACTmodels/Component/ViewWriter.h | 18 +- IPXACTmodels/Component/Wire.h | 54 +- IPXACTmodels/Component/WireTypeDef.h | 28 +- IPXACTmodels/Component/WriteValueConstraint.h | 22 +- .../validators/AbstractionTypeValidator.h | 130 ++--- .../validators/AddressBlockValidator.h | 158 +++--- .../validators/AddressSpaceValidator.h | 120 ++--- .../validators/BusInterfaceValidator.h | 282 +++++----- .../Component/validators/CPUValidator.h | 70 +-- .../Component/validators/ChannelValidator.h | 24 +- .../validators/ComponentGeneratorValidator.h | 44 +- .../Component/validators/ComponentValidator.h | 232 ++++----- .../validators/EnumeratedValueValidator.h | 32 +- .../validators/FieldAccessPolicyValidator.h | 80 +-- .../validators/FieldReferenceValidator.h | 10 +- .../validators/FieldSliceValidator.h | 52 +- .../Component/validators/FieldValidator.h | 196 +++---- .../Component/validators/FileSetValidator.h | 18 +- .../Component/validators/FileValidator.h | 18 +- .../validators/IndirectInterfaceValidator.h | 122 ++--- .../validators/InstantiationsValidator.h | 86 +-- .../validators/MemoryArrayValidator.h | 18 +- .../validators/MemoryBlockValidator.h | 52 +- .../validators/MemoryMapBaseValidator.h | 96 ++-- .../Component/validators/MemoryMapValidator.h | 68 +-- .../Component/validators/MemoryReserve.h | 28 +- .../Component/validators/ModeValidator.h | 26 +- .../validators/OtherClockDriverValidator.h | 42 +- .../Component/validators/PortMapValidator.h | 164 +++--- .../Component/validators/PortSliceValidator.h | 42 +- .../Component/validators/PortTypeValidator.h | 52 +- .../Component/validators/PortValidator.h | 100 ++-- .../validators/PowerDomainValidator.h | 56 +- .../Component/validators/RegionValidator.h | 42 +- .../validators/RegisterBaseValidator.h | 74 +-- .../validators/RegisterFileValidator.h | 106 ++-- .../Component/validators/RegisterValidator.h | 90 ++-- .../validators/RemapStateValidator.h | 56 +- .../validators/SubspaceMapValidator.h | 60 +-- .../Component/validators/ViewValidator.h | 44 +- IPXACTmodels/Design/ActiveInterface.h | 22 +- IPXACTmodels/Design/AdHocConnection.h | 36 +- IPXACTmodels/Design/ComponentInstance.h | 80 +-- IPXACTmodels/Design/ComponentInstanceReader.h | 62 +-- IPXACTmodels/Design/ComponentInstanceWriter.h | 16 +- IPXACTmodels/Design/Design.h | 78 +-- IPXACTmodels/Design/DesignReader.h | 124 ++--- IPXACTmodels/Design/DesignWriter.h | 66 +-- IPXACTmodels/Design/HierInterface.h | 20 +- IPXACTmodels/Design/Interconnection.h | 34 +- IPXACTmodels/Design/MonitorInterconnection.h | 20 +- IPXACTmodels/Design/MonitorInterface.h | 18 +- IPXACTmodels/Design/PortReference.h | 20 +- .../validator/AdHocConnectionValidator.h | 130 ++--- .../validator/ComponentInstanceValidator.h | 44 +- .../Design/validator/DesignValidator.h | 80 +-- .../validator/InterconnectionValidator.h | 190 +++---- .../DesignConfiguration/AbstractorInstance.h | 26 +- .../DesignConfiguration/DesignConfiguration.h | 54 +- .../DesignConfigurationReader.h | 56 +- .../DesignConfigurationWriter.h | 36 +- .../InterconnectionConfiguration.h | 14 +- .../DesignConfiguration/InterfaceRef.h | 12 +- .../MultipleAbstractorInstances.h | 14 +- .../DesignConfiguration/ViewConfiguration.h | 18 +- .../validators/DesignConfigurationValidator.h | 84 +-- .../InterconnectionConfigurationValidator.h | 86 +-- .../validators/ViewConfigurationValidator.h | 52 +- IPXACTmodels/common/AccessTypes.h | 10 +- IPXACTmodels/common/Assertion.h | 4 +- IPXACTmodels/common/BooleanValue.h | 6 +- IPXACTmodels/common/BuildModel.h | 12 +- IPXACTmodels/common/CellSpecification.h | 12 +- IPXACTmodels/common/Choice.h | 12 +- IPXACTmodels/common/ChoiceReader.h | 2 +- IPXACTmodels/common/ChoiceWriter.h | 8 +- IPXACTmodels/common/ClockUnit.h | 14 +- IPXACTmodels/common/CommonItemsReader.h | 48 +- IPXACTmodels/common/CommonItemsWriter.h | 70 +-- .../common/ConfigurableElementValue.h | 18 +- .../common/ConfigurableVLNVReference.h | 26 +- IPXACTmodels/common/DirectionTypes.h | 14 +- IPXACTmodels/common/Document.h | 110 ++-- IPXACTmodels/common/DocumentReader.h | 40 +- IPXACTmodels/common/DocumentUtils.h | 6 +- IPXACTmodels/common/DocumentWriter.h | 20 +- IPXACTmodels/common/Enumeration.h | 14 +- IPXACTmodels/common/Extendable.h | 18 +- IPXACTmodels/common/FileBuilder.h | 14 +- IPXACTmodels/common/FileBuilderReader.h | 16 +- IPXACTmodels/common/FileBuilderWriter.h | 10 +- IPXACTmodels/common/FileType.h | 16 +- IPXACTmodels/common/GenericVendorExtension.h | 72 +-- IPXACTmodels/common/ModuleParameter.h | 16 +- IPXACTmodels/common/ModuleParameterReader.h | 12 +- IPXACTmodels/common/ModuleParameterWriter.h | 6 +- IPXACTmodels/common/NameGroup.h | 28 +- IPXACTmodels/common/NameGroupReader.h | 20 +- IPXACTmodels/common/NameGroupWriter.h | 6 +- IPXACTmodels/common/NameValuePair.h | 8 +- IPXACTmodels/common/Parameter.h | 76 +-- IPXACTmodels/common/ParameterReader.h | 26 +- IPXACTmodels/common/ParameterWriter.h | 32 +- IPXACTmodels/common/PartSelect.h | 18 +- IPXACTmodels/common/PortAlignment.h | 16 +- IPXACTmodels/common/PresenceTypes.h | 10 +- IPXACTmodels/common/Protocol.h | 24 +- IPXACTmodels/common/ProtocolReader.h | 4 +- IPXACTmodels/common/ProtocolWriter.h | 12 +- IPXACTmodels/common/Qualifier.h | 18 +- IPXACTmodels/common/QualifierReader.h | 6 +- IPXACTmodels/common/QualifierWriter.h | 4 +- IPXACTmodels/common/Range.h | 8 +- IPXACTmodels/common/TimingConstraint.h | 16 +- IPXACTmodels/common/TransactionalTypes.h | 20 +- IPXACTmodels/common/VLNV.h | 88 ++-- IPXACTmodels/common/Vector.h | 8 +- IPXACTmodels/common/VendorExtension.h | 6 +- .../common/validators/AssertionValidator.h | 32 +- .../validators/CellSpecificationValidator.h | 10 +- .../common/validators/ChoiceValidator.h | 32 +- .../common/validators/CommonItemsValidator.h | 62 +-- .../common/validators/HierarchicalValidator.h | 10 +- .../common/validators/NMTokenValidator.h | 2 +- .../common/validators/ParameterValidator.h | 182 +++---- .../common/validators/ProtocolValidator.h | 14 +- .../common/validators/QualifierValidator.h | 16 +- .../validators/TimingConstraintValidator.h | 22 +- .../common/validators/ValueFormatter.h | 10 +- .../common/validators/namevalidator.h | 2 +- IPXACTmodels/generaldeclarations.h | 114 ++-- IPXACTmodels/kactusExtensions/ApiDefinition.h | 14 +- .../kactusExtensions/ApiDefinitionReader.h | 8 +- .../kactusExtensions/ApiDefinitionWriter.h | 4 +- IPXACTmodels/kactusExtensions/ApiFunction.h | 30 +- .../kactusExtensions/ApiFunctionParameter.h | 22 +- .../kactusExtensions/ApiInterconnection.h | 26 +- IPXACTmodels/kactusExtensions/ApiInterface.h | 20 +- IPXACTmodels/kactusExtensions/ColumnDesc.h | 10 +- IPXACTmodels/kactusExtensions/ComDefinition.h | 16 +- .../kactusExtensions/ComDefinitionReader.h | 8 +- .../kactusExtensions/ComDefinitionWriter.h | 4 +- .../kactusExtensions/ComInterconnection.h | 20 +- IPXACTmodels/kactusExtensions/ComInterface.h | 26 +- IPXACTmodels/kactusExtensions/ComProperty.h | 18 +- .../kactusExtensions/ConnectionRoute.h | 20 +- .../kactusExtensions/FileDependency.h | 22 +- .../kactusExtensions/HierApiInterconnection.h | 40 +- .../kactusExtensions/HierComInterconnection.h | 36 +- .../kactusExtensions/InterfaceGraphicsData.h | 28 +- IPXACTmodels/kactusExtensions/Kactus2Group.h | 16 +- .../kactusExtensions/Kactus2Placeholder.h | 16 +- .../kactusExtensions/Kactus2Position.h | 12 +- IPXACTmodels/kactusExtensions/Kactus2Value.h | 14 +- .../kactusExtensions/KactusAttribute.h | 42 +- IPXACTmodels/kactusExtensions/SystemView.h | 28 +- .../validators/ApiDefinitionValidator.h | 10 +- .../validators/ComDefinitionValidator.h | 10 +- .../SystemDesignConfigurationValidator.h | 18 +- .../SystemViewConfigurationValidator.h | 10 +- IPXACTmodels/utilities/BusDefinitionUtils.h | 12 +- KactusAPI/KactusAPI.h | 44 +- .../include/AbstractParameterInterface.h | 274 +++++----- KactusAPI/include/AbstractionTypeInterface.h | 104 ++-- KactusAPI/include/AccessPolicyInterface.h | 26 +- KactusAPI/include/AdHocConnectionInterface.h | 96 ++-- .../include/AddressBlockExpressionsGatherer.h | 4 +- KactusAPI/include/AddressBlockInterface.h | 164 +++--- .../include/AddressSpaceExpressionsGatherer.h | 8 +- KactusAPI/include/BusInterfaceInterface.h | 378 +++++++------- .../include/BusInterfaceInterfaceFactory.h | 102 ++-- KactusAPI/include/BusInterfaceUtilities.h | 18 +- KactusAPI/include/CLIGenerator.h | 14 +- KactusAPI/include/CommonInterface.h | 20 +- ...omponentAndInstantiationsParameterFinder.h | 12 +- .../include/ComponentInstanceInterface.h | 74 +-- .../ComponentInstanceParameterFinder.h | 8 +- .../include/ComponentInstantiationInterface.h | 164 +++--- .../ComponentInstantiationParameterFinder.h | 22 +- KactusAPI/include/ComponentParameterFinder.h | 32 +- KactusAPI/include/DesignParameterFinder.h | 6 +- KactusAPI/include/DocumentValidator.h | 22 +- KactusAPI/include/ExpressionFormatter.h | 6 +- .../include/ExpressionFormatterFactory.h | 6 +- ...ExpressionFormatterFactoryImplementation.h | 6 +- KactusAPI/include/ExpressionParser.h | 14 +- KactusAPI/include/ExpressionSupport.h | 2 +- KactusAPI/include/FieldExpressionsGatherer.h | 4 +- KactusAPI/include/FieldInterface.h | 464 ++++++++--------- KactusAPI/include/FileBuilderInterface.h | 84 +-- KactusAPI/include/FileHandler.h | 32 +- KactusAPI/include/FileInterface.h | 256 ++++----- KactusAPI/include/FileSetInterface.h | 90 ++-- KactusAPI/include/HighlightSource.h | 2 +- KactusAPI/include/Highlighter.h | 16 +- KactusAPI/include/IGeneratorPlugin.h | 16 +- KactusAPI/include/IPXactSystemVerilogParser.h | 14 +- KactusAPI/include/IPluginUtility.h | 4 +- KactusAPI/include/ISourceAnalyzerPlugin.h | 20 +- KactusAPI/include/ImportHighlighter.h | 20 +- KactusAPI/include/ImportPlugin.h | 18 +- KactusAPI/include/ImportRunner.h | 82 +-- KactusAPI/include/InterconnectionInterface.h | 96 ++-- KactusAPI/include/LibraryHandler.h | 146 +++--- KactusAPI/include/LibraryInterface.h | 90 ++-- KactusAPI/include/LibraryItem.h | 68 +-- KactusAPI/include/LibraryLoader.h | 16 +- KactusAPI/include/LibraryTreeModel.h | 60 +-- KactusAPI/include/ListParameterFinder.h | 22 +- KactusAPI/include/MasterPortInterface.h | 22 +- KactusAPI/include/MemoryBlockInterface.h | 160 +++--- .../include/MemoryMapExpressionsGatherer.h | 4 +- KactusAPI/include/MemoryMapInterface.h | 296 +++++------ .../include/MemoryRemapExpressionGatherer.h | 4 +- KactusAPI/include/ModeConditionParser.h | 34 +- .../include/ModeConditionParserInterface.h | 24 +- KactusAPI/include/ModeReferenceInterface.h | 28 +- KactusAPI/include/ModelParameterSource.h | 2 +- KactusAPI/include/ModelParameterVisualizer.h | 2 +- KactusAPI/include/ModuleParameterInterface.h | 62 +-- KactusAPI/include/MultipleParameterFinder.h | 26 +- KactusAPI/include/NameGroupInterface.h | 44 +- KactusAPI/include/NullParser.h | 12 +- KactusAPI/include/ParameterCache.h | 16 +- KactusAPI/include/ParameterFinder.h | 20 +- KactusAPI/include/ParameterizableInterface.h | 24 +- KactusAPI/include/ParametersInterface.h | 36 +- KactusAPI/include/PluginManager.h | 10 +- KactusAPI/include/PluginSettingsModel.h | 4 +- KactusAPI/include/PluginUtilityAdapter.h | 14 +- KactusAPI/include/PortAbstractionInterface.h | 490 +++++++++--------- KactusAPI/include/PortMapInterface.h | 310 +++++------ KactusAPI/include/PortsInterface.h | 386 +++++++------- .../include/RegisterExpressionsGatherer.h | 4 +- .../include/RegisterFileExpressionsGatherer.h | 4 +- KactusAPI/include/RegisterInterface.h | 210 ++++---- KactusAPI/include/ResetInterface.h | 98 ++-- KactusAPI/include/SubspaceMapInterface.h | 84 +-- .../include/SystemVerilogExpressionParser.h | 106 ++-- KactusAPI/include/TagManager.h | 12 +- .../include/TransparentBridgeInterface.h | 70 +-- KactusAPI/include/hierarchyitem.h | 132 ++--- KactusAPI/include/hierarchymodel.h | 70 +-- .../AlteraBSPGenerator/alterabspgenerator.h | 24 +- Plugins/CppSourceAnalyzer/CppSourceAnalyzer.h | 28 +- .../CPUSelection/LinuxDeviceTreeCPUDelegate.h | 16 +- .../CPUSelection/LinuxDeviceTreeCPUDetails.h | 28 +- .../CPUSelection/LinuxDeviceTreeCPUEditor.h | 6 +- .../CPUSelection/LinuxDeviceTreeCPUModel.h | 48 +- .../LinuxDeviceTreeCpuRoutesContainer.h | 36 +- .../LinuxDeviceTree/LinuxDeviceTreeDialog.h | 16 +- .../LinuxDeviceTreeGenerator.h | 162 +++--- .../LinuxDeviceTree/LinuxDeviceTreePlugin.h | 32 +- .../MCAPICodeGenerator/MCAPICodeGenerator.h | 86 +-- .../MCAPICodeGeneratorPlugin.h | 16 +- .../MCAPICodeGenerator/MCAPIHeaderGenerator.h | 58 +-- Plugins/MCAPICodeGenerator/MCAPIParser.h | 60 +-- Plugins/MakefileGenerator/MakeConfiguration.h | 8 +- Plugins/MakefileGenerator/MakefileGenerator.h | 46 +- .../MakefileGeneratorPlugin.h | 30 +- Plugins/MakefileGenerator/MakefileParser.h | 36 +- Plugins/MakefileGenerator/SWStackParser.h | 22 +- .../BaseMemoryMapHeaderWriter.h | 88 ++-- .../GlobalMemoryMapHeaderWriter.h | 70 +-- .../LocalMemoryMapHeaderWriter.h | 10 +- .../SystemMemoryMapHeaderWriter.h | 18 +- .../globalheadersavemodel.h | 44 +- .../localheadersavedelegate.h | 22 +- .../localheadersavemodel.h | 42 +- .../memorymapheadergenerator.h | 50 +- .../MemoryViewGenerator/MemoryViewGenerator.h | 12 +- .../MemoryViewGeneratorPlugin.h | 24 +- .../ModelSimGeneratorPlugin.h | 30 +- .../ModelSimWriterFactory/ModelSimDocument.h | 6 +- .../ModelSimWriterFactory/ModelSimWriter.h | 2 +- .../ModelSimWriterFactory.h | 20 +- Plugins/PadsPartGenerator/PadsPartGenerator.h | 62 +-- .../PadsPartGeneratorDialog.h | 52 +- .../GeneratorPlugin/FileOutputWidget.h | 4 +- .../GeneratorPlugin/GenerationControl.h | 26 +- .../GeneratorPlugin/HDLGenerationDialog.h | 4 +- .../GeneratorPlugin/IWriterFactory.h | 10 +- .../GeneratorPlugin/OutputControl.h | 16 +- .../GeneratorPlugin/ViewSelection.h | 12 +- .../QuartusPinImportPlugin.h | 28 +- .../QuartusGenerator.h | 68 +-- .../QuartusProjectGenerator.h | 46 +- .../CPUDialog/RenodeCpuEditor.h | 34 +- .../CPUDialog/RenodeCpuRoutesContainer.h | 24 +- .../CPUDialog/RenodeFileEditor.h | 30 +- .../CPUDialog/RenodeFileSelectionGroup.h | 16 +- .../CPUDialog/RenodeMemoriesEditor.h | 4 +- .../CPUDialog/RenodeMemoriesModel.h | 46 +- .../CPUDialog/RenodePeripheralsDelegate.h | 44 +- .../CPUDialog/RenodePeripheralsEditor.h | 10 +- .../CPUDialog/RenodePeripheralsModel.h | 56 +- .../CPUDialog/RenodeUtilities.h | 22 +- .../PeripheralTemplateConfigurer.h | 6 +- .../PeripheralTemplateDelegate.h | 10 +- .../TemplateEditor/PeripheralTemplateEditor.h | 6 +- .../TemplateEditor/PeripheralTemplateModel.h | 60 +-- .../PeripheralTemplatesDialog.h | 8 +- .../RenodeConfigurationManager.h | 58 +-- Plugins/RenodeGenerator/RenodeGenerator.h | 84 +-- .../RenodeGenerator/RenodeGeneratorPlugin.h | 38 +- Plugins/RenodeGenerator/RenodeSettingsModel.h | 8 +- .../RenodeGenerator/RenodeSettingsWidget.h | 6 +- .../SVDGenerator/CPUDialog/SVDCPUDelegate.h | 28 +- Plugins/SVDGenerator/CPUDialog/SVDCPUEditor.h | 20 +- Plugins/SVDGenerator/CPUDialog/SVDCPUModel.h | 48 +- .../CPUDialog/SVDCpuRoutesContainer.h | 30 +- .../SVDGenerator/SVDConfigurationManager.h | 28 +- Plugins/SVDGenerator/SVDGenerator.h | 184 +++---- Plugins/SVDGenerator/SVDGeneratorPlugin.h | 38 +- Plugins/VHDLAnalyzer/VHDLSourceAnalyzer.h | 64 +-- Plugins/VHDLGenerator/VHDLGeneratorPlugin.h | 42 +- Plugins/VHDLGenerator/VhdlTypedObject.h | 14 +- .../VHDLGenerator/vhdlcomponentdeclaration.h | 46 +- Plugins/VHDLGenerator/vhdlcomponentinstance.h | 56 +- Plugins/VHDLGenerator/vhdlgenerator2.h | 124 ++--- Plugins/VHDLPackageImport/VHDLPackageImport.h | 32 +- Plugins/VHDLimport/VHDLGenericParser.h | 56 +- Plugins/VHDLimport/VHDLPortParser.h | 66 +-- Plugins/VHDLimport/VHDLimport.h | 38 +- .../CommentWriter/CommentWriter.h | 8 +- .../ComponentInstanceVerilogWriter.h | 70 +-- .../ComponentVerilogWriter.h | 42 +- .../ModelParameterVerilogWriter.h | 12 +- .../TextBodyWriter/TextBodyWriter.h | 2 +- .../VerilogAssignmentWriter.h | 8 +- .../VerilogGenerator/VerilogGeneratorPlugin.h | 30 +- .../VerilogHeaderWriter/VerilogHeaderWriter.h | 16 +- .../VerilogInterconnectionWriter.h | 8 +- .../VerilogPortWriter/VerilogPortWriter.h | 10 +- .../VerilogTopDefaultWriter.h | 4 +- .../VerilogGenerator/VerilogSourceHighlight.h | 6 +- .../VerilogWireWriter/VerilogWireWriter.h | 6 +- .../VerilogWriterFactory/VerilogDocument.h | 16 +- .../VerilogWriterFactory.h | 38 +- Plugins/VerilogGenerator/common/Writer.h | 2 +- Plugins/VerilogGenerator/common/WriterGroup.h | 4 +- Plugins/VerilogImport/VerilogImporter.h | 36 +- Plugins/VerilogImport/VerilogInstanceParser.h | 40 +- .../VerilogImport/VerilogParameterParser.h | 72 +-- Plugins/VerilogImport/VerilogPortParser.h | 84 +-- Plugins/VerilogImport/VerilogSyntax.h | 28 +- .../VerilogIncludeImport.h | 40 +- .../VerilogSourceAnalyzer.h | 68 +-- Plugins/common/CPUDialog/CPUEditor.h | 14 +- Plugins/common/CPUDialog/CPUSelectionDialog.h | 46 +- Plugins/common/CSourceWriter.h | 16 +- Plugins/common/ConfigurationManager.h | 40 +- Plugins/common/ConnectivityGraphUtilities.h | 14 +- Plugins/common/CpuRoutesContainer.h | 18 +- .../common/HDLParser/HDLCommandLineParser.h | 8 +- Plugins/common/HDLParser/MetaComponent.h | 8 +- Plugins/common/HDLParser/MetaDesign.h | 92 ++-- Plugins/common/HDLParser/MetaInstance.h | 26 +- Plugins/common/LanguageHighlighter.h | 18 +- Plugins/common/PluginConfigurationManager.h | 2 +- .../PortSorter/InterfaceDirectionNameSorter.h | 8 +- Plugins/common/PortSorter/PortSorter.h | 8 +- Plugins/common/SingleCpuRoutesContainer.h | 6 +- Plugins/common/SourceHighlightStyle.h | 8 +- PythonAPI/PythonAPI.h | 330 ++++++------ PythonAPI/PythonInterpreter.h | 26 +- common/GenericEditProvider.h | 4 +- common/IEditProvider.h | 2 +- common/NameGenerationPolicy.h | 20 +- common/TextEditProvider.h | 4 +- .../LibrarySettingsDialog.h | 22 +- .../librarysettingsdelegate.h | 8 +- common/dialogs/NewBusDialog/NewBusDialog.h | 6 +- .../dialogs/NewDesignDialog/NewDesignDialog.h | 12 +- .../createconfigurationdialog.h | 16 +- .../listSelectDialog/ListSelectDialog.h | 4 +- .../dialogs/newObjectDialog/newobjectdialog.h | 38 +- .../propertyPageDialog/PropertyPageDialog.h | 18 +- .../propertyPageDialog/PropertyPageView.h | 6 +- common/expressions/utilities.h | 8 +- .../CommonGraphicsUndoCommands.h | 32 +- common/graphicsItems/ComponentItem.h | 36 +- common/graphicsItems/ConnectionEndpoint.h | 38 +- common/graphicsItems/ConnectionItem.h | 14 +- common/graphicsItems/ConnectionUndoCommands.h | 16 +- common/graphicsItems/GraphicsColumn.h | 36 +- .../graphicsItems/GraphicsColumnAddCommand.h | 16 +- common/graphicsItems/GraphicsColumnLayout.h | 24 +- .../GraphicsColumnUndoCommands.h | 22 +- common/graphicsItems/GraphicsConnection.h | 128 ++--- common/graphicsItems/GraphicsLineEdit.h | 4 +- common/graphicsItems/IGraphicsItemStack.h | 12 +- common/graphicsItems/expandableitem.h | 6 +- .../graphicsexpandcollapseitem.h | 8 +- common/graphicsItems/visualizeritem.h | 32 +- common/layouts/HCollisionLayout.h | 22 +- common/layouts/HStackedLayout.h | 20 +- common/layouts/IHGraphicsLayout.h | 20 +- common/layouts/IVGraphicsLayout.h | 20 +- common/layouts/VCollisionLayout.h | 22 +- common/layouts/VStackedLayout.h | 22 +- common/layouts/VStaticLayout.h | 22 +- .../views/EditableListView/editablelistview.h | 28 +- .../EditableTableView/editabletableview.h | 54 +- .../EditableTreeView/EditableTreeSortFilter.h | 32 +- .../views/EditableTreeView/EditableTreeView.h | 52 +- .../ExpandingTreeView/ExpandingTreeView.h | 2 +- .../DirectoryListSelector.h | 14 +- .../EnumCollectionEditor.h | 24 +- .../EnumCollectionEditor/EnumerationEditor.h | 14 +- common/widgets/FileSelector/fileselector.h | 10 +- .../StyleGroupBoxWithAlertSign.h | 8 +- .../LibraryPathSelector/librarypathselector.h | 10 +- .../LibrarySelectorWidget.h | 6 +- common/widgets/LineEditEx/LineEditEx.h | 8 +- .../ParameterGroupBox/parametergroupbox.h | 26 +- .../SnippetTextEdit/SnippetHighlighter.h | 2 +- .../widgets/SnippetTextEdit/SnippetTextEdit.h | 8 +- .../TreeItemSelector/FramedTreeItemEditor.h | 2 +- common/widgets/TreeItemSelector/TreeItem.h | 10 +- .../widgets/TreeItemSelector/TreeItemEditor.h | 12 +- .../widgets/accessComboBox/accesscombobox.h | 4 +- .../assistedLineEdit/AssistedLineEdit.h | 8 +- .../BasicLineContentMatcher.h | 24 +- .../assistedLineEdit/ILineContentMatcher.h | 16 +- .../LineContentAssistWidget.h | 24 +- .../assistedTextEdit/AssistedTextEdit.h | 30 +- .../assistedTextEdit/ITextContentMatcher.h | 16 +- .../TextContentAssistWidget.h | 16 +- .../widgets/booleanComboBox/booleancombobox.h | 6 +- .../BusReferenceComboBox.h | 8 +- common/widgets/colorBox/ColorBox.h | 8 +- .../componentPreviewBox/ComponentPreviewBox.h | 12 +- .../interfacemodeselector.h | 14 +- .../interfaceSelector/interfaceselector.h | 10 +- .../KactusAttributeEditor.h | 10 +- common/widgets/listManager/dirlistmanager.h | 8 +- .../widgets/listManager/dirlistmanagermodel.h | 10 +- common/widgets/listManager/listeditor.h | 10 +- common/widgets/listManager/listmanager.h | 12 +- common/widgets/listManager/listmanagermodel.h | 46 +- common/widgets/nameGroupBox/namegroupbox.h | 16 +- .../widgets/segmentComboBox/SegmentComboBox.h | 4 +- common/widgets/summaryLabel/summarylabel.h | 6 +- common/widgets/tabDocument/TabDocument.h | 48 +- common/widgets/tagEditor/FlowLayout.h | 50 +- common/widgets/tagEditor/TagCompleterModel.h | 20 +- common/widgets/tagEditor/TagContainer.h | 26 +- common/widgets/tagEditor/TagDisplay.h | 36 +- common/widgets/tagEditor/TagEditor.h | 10 +- common/widgets/tagEditor/TagEditorContainer.h | 6 +- common/widgets/tagEditor/TagLabel.h | 10 +- common/widgets/tagEditor/TagSelector.h | 8 +- .../widgets/tagEditor/TagSelectorContainer.h | 6 +- common/widgets/usageComboBox/usagecombobox.h | 4 +- common/widgets/vlnvDisplayer/vlnvdisplayer.h | 10 +- .../widgets/vlnvEditor/VLNVContentMatcher.h | 22 +- common/widgets/vlnvEditor/VLNVDataTree.h | 38 +- common/widgets/vlnvEditor/vlnveditor.h | 36 +- .../AbsDefParameterReferenceCounter.h | 22 +- .../AbsDefParameterReferenceTree.h | 8 +- .../AbstractionDefinitionEditor.h | 28 +- .../AbstractionDefinitionPortsSortFilter.h | 26 +- .../AbstractionDefinitionSignalRow.h | 44 +- .../AbstractionPortsDelegate.h | 46 +- .../AbstractionPortsEditor.h | 30 +- .../AbstractionPortsModel.h | 126 ++--- .../AbstractionPortsView.h | 4 +- .../AbstractionTransactionalPortsDelegate.h | 22 +- .../AbstractionTransactionalPortsSortFilter.h | 18 +- .../AbstractionWirePortsDelegate.h | 28 +- .../AbstractionWirePortsSortFilter.h | 8 +- .../QualifierEditor.h | 26 +- .../AbstractionDefinitionEditor/absdefgroup.h | 42 +- .../ApiDefinitionEditor/ApiDefinitionEditor.h | 12 +- .../ApiDefinitionEditor/ApiFunctionEditor.h | 6 +- .../ApiDefinitionEditor/ApiFunctionModel.h | 44 +- .../ApiFunctionParameterDelegate.h | 24 +- .../ApiFunctionParameterModel.h | 40 +- .../BusDefinitionEditor/BusDefinitionEditor.h | 24 +- .../BusDefinitionParameterReferenceTree.h | 8 +- .../SystemGroupListEditor.h | 14 +- editors/BusDefinitionEditor/busdefgroup.h | 28 +- editors/CSourceEditor/CSourceContentMatcher.h | 90 ++-- editors/CSourceEditor/CSourceHighlight.h | 6 +- editors/CSourceEditor/CSourceHighlighter.h | 4 +- editors/CSourceEditor/CSourceTextEdit.h | 4 +- editors/CSourceEditor/CSourceWidget.h | 10 +- editors/CatalogEditor/CatalogEditor.h | 14 +- editors/CatalogEditor/CatalogFileDelegate.h | 20 +- editors/CatalogEditor/CatalogFileFilter.h | 10 +- editors/CatalogEditor/CatalogFileModel.h | 78 +-- editors/CatalogEditor/CatalogFileView.h | 18 +- .../ComDefinitionEditor/ComDefinitionEditor.h | 14 +- .../ComDefinitionEditor/ComPropertyDelegate.h | 20 +- .../ComDefinitionEditor/ComPropertyEditor.h | 4 +- .../ComDefinitionEditor/ComPropertyModel.h | 40 +- editors/ComponentEditor/ParameterItemEditor.h | 14 +- .../addressSpaces/SegmentDelegate.h | 10 +- .../AddressSpaceConflictedItem.h | 8 +- .../addressspacegapitem.h | 24 +- .../addressspacescene.h | 10 +- .../addressspacevisualizationitem.h | 22 +- .../addressspacevisualizer.h | 10 +- .../localaddrblockgraphitem.h | 12 +- .../addressSpaceVisualizer/segmentgraphitem.h | 16 +- .../addressSpaces/addressspaceeditor.h | 18 +- .../addressSpaces/addressspacegeneraleditor.h | 32 +- .../addressSpaces/addressspacesdelegate.h | 10 +- .../addressSpaces/addressspaceseditor.h | 14 +- .../addressSpaces/addressspacesmodel.h | 86 +-- .../localMemoryMap/localmemorymapeditor.h | 18 +- .../localMemoryMap/localmemorymapgraphitem.h | 8 +- .../addressSpaces/segmenteditor.h | 18 +- .../addressSpaces/segmentsmodel.h | 76 +-- .../busInterfaces/AbstractionTypesDelegate.h | 48 +- .../busInterfaces/AbstractionTypesEditor.h | 14 +- .../busInterfaces/AbstractionTypesModel.h | 74 +-- .../busInterfaces/businterfaceeditor.h | 22 +- .../busInterfaces/businterfacesdelegate.h | 20 +- .../busInterfaces/businterfaceseditor.h | 10 +- .../busInterfaces/businterfacesmodel.h | 90 ++-- .../general/InitiatorModeEditor.h | 22 +- .../busInterfaces/general/MasterModeEditor.h | 22 +- .../general/MirroredInitiatorModeEditor.h | 8 +- .../general/MirroredMasterModeEditor.h | 8 +- .../general/MirroredSlaveModeEditor.h | 18 +- .../general/MirroredTargetModeEditor.h | 18 +- .../busInterfaces/general/ModeEditorBase.h | 14 +- .../busInterfaces/general/MonitorModeEditor.h | 16 +- .../busInterfaces/general/SlaveModeEditor.h | 18 +- .../busInterfaces/general/SystemModeEditor.h | 14 +- .../busInterfaces/general/TargetModeEditor.h | 18 +- .../busInterfaces/general/bridgesdelegate.h | 24 +- .../busInterfaces/general/bridgeseditor.h | 10 +- .../busInterfaces/general/bridgesmodel.h | 42 +- .../general/busifgeneraldetails.h | 12 +- .../busInterfaces/general/busifgeneraltab.h | 42 +- .../general/interfacemodestack.h | 22 +- .../portmaps/BusInterfacePortMapTab.h | 34 +- .../portmaps/JaroWinklerAlgorithm.h | 42 +- .../portmaps/PhysicalPortMappingTableModel.h | 14 +- .../portmaps/PhysicalPortMappingTableView.h | 10 +- .../portmaps/PortListSortProxyModel.h | 44 +- .../portmaps/PortMapAutoConnector.h | 46 +- .../busInterfaces/portmaps/PortMapDelegate.h | 60 +-- .../portmaps/PortMapHeaderView.h | 10 +- .../busInterfaces/portmaps/PortMapModel.h | 100 ++-- .../portmaps/PortMapSortFilter.h | 20 +- .../busInterfaces/portmaps/PortMapView.h | 10 +- .../portmaps/PortMappingTableModel.h | 24 +- .../portmaps/PortMappingTableView.h | 12 +- .../channels/channelsdelegate.h | 38 +- .../ComponentEditor/channels/channelseditor.h | 8 +- .../ComponentEditor/channels/channelsmodel.h | 48 +- .../ComponentEditor/choices/ChoicesEditor.h | 14 +- .../ComponentEditor/choices/ChoicesModel.h | 48 +- .../choices/EnumerationModel.h | 68 +-- .../common/AbstractParameterModel.h | 124 ++--- .../common/ConfigurableElementFinder.h | 28 +- ...onfigurationInstantiationParameterFinder.h | 22 +- .../EnumerationEditorConstructorDelegate.h | 52 +- .../common/ExpressionDelegate.h | 24 +- .../ComponentEditor/common/ExpressionEditor.h | 48 +- .../common/ExpressionLineEditor.h | 52 +- .../common/FloatingModeReferenceEditor.h | 4 +- .../InstantiationConfigurableElementEditor.h | 22 +- .../common/MasterExpressionEditor.h | 134 ++--- .../ComponentEditor/common/MemoryAlignScene.h | 28 +- .../common/MemoryTreeFactory.h | 14 +- .../common/ModeReferenceDelegate.h | 20 +- .../common/ModeReferenceEditor.h | 4 +- .../common/ModeReferenceModel.h | 42 +- .../common/MultilineDescriptionDelegate.h | 18 +- .../common/ParameterizableTable.h | 40 +- .../ReferenceSelector/ReferenceSelector.h | 4 +- .../common/ReferencingTableModel.h | 24 +- editors/ComponentEditor/componenteditor.h | 100 ++-- .../ComponentEditor/cpus/CpuDetailsEditor.h | 12 +- editors/ComponentEditor/cpus/CpuVisualizer.h | 12 +- editors/ComponentEditor/cpus/RegionScene.h | 10 +- .../ComponentEditor/cpus/RegionsDelegate.h | 10 +- editors/ComponentEditor/cpus/RegionsEditor.h | 14 +- editors/ComponentEditor/cpus/RegionsModel.h | 76 +-- .../ComponentEditor/cpus/SingleCpuEditor.h | 14 +- editors/ComponentEditor/cpus/cpusdelegate.h | 50 +- editors/ComponentEditor/cpus/cpuseditor.h | 10 +- editors/ComponentEditor/cpus/cpusmodel.h | 66 +-- .../fileBuilders/filebuildersdelegate.h | 44 +- .../fileBuilders/filebuilderseditor.h | 18 +- .../fileBuilders/filebuildersmodel.h | 80 +-- .../FileDependencyDelegate.h | 16 +- .../dependencyAnalysis/FileDependencyEditor.h | 22 +- .../FileDependencyGraphView.h | 80 +-- .../FileDependencyGraphWidget.h | 2 +- .../FileDependencyInfoWidget.h | 10 +- .../dependencyAnalysis/FileDependencyItem.h | 44 +- .../dependencyAnalysis/FileDependencyModel.h | 70 +-- .../FileDependencySourceEditor.h | 12 +- .../fileSet/file/filebuildcommand.h | 18 +- .../fileSet/file/filedefinemodel.h | 56 +- .../ComponentEditor/fileSet/file/fileeditor.h | 22 +- .../fileSet/file/filegeneraleditor.h | 8 +- .../fileSet/file/filenameeditor.h | 8 +- .../fileSet/file/filesdelegate.h | 20 +- .../fileSet/file/fileseditor.h | 16 +- .../ComponentEditor/fileSet/file/filesmodel.h | 78 +-- .../ComponentEditor/fileSet/file/filesview.h | 6 +- .../fileSet/file/filetypeeditor.h | 12 +- .../fileSet/file/filetypeeditordelegate.h | 20 +- .../ComponentEditor/fileSet/fileseteditor.h | 20 +- .../fileSet/filesetsdelegate.h | 20 +- .../ComponentEditor/fileSet/filesetseditor.h | 8 +- .../ComponentEditor/fileSet/filesetsmodel.h | 54 +- .../ComponentEditor/fileSet/groupmanager.h | 6 +- .../fileSet/groupmanagerdelegate.h | 10 +- .../ComponentEditor/general/generaleditor.h | 8 +- .../IndirectInterfacesDelegate.h | 22 +- .../IndirectInterfacesEditor.h | 8 +- .../IndirectInterfacesModel.h | 52 +- .../SingleIndirectInterfaceEditor.h | 20 +- .../ComponentInstantiationDisplayer.h | 2 +- .../ComponentInstantiationEditor.h | 16 +- .../ComponentInstantiationsEditor.h | 10 +- .../ComponentInstantiationsModel.h | 52 +- .../DesignConfigurationInstantiationEditor.h | 14 +- .../DesignConfigurationInstantiationsEditor.h | 8 +- .../DesignConfigurationInstantiationsModel.h | 64 +-- .../DesignInstantiationEditor.h | 10 +- .../DesignInstantiationsDelegate.h | 2 +- .../DesignInstantiationsEditor.h | 8 +- .../DesignInstantiationsModel.h | 64 +-- .../instantiations/InstantiationsEditor.h | 12 +- .../instantiations/ModuleParameterDelegate.h | 48 +- .../instantiations/ModuleParameterEditor.h | 28 +- .../ModuleParameterHeaderView.h | 12 +- .../instantiations/ModuleParameterModel.h | 72 +-- .../instantiations/filesetrefeditor.h | 8 +- .../instantiations/filesetrefeditordelegate.h | 12 +- .../instantiations/filesetrefmodel.h | 10 +- editors/ComponentEditor/itemeditor.h | 32 +- editors/ComponentEditor/itemvisualizer.h | 2 +- .../memoryMaps/AccessPoliciesDelegate.h | 24 +- .../memoryMaps/AccessPoliciesModel.h | 46 +- .../memoryMaps/ExpressionProxyModel.h | 10 +- .../memoryMaps/FieldAccessPoliciesDelegate.h | 36 +- .../memoryMaps/FieldAccessPoliciesEditor.h | 4 +- .../memoryMaps/FieldAccessPoliciesModel.h | 70 +-- .../memoryMaps/MemoryBlockDelegate.h | 32 +- .../memoryMaps/MemoryBlockFilter.h | 12 +- .../memoryMaps/MemoryBlockModel.h | 102 ++-- .../memoryMaps/MemoryMapsView.h | 24 +- .../memoryMaps/RemapModeReferenceEditor.h | 4 +- .../memoryMaps/ResetsDelegate.h | 34 +- .../ComponentEditor/memoryMaps/ResetsEditor.h | 16 +- .../ComponentEditor/memoryMaps/ResetsModel.h | 76 +-- .../memoryMaps/SingleAddressBlockEditor.h | 44 +- .../memoryMaps/SingleFieldEditor.h | 50 +- .../memoryMaps/SingleMemoryMapEditor.h | 46 +- .../memoryMaps/SingleRegisterEditor.h | 36 +- .../memoryMaps/SingleRegisterFileEditor.h | 26 +- .../memoryMaps/SingleSubspaceMapEditor.h | 36 +- .../memoryMaps/SubspaceMapDelegate.h | 44 +- .../memoryMaps/SubspaceMapModel.h | 62 +-- .../memoryMaps/SubspaceMapsEditor.h | 32 +- .../memoryMaps/WriteValueConstraintComboBox.h | 6 +- .../memoryMaps/addressblockdelegate.h | 28 +- .../memoryMaps/addressblockeditor.h | 32 +- .../memoryMaps/addressblockmodel.h | 96 ++-- .../memoryMaps/enumeratedvaluedelegate.h | 20 +- .../memoryMaps/enumeratedvaluemodel.h | 56 +- .../ComponentEditor/memoryMaps/fieldeditor.h | 10 +- .../ReferenceCalculator.h | 6 +- .../MemoryBlockGraphItem.h | 14 +- .../SubspaceMapGraphItem.h | 22 +- .../addressblockgraphitem.h | 16 +- .../memoryMapsVisualizer/fieldgraphitem.h | 22 +- .../memoryMapsVisualizer/memorymapgraphitem.h | 20 +- .../memoryMapsVisualizer/memorymapscene.h | 8 +- .../memorymapsvisualizer.h | 10 +- .../memoryMapsVisualizer/memorymapview.h | 2 +- .../registerfilegraphitem.h | 16 +- .../memoryMapsVisualizer/registergraphitem.h | 34 +- .../memoryMaps/memorymapdelegate.h | 34 +- .../memoryMaps/memorymapeditor.h | 32 +- .../memoryMaps/memorymapmodel.h | 70 +-- .../memoryMaps/memorymapsdelegate.h | 38 +- .../memoryMaps/memorymapseditor.h | 36 +- .../memoryMaps/memorymapsmodel.h | 132 ++--- .../memoryMaps/registerdelegate.h | 28 +- .../memoryMaps/registereditor.h | 28 +- .../memoryMaps/registerfiledelegate.h | 10 +- .../memoryMaps/registerfileeditor.h | 26 +- .../memoryMaps/registerfilemodel.h | 86 +-- .../memoryMaps/registertablemodel.h | 104 ++-- .../modes/FieldSliceDelegate.h | 26 +- .../ComponentEditor/modes/FieldSliceEditor.h | 14 +- .../ComponentEditor/modes/FieldSliceModel.h | 44 +- editors/ComponentEditor/modes/ModesEditor.h | 8 +- editors/ComponentEditor/modes/ModesModel.h | 46 +- .../ComponentEditor/modes/PortSliceDelegate.h | 34 +- .../ComponentEditor/modes/PortSliceEditor.h | 14 +- .../ComponentEditor/modes/PortSliceModel.h | 60 +-- .../ComponentEditor/modes/SingleModeEditor.h | 12 +- .../otherClockDrivers/clockdriversdelegate.h | 20 +- .../otherclockdriverseditor.h | 8 +- .../otherclockdriversmodel.h | 50 +- .../ComponentParameterReferenceTree.h | 108 ++-- .../ParameterReferenceTree.h | 38 +- .../ParameterReferenceTreeWindow.h | 8 +- .../parameters/Array/ArrayDelegate.h | 20 +- .../parameters/Array/ArrayView.h | 8 +- .../parameters/Array/ParameterArrayModel.h | 88 ++-- .../parameters/ChoiceCreatorDelegate.h | 40 +- .../parameters/ComponentParameterModel.h | 44 +- .../parameters/ParameterDelegate.h | 106 ++-- .../parameters/ParameterEditorHeaderView.h | 18 +- .../parameters/ParametersView.h | 12 +- .../parameters/parameterseditor.h | 14 +- .../parameters/parametersmodel.h | 46 +- .../ComponentEditor/ports/MasterPortsEditor.h | 36 +- .../ports/PortSummaryDelegate.h | 28 +- .../ports/PortSummaryEditorFactory.h | 16 +- .../ComponentEditor/ports/PortSummaryFilter.h | 10 +- .../ComponentEditor/ports/PortSummaryModel.h | 76 +-- .../ComponentEditor/ports/PortSummaryView.h | 6 +- .../ports/PortTagEditorDelegate.h | 22 +- .../ports/PortTypeDefinitionDelegate.h | 20 +- .../ports/PortTypeDefinitionEditor.h | 6 +- .../ports/PortWireTypeDelegate.h | 66 +-- .../ports/PortWireTypeEditor.h | 10 +- .../ComponentEditor/ports/PortWireTypeModel.h | 78 +-- .../ComponentEditor/ports/PortWireTypeView.h | 4 +- .../ports/PortsEditorFactory.h | 16 +- editors/ComponentEditor/ports/PortsFilter.h | 22 +- editors/ComponentEditor/ports/PortsView.h | 16 +- .../ports/TransactionalPortsDelegate.h | 58 +-- .../ports/TransactionalPortsEditorFactory.h | 16 +- .../ports/TransactionalPortsFilter.h | 10 +- .../ports/TransactionalPortsModel.h | 82 +-- .../ComponentEditor/ports/TypedPortEditor.h | 28 +- .../ComponentEditor/ports/WirePortsDelegate.h | 50 +- .../ports/WirePortsEditorFactory.h | 16 +- .../ComponentEditor/ports/WirePortsFilter.h | 10 +- .../ComponentEditor/ports/WirePortsModel.h | 82 +-- editors/ComponentEditor/ports/portsdelegate.h | 88 ++-- editors/ComponentEditor/ports/portseditor.h | 20 +- editors/ComponentEditor/ports/portsmodel.h | 160 +++--- .../powerDomains/PowerDomainsDelegate.h | 32 +- .../powerDomains/PowerDomainsEditor.h | 10 +- .../powerDomains/PowerDomainsModel.h | 66 +-- .../ComponentParameterReferenceCounter.h | 356 ++++++------- .../ParameterReferenceCounter.h | 46 +- .../referenceCounter/ReferenceCounter.h | 8 +- .../remapStates/RemapConditionDelegate.h | 60 +-- .../remapStates/RemapConditionEditor.h | 18 +- .../remapStates/RemapConditionModel.h | 100 ++-- .../remapStates/RemapStatesEditor.h | 10 +- .../remapStates/RemapStatesModel.h | 50 +- .../remapStates/SingleRemapStateEditor.h | 14 +- .../remapStates/ValueOrIndexedValueEditor.h | 38 +- .../resetTypes/ResetTypesDelegate.h | 20 +- .../resetTypes/ResetTypesEditor.h | 8 +- .../resetTypes/ResetTypesModel.h | 44 +- .../software/PropertyValueDelegate.h | 22 +- .../software/PropertyValueEditor.h | 6 +- .../software/PropertyValueModel.h | 42 +- .../software/SWPropertiesEditor.h | 8 +- .../apiInterface/ApiInterfaceEditor.h | 10 +- .../apiInterface/apiinterfacesdelegate.h | 20 +- .../apiInterface/apiinterfaceseditor.h | 8 +- .../apiInterface/apiinterfacesmodel.h | 66 +-- .../comInterface/ComInterfaceEditor.h | 12 +- .../comInterface/cominterfacesdelegate.h | 20 +- .../comInterface/cominterfaceseditor.h | 8 +- .../comInterface/cominterfacesmodel.h | 66 +-- .../software/systemView/SystemViewEditor.h | 12 +- .../software/systemView/SystemViewsDelegate.h | 20 +- .../software/systemView/SystemViewsEditor.h | 8 +- .../software/systemView/SystemViewsModel.h | 66 +-- .../ComponentEditorChoicesItem.h | 20 +- .../ComponentEditorIndirectInterfacesItem.h | 32 +- .../ComponentEditorSystemViewItem.h | 22 +- .../ComponentEditorSystemViewsItem.h | 30 +- .../ComponentEditorTreeDelegate.h | 10 +- .../ComponentEditorTreeSortProxyModel.h | 18 +- .../ComponentInstantiationsItem.h | 32 +- .../DesignConfigurationInstantiationsItem.h | 28 +- .../treeStructure/DesignInstantiationsItem.h | 22 +- .../treeStructure/InstantiationsItem.h | 26 +- .../treeStructure/MemoryRemapItem.h | 60 +-- .../ComponentEditor/treeStructure/ModesItem.h | 28 +- .../treeStructure/ParameterizableItem.h | 14 +- .../treeStructure/PowerDomainsItem.h | 22 +- .../treeStructure/RemapStatesItem.h | 26 +- .../treeStructure/ResetTypesItem.h | 20 +- .../SingleComponentInstantiationItem.h | 24 +- .../treeStructure/SingleCpuItem.h | 22 +- ...ngleDesignConfigurationInstantiationItem.h | 28 +- .../SingleDesignInstantiationItem.h | 24 +- .../SingleIndirectInterfaceItem.h | 32 +- .../treeStructure/SingleModeItem.h | 24 +- .../treeStructure/SingleRemapStateItem.h | 24 +- .../treeStructure/SubspaceMapItem.h | 44 +- .../treeStructure/TransactionalPortsItem.h | 28 +- .../treeStructure/TypeDefinitionsItem.h | 18 +- .../treeStructure/WirePortsItem.h | 28 +- .../componenteditoraddrblockitem.h | 52 +- .../componenteditoraddrspaceitem.h | 40 +- .../componenteditoraddrspacesitem.h | 34 +- .../componenteditorapiinterfaceitem.h | 18 +- .../componenteditorapiinterfacesitem.h | 18 +- .../componenteditorbusinterfaceitem.h | 36 +- .../componenteditorbusinterfacesitem.h | 38 +- .../componenteditorchannelsitem.h | 20 +- .../componenteditorcominterfaceitem.h | 20 +- .../componenteditorcominterfacesitem.h | 18 +- .../treeStructure/componenteditorcpusitem.h | 22 +- .../treeStructure/componenteditorfielditem.h | 42 +- .../treeStructure/componenteditorfileitem.h | 50 +- .../componenteditorfilesetitem.h | 40 +- .../componenteditorfilesetsitem.h | 36 +- .../componenteditorgeneralitem.h | 20 +- .../treeStructure/componenteditoritem.h | 98 ++-- .../treeStructure/componenteditormemmapitem.h | 54 +- .../componenteditormemmapsitem.h | 52 +- .../componenteditormodelparamsitem.h | 14 +- .../componenteditorotherclocksitem.h | 20 +- .../componenteditorparametersitem.h | 26 +- .../treeStructure/componenteditorportsitem.h | 28 +- .../componenteditorregisterfileitem.h | 44 +- .../componenteditorregisteritem.h | 50 +- .../treeStructure/componenteditorrootitem.h | 2 +- .../componenteditorswpropertiesitem.h | 18 +- .../treeStructure/componenteditorswviewitem.h | 20 +- .../componenteditorswviewsitem.h | 18 +- .../treeStructure/componenteditortreemodel.h | 80 +-- .../treeStructure/componenteditorviewitem.h | 30 +- .../treeStructure/componenteditorviewsitem.h | 28 +- .../treeStructure/componenttreeview.h | 16 +- editors/ComponentEditor/views/ViewsDelegate.h | 2 +- .../views/envidentifiereditor.h | 6 +- .../views/envidentifiersmodel.h | 44 +- editors/ComponentEditor/views/vieweditor.h | 14 +- editors/ComponentEditor/views/viewseditor.h | 8 +- editors/ComponentEditor/views/viewsmodel.h | 46 +- .../visualization/AddressableItem.h | 30 +- .../visualization/fieldgapitem.h | 8 +- .../visualization/memorygapitem.h | 10 +- .../visualization/memoryvisualizationitem.h | 38 +- editors/ConfigurationTools/ViewConfigurer.h | 46 +- .../ViewConfigurerDelegate.h | 40 +- editors/HWDesign/ActiveBusInterfaceItem.h | 44 +- editors/HWDesign/ActivePortItem.h | 20 +- editors/HWDesign/AdHocConnectionItem.h | 2 +- editors/HWDesign/AdHocEnabled.h | 28 +- editors/HWDesign/AdHocItem.h | 50 +- .../AdhocEditor/AdHocVisibilityDelegate.h | 34 +- .../AdhocEditor/AdHocVisibilityEditor.h | 10 +- .../AdhocEditor/AdHocVisibilityModel.h | 46 +- .../AdhocEditor/AdHocVisibilityPolicy.h | 24 +- editors/HWDesign/AdhocEditor/AdhocEditor.h | 18 +- .../HWDesign/AdhocEditor/AdhocPortEditor.h | 56 +- editors/HWDesign/BusInterfaceDialog.h | 4 +- editors/HWDesign/BusInterfaceEndPoint.h | 98 ++-- editors/HWDesign/HWAddCommands.h | 30 +- editors/HWDesign/HWChangeCommands.h | 110 ++-- editors/HWDesign/HWComponentItem.h | 32 +- editors/HWDesign/HWConnection.h | 22 +- editors/HWDesign/HWConnectionEndpoint.h | 22 +- editors/HWDesign/HWDesignDiagram.h | 334 ++++++------ editors/HWDesign/HWDesignWidget.h | 54 +- editors/HWDesign/HWMoveCommands.h | 18 +- .../HWDesign/HierarchicalBusInterfaceItem.h | 46 +- editors/HWDesign/HierarchicalPortItem.h | 24 +- editors/HWDesign/OffPageConnectorItem.h | 42 +- editors/HWDesign/PortmapDialog.h | 10 +- editors/HWDesign/SelectItemTypeDialog.h | 4 +- editors/HWDesign/WarningSymbol.h | 12 +- .../HWDesign/columnview/ColumnEditDialog.h | 12 +- editors/HWDesign/columnview/HWColumn.h | 10 +- .../undoCommands/AdHocBoundsChangeCommand.h | 18 +- .../undoCommands/AdHocConnectionAddCommand.h | 8 +- .../AdHocConnectionDeleteCommand.h | 6 +- .../AdHocTieOffBoundsChangeCommand.h | 12 +- .../undoCommands/AdHocTieOffChangeCommand.h | 46 +- .../AdHocTieOffConnectionDeleteCommand.h | 6 +- .../undoCommands/AdHocTiedValueCommand.h | 20 +- .../AdHocVisibilityChangeCommand.h | 12 +- .../undoCommands/ColumnDeleteCommand.h | 8 +- .../undoCommands/ComponentDeleteCommand.h | 10 +- .../undoCommands/ComponentItemMoveCommand.h | 10 +- .../ConfigurableElementChangeCommand.h | 26 +- .../ConfigurableElementRemoveCommand.h | 30 +- .../undoCommands/ConnectionDeleteCommand.h | 6 +- .../undoCommands/HWColumnAddCommand.h | 20 +- .../undoCommands/HWComponentAddCommand.h | 8 +- .../undoCommands/InterfaceDeleteCommand.h | 4 +- .../undoCommands/PhysicalPortDeleteCommand.h | 6 +- .../HWDesign/undoCommands/PortDeleteCommand.h | 2 +- .../HWDesign/undoCommands/PortPasteCommand.h | 8 +- .../undoCommands/ReplaceComponentCommand.h | 26 +- .../TopAdHocVisibilityChangeCommand.h | 14 +- .../MemoryDesigner/AddressBlockGraphicsItem.h | 44 +- .../AddressSegmentGraphicsItem.h | 12 +- .../MemoryDesigner/AddressSpaceGraphicsItem.h | 24 +- .../MemoryDesigner/ConnectivityComponent.h | 22 +- .../MemoryDesigner/ConnectivityConnection.h | 12 +- editors/MemoryDesigner/ConnectivityGraph.h | 16 +- .../MemoryDesigner/ConnectivityGraphFactory.h | 294 +++++------ .../MemoryDesigner/ConnectivityInterface.h | 40 +- editors/MemoryDesigner/FieldGraphicsItem.h | 56 +- editors/MemoryDesigner/FieldOverlapItem.h | 16 +- .../MemoryDesigner/MainMemoryGraphicsItem.h | 78 +-- .../MemoryDesigner/MasterSlavePathSearch.h | 66 +-- editors/MemoryDesigner/MemoryCollisionItem.h | 6 +- editors/MemoryDesigner/MemoryColumn.h | 58 +-- editors/MemoryDesigner/MemoryColumnHandler.h | 36 +- .../MemoryConnectionAddressCalculator.h | 18 +- .../MemoryDesigner/MemoryConnectionHandler.h | 198 +++---- editors/MemoryDesigner/MemoryConnectionItem.h | 134 ++--- .../MemoryDesigner/MemoryDesignConstructor.h | 48 +- editors/MemoryDesigner/MemoryDesignDocument.h | 68 +-- .../MemoryDesignerChildGraphicsItem.h | 24 +- .../MemoryDesigner/MemoryDesignerConstants.h | 38 +- .../MemoryDesigner/MemoryDesignerDiagram.h | 52 +- .../MemoryDesignerGraphicsItem.h | 92 ++-- .../MemoryExtensionGraphicsItem.h | 12 +- .../MemoryGraphicsItemHandler.h | 56 +- editors/MemoryDesigner/MemoryItem.h | 72 +-- .../MemoryDesigner/MemoryMapGraphicsItem.h | 44 +- editors/MemoryDesigner/RegisterGraphicsItem.h | 122 ++--- editors/MemoryDesigner/SubMemoryLayout.h | 90 ++-- .../PythonSourceEditor/PythonSourceEditor.h | 18 +- .../PythonSourceHighlight.h | 6 +- .../PythonSourceEditor/ScriptInputEditor.h | 18 +- editors/PythonSourceEditor/ScriptViewEditor.h | 12 +- editors/SystemDesign/ApiGraphicsConnection.h | 24 +- editors/SystemDesign/ComGraphicsConnection.h | 24 +- editors/SystemDesign/HWMappingItem.h | 26 +- editors/SystemDesign/SWComponentItem.h | 18 +- editors/SystemDesign/SWConnectionEndpoint.h | 16 +- editors/SystemDesign/SWInterfaceItem.h | 54 +- editors/SystemDesign/SWPortItem.h | 48 +- editors/SystemDesign/SystemColumn.h | 12 +- editors/SystemDesign/SystemComponentItem.h | 46 +- editors/SystemDesign/SystemDesignDiagram.h | 192 +++---- editors/SystemDesign/SystemDesignWidget.h | 22 +- .../SystemDetailsEditor/ExportSWDialog.h | 4 +- .../SystemDetailsEditor/SwitchHWDialog.h | 12 +- .../SystemDetailsEditor/SystemDetailsEditor.h | 6 +- .../UndoCommands/ApiConnectionAddCommand.h | 10 +- .../UndoCommands/ApiConnectionDeleteCommand.h | 6 +- .../ApiConnectionExchangeCommand.h | 12 +- .../UndoCommands/ComConnectionAddCommand.h | 10 +- .../UndoCommands/ComConnectionDeleteCommand.h | 6 +- .../ComConnectionExchangeCommand.h | 12 +- .../ReplaceSystemComponentCommand.h | 30 +- .../UndoCommands/SWInterfaceAddCommand.h | 8 +- .../UndoCommands/SWInterfaceDeleteCommand.h | 8 +- .../UndoCommands/SWInterfaceMoveCommand.h | 24 +- .../UndoCommands/SWPortDeleteCommand.h | 6 +- .../UndoCommands/SystemAddCommands.h | 16 +- .../UndoCommands/SystemChangeCommands.h | 18 +- .../UndoCommands/SystemComponentAddCommand.h | 8 +- .../SystemComponentDeleteCommand.h | 8 +- .../UndoCommands/SystemDeleteCommands.h | 10 +- .../UndoCommands/SystemMoveCommands.h | 24 +- editors/common/Association/Associable.h | 10 +- editors/common/Association/Association.h | 16 +- .../Association/AssociationAddCommand.h | 6 +- .../AssociationChangeEndpointCommand.h | 8 +- .../Association/AssociationRemoveCommand.h | 6 +- editors/common/ComponentDesignDiagram.h | 204 ++++---- ...ponentInstanceConfigurableElementsEditor.h | 22 +- ...ponentInstanceConfigurableElementsFilter.h | 14 +- ...mponentInstanceConfigurableElementsModel.h | 28 +- .../ConfigurableElementsFilter.h | 22 +- .../ConfigurableElementsModel.h | 156 +++--- .../ConfigurableElementsView.h | 12 +- .../EditorConfigurableElement.h | 18 +- .../MissingConfigurableElementsFilter.h | 8 +- .../ParameterConfigurableElementsFilter.h | 12 +- .../PowerDomainLinkDelegate.h | 38 +- .../PowerDomainLinkEditor.h | 2 +- .../PowerDomainLinkModel.h | 32 +- .../componentinstanceeditor.h | 20 +- .../configurableelementdelegate.h | 134 ++--- .../configurableelementeditor.h | 12 +- .../AutoConnector.h | 20 +- .../AutoConnectorConnectionDelegate.h | 44 +- .../AutoConnectorConnectionTable.h | 32 +- .../AutoConnectorItem.h | 24 +- .../AutoConnectorListFilter.h | 16 +- .../BusInterfaceItemMatcher.h | 16 +- .../BusInterfaceListFiller.h | 4 +- .../BusInterfaceTableAutoConnector.h | 34 +- .../ComponentItemAutoConnector.h | 28 +- .../HierarchicalBusInterfaceItemMatcher.h | 6 +- ...erarchicalBusInterfaceTableAutoConnector.h | 12 +- .../HierarchicalPortItemMatcher.h | 4 +- .../HierarchicalPortTableAutoConnector.h | 10 +- .../ComponentItemAutoConnector/ListFiller.h | 10 +- .../PortItemMatcher.h | 14 +- .../PortListFiller.h | 4 +- .../PortTableAutoConnector.h | 28 +- .../TableAutoConnector.h | 76 +-- .../TableItemMatcher.h | 20 +- .../ConfigurationEditor/activevieweditor.h | 6 +- .../ConfigurationEditor/activeviewmodel.h | 70 +-- .../ConfigurationEditor/configurationeditor.h | 24 +- .../ConnectionEditor/AdHocBoundsModel.h | 48 +- .../ConnectionEditor/connectioneditor.h | 72 +-- editors/common/DesignCompletionModel.h | 12 +- editors/common/DesignDiagram.h | 102 ++-- editors/common/DesignDiagramResolver.h | 14 +- .../DesignParameterReferenceCounter.h | 36 +- .../DesignParameterReferenceTree.h | 32 +- editors/common/DesignWidget.h | 22 +- .../DesignWidgetFactoryImplementation.h | 6 +- editors/common/DiagramUtil.h | 18 +- editors/common/DocumentNameGroupEditor.h | 10 +- editors/common/GraphicsItemLabel.h | 10 +- editors/common/ImageExporter.h | 8 +- .../InterfacePortMapDelegate.h | 16 +- .../InterfaceEditor/InterfacePortMapModel.h | 48 +- .../common/InterfaceEditor/interfaceeditor.h | 28 +- editors/common/NamelabelWidth.h | 10 +- editors/common/PortUtilities.h | 12 +- editors/common/StickyNote/ColorFillTextItem.h | 6 +- editors/common/StickyNote/StickyNote.h | 34 +- .../common/StickyNote/StickyNoteAddCommand.h | 8 +- .../common/StickyNote/StickyNoteEditCommand.h | 12 +- .../common/StickyNote/StickyNoteMoveCommand.h | 6 +- .../StickyNote/StickyNoteRemoveCommand.h | 4 +- editors/common/TopComponentParameterFinder.h | 28 +- .../VendorExtensionAttributesModel.h | 58 +-- .../VendorExtensionsDelegate.h | 38 +- .../VendorExtensionsEditor.h | 10 +- .../VendorExtensionsFilter.h | 8 +- .../VendorExtensionsModel.h | 90 ++-- .../DocumentGenerator/DocumentationWriter.h | 240 ++++----- .../DocumentGenerator/HtmlWriter.h | 204 ++++---- .../DocumentGenerator/MarkdownWriter.h | 210 ++++---- .../DocumentGenerator/documentgenerator.h | 170 +++--- library/HierarchyView/hierarchyfilter.h | 10 +- library/HierarchyView/hierarchyview.h | 12 +- library/HierarchyView/hierarchywidget.h | 10 +- library/ItemExporter.h | 86 +-- library/LibraryErrorModel.h | 24 +- library/LibraryFilter.h | 36 +- library/LibraryItemSelectionFactory.h | 4 +- library/LibraryTreeFilter.h | 14 +- library/LibraryTreeView.h | 10 +- library/LibraryTreeWidget.h | 10 +- library/LibraryUtils.h | 10 +- library/LibraryWidget.h | 20 +- library/ObjectExportDialog.h | 8 +- library/ObjectSelectionDialog.h | 46 +- library/ObjectSelectionListItem.h | 16 +- library/TableViewDialog.h | 4 +- library/VLNVDialer/FilterGroup.h | 4 +- library/VLNVDialer/RevisionGroup.h | 8 +- library/VLNVDialer/ValidityGroup.h | 8 +- library/VLNVDialer/dialerwidget.h | 4 +- library/VLNVDialer/filterwidget.h | 8 +- library/VLNVDialer/firmnessgroup.h | 8 +- library/VLNVDialer/hierarchygroup.h | 8 +- library/VLNVDialer/implementationgroup.h | 8 +- library/VLNVDialer/typegroup.h | 6 +- library/VLNVDialer/vlnvdialer.h | 8 +- library/objectremovedialog.h | 4 +- mainwindow/CommandLineParser.h | 12 +- mainwindow/DeleteWorkspaceDialog.h | 4 +- mainwindow/DockWidgetHandler.h | 124 ++--- mainwindow/DrawingBoard/DrawingBoard.h | 16 +- mainwindow/MessageConsole/messageconsole.h | 8 +- mainwindow/NewPages/NewApiDefinitionPage.h | 6 +- mainwindow/NewPages/NewBusDefinitionPage.h | 2 +- mainwindow/NewPages/NewCatalogPage.h | 6 +- mainwindow/NewPages/NewComDefinitionPage.h | 6 +- mainwindow/NewPages/NewComponentPage.h | 8 +- mainwindow/NewPages/NewDesignPage.h | 8 +- mainwindow/NewPages/NewPage.h | 26 +- mainwindow/NewPages/NewSWComponentPage.h | 6 +- mainwindow/NewPages/NewSWDesignPage.h | 6 +- mainwindow/NewPages/NewSystemPage.h | 16 +- mainwindow/NewWorkspaceDialog.h | 2 +- mainwindow/Ribbon/Ribbon.h | 4 +- mainwindow/Ribbon/RibbonGroup.h | 4 +- .../SaveHierarchy/DocumentTreeBuilder.h | 18 +- .../HierarchicalSaveBuildStrategy.h | 64 +-- mainwindow/SaveHierarchy/SaveAsItem.h | 8 +- .../SaveHierarchy/SaveHierarchyDelegate.h | 34 +- .../SaveHierarchy/SaveHierarchyDialog.h | 4 +- mainwindow/WorkspaceSettings.h | 12 +- mainwindow/mainwindow.h | 164 +++--- settings/CodeEditorSettingsPage.h | 4 +- settings/ComponentEditorSettingsPage.h | 36 +- settings/FileTypeSettingsPage.h | 2 +- settings/FileTypesDelegate.h | 22 +- settings/FileTypesModel.h | 42 +- settings/GeneralSettingsPage.h | 4 +- settings/NamingPolicySettingsPage.h | 4 +- settings/NewPluginsDialog.h | 6 +- settings/PluginInfoWidget.h | 6 +- settings/PluginSettingsPage.h | 12 +- settings/SettingsDialog.h | 2 +- settings/SettingsPage.h | 4 +- settings/SettingsUpdater.h | 14 +- settings/k2envvarmodel.h | 52 +- tests/MockObjects/LibraryMock.h | 130 ++--- .../BusInterfaceWizard/BusInterfaceWizard.h | 18 +- .../BusInterfaceWizardAbsDefinitionPage.h | 42 +- .../BusInterfaceWizardBusDefinitionPage.h | 8 +- .../BusInterfaceWizardConclusionPage.h | 6 +- .../BusInterfaceWizardGeneralOptionsPage.h | 30 +- .../BusInterfaceWizardPortMapPage.h | 22 +- wizards/ComponentWizard/ComponentWizard.h | 16 +- .../ComponentWizardConclusionPage.h | 14 +- .../ComponentWizardDependencyPage.h | 10 +- .../ComponentWizardGeneralInfoPage.h | 4 +- .../ComponentWizardImportPage.h | 48 +- .../ComponentWizardIntroPage.h | 2 +- .../ComponentWizardViewsPage.h | 30 +- wizards/ComponentWizard/ImportEditor.h | 32 +- wizards/ComponentWizard/ViewListModel.h | 14 +- .../ImportInstancesDelegate.h | 54 +- .../ImportInstancesEditor.h | 66 +-- wizards/ImportWizard/ImportWizard.h | 8 +- wizards/ImportWizard/ImportWizardImportPage.h | 12 +- .../ImportWizard/ImportWizardInstancesPage.h | 6 +- wizards/ImportWizard/ImportWizardIntroPage.h | 2 +- .../ComponentComparator/ComponentComparator.h | 44 +- .../ComponentDiffWidget/ComponentDiffWidget.h | 50 +- wizards/common/IPXactDiff.h | 20 +- wizards/common/IPXactElementComparator.h | 32 +- wizards/common/ListComparator.h | 18 +- .../ModuleParameterComparator.h | 26 +- .../ParameterComparator/ParameterComparator.h | 26 +- .../common/PortComparator/PortComparator.h | 38 +- .../common/VLNVComparator/VLNVComparator.h | 14 +- .../common/ViewComparator/ViewComparator.h | 48 +- 1281 files changed, 22494 insertions(+), 22494 deletions(-) diff --git a/Help/HelpSystem/ContextHelpBrowser.h b/Help/HelpSystem/ContextHelpBrowser.h index e511c5b95..0dd81a27c 100644 --- a/Help/HelpSystem/ContextHelpBrowser.h +++ b/Help/HelpSystem/ContextHelpBrowser.h @@ -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); @@ -45,7 +45,7 @@ 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); @@ -53,7 +53,7 @@ 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); diff --git a/Help/HelpSystem/HelpWindow.h b/Help/HelpSystem/HelpWindow.h index 0a4d6bfd2..d271cfd0b 100644 --- a/Help/HelpSystem/HelpWindow.h +++ b/Help/HelpSystem/HelpWindow.h @@ -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); diff --git a/IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h b/IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h index b238932f0..808afea82 100644 --- a/IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h +++ b/IPXACTmodels/AbstractionDefinition/AbstractionDefinition.h @@ -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 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 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. */ @@ -97,30 +97,30 @@ 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; @@ -128,11 +128,11 @@ class IPXACTMODELS_EXPORT AbstractionDefinition: public Document /*! * 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; @@ -140,16 +140,16 @@ class IPXACTMODELS_EXPORT AbstractionDefinition: public Document /*! * 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 getPort(QString const& portName) const; /*! * Gets the logical ports in the abstraction description. * - * @return The logical ports. + * @return The logical ports. */ QSharedPointer > > getLogicalPorts() const; @@ -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 > > choices); /*! * Gets the choices of the abstraction description. * - * @return The choices. + * @return The choices. */ QSharedPointer > > getChoices() const; diff --git a/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionReader.h b/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionReader.h index 6a65432ad..53ff802c7 100644 --- a/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionReader.h +++ b/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionReader.h @@ -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 createAbstractionDefinitionFrom(QDomNode const& document); @@ -42,8 +42,8 @@ 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 abstractionDefinion); @@ -51,8 +51,8 @@ namespace AbstractionDefinitionReader /*! * 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 abstractionDefinion); @@ -60,8 +60,8 @@ namespace AbstractionDefinitionReader /*! * 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 abstractionDefinion, Document::Revision revision); @@ -69,33 +69,33 @@ namespace AbstractionDefinitionReader /*! * 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 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 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 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 port, Document::Revision revision); diff --git a/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionWriter.h b/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionWriter.h index 8822c487f..cef1390b7 100644 --- a/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionWriter.h +++ b/IPXACTmodels/AbstractionDefinition/AbstractionDefinitionWriter.h @@ -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); @@ -46,32 +46,32 @@ 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); /*! * 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 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); /*! * 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 logicalPort, Document::Revision revision); @@ -79,8 +79,8 @@ namespace AbstractionDefinitionWriter /*! * 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 logicalPort, Document::Revision revision); @@ -88,8 +88,8 @@ namespace AbstractionDefinitionWriter /*! * 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 logicalPort, Document::Revision revision); diff --git a/IPXACTmodels/AbstractionDefinition/Packet.h b/IPXACTmodels/AbstractionDefinition/Packet.h index 3b9e7fd12..293f98fab 100644 --- a/IPXACTmodels/AbstractionDefinition/Packet.h +++ b/IPXACTmodels/AbstractionDefinition/Packet.h @@ -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 > > getPacketFields() const; /*! * Set the packet fields. * - * @param [in] packetFields The new packet fields. + * @param [in] packetFields The new packet fields. */ void setPacketFields(QSharedPointer > > packetFields); diff --git a/IPXACTmodels/AbstractionDefinition/PacketField.h b/IPXACTmodels/AbstractionDefinition/PacketField.h index 326231a0f..cb27163ab 100644 --- a/IPXACTmodels/AbstractionDefinition/PacketField.h +++ b/IPXACTmodels/AbstractionDefinition/PacketField.h @@ -43,49 +43,49 @@ class IPXACTMODELS_EXPORT PacketField : public NameGroup, public Extendable /*! * Sets the packet field width. * - * @param [in] width The packet field width in bits. + * @param [in] width The packet field width in bits. */ void setWidth(QString const& width); /*! * Get the packet field value. * - * @return The packet field value. + * @return The packet field value. */ QString getValue() const; /*! * Set the packet field value. * - * @param [in] value The new packet field value. + * @param [in] value The new packet field value. */ void setValue(QString const& value); /*! * Get the packet field endianness. * - * @return The packet field endianness. + * @return The packet field endianness. */ QString getEndianness() const; /*! * Set the packet field endianness. * - * @param [in] endianness The new packet field endianness. + * @param [in] endianness The new packet field endianness. */ void setEndianness(QString const& endianness); /*! * Get the packet field qualifier. * - * @return The packet field qualifier. + * @return The packet field qualifier. */ QSharedPointer getQualifier() const; /*! * Set the packet field qualifier. * - * @param [in] qualifier The new packet field qualifier. + * @param [in] qualifier The new packet field qualifier. */ void setQualifier(QSharedPointer const& qualifier); diff --git a/IPXACTmodels/AbstractionDefinition/PacketReader.h b/IPXACTmodels/AbstractionDefinition/PacketReader.h index fd43c30f0..5be409d7c 100644 --- a/IPXACTmodels/AbstractionDefinition/PacketReader.h +++ b/IPXACTmodels/AbstractionDefinition/PacketReader.h @@ -28,9 +28,9 @@ namespace PacketReader /*! * Creates a packet from XML description. * - * @param [in] packetNode The XML document node to create the packet from. + * @param [in] packetNode The XML document node to create the packet from. * - * @return The created packet. + * @return The created packet. */ QSharedPointer createPacketFrom(QDomNode const& packetNode); @@ -39,24 +39,24 @@ namespace PacketReader /*! * Parse the packet name group. * - * @param [in] packetNode The XML document node of the packet. - * @param [in/out] packet The packet definition to write to. + * @param [in] packetNode The XML document node of the packet. + * @param [in/out] packet The packet definition to write to. */ void parseNameGroup(QDomNode const& packetNode, QSharedPointer packet); /*! * Parse the packet fields of the packet. * - * @param [in] packetNode The XML document node of the packet. - * @param [in/out] packet The packet definition to inserts packet fields into. + * @param [in] packetNode The XML document node of the packet. + * @param [in/out] packet The packet definition to inserts packet fields into. */ void parsePacketFields(QDomNode const& packetNode, QSharedPointer packet); /*! * Parse a single packet field. * - * @param [in] fieldNode The XML description of the packet field. - * @param [in/out] packetFields The list of packet field definitions. + * @param [in] fieldNode The XML description of the packet field. + * @param [in/out] packetFields The list of packet field definitions. */ void parseSinglePacketField(QDomNode const& fieldNode, QSharedPointer > > packetFields); diff --git a/IPXACTmodels/AbstractionDefinition/PortAbstraction.h b/IPXACTmodels/AbstractionDefinition/PortAbstraction.h index 089b5cd41..42159195f 100644 --- a/IPXACTmodels/AbstractionDefinition/PortAbstraction.h +++ b/IPXACTmodels/AbstractionDefinition/PortAbstraction.h @@ -51,151 +51,151 @@ class IPXACTMODELS_EXPORT PortAbstraction : public NameGroup, public Extendable /*! * Sets the logical name of the port. * - * @param [in] logicalName The name of the port to set. + * @param [in] logicalName The name of the port to set. */ void setLogicalName(QString const& logicalName); /*! * Gets the logical name of the port. * - * @return The name of the port. + * @return The name of the port. */ QString getLogicalName() const; /*! * Sets the condition for the port existence. * - * @param [in] presentExpression The condition when port is present. + * @param [in] presentExpression The condition when port is present. */ void setIsPresent(QString const& presentExpression); /*! * Gets the condition for the port existence. * - * @return The condition when the port is present in the document. + * @return The condition when the port is present in the document. */ QString isPresent() const; /*! * Sets the port match. * - * @param [in] match The match flag. + * @param [in] match The match flag. */ void setMatch(bool match); /*! * Gets the port match. * - * @return True, if port has to be present on both sides of a connection. + * @return True, if port has to be present on both sides of a connection. */ bool getMatch() const; /*! * Checks if the port has wire definition. * - * @return True, if the port is a wire definition, otherwise false. + * @return True, if the port is a wire definition, otherwise false. */ bool hasWire() const; /*! * Sets the wire definition for the port. * - * @param [in] wire The wire to set. + * @param [in] wire The wire to set. */ void setWire(QSharedPointer wire); /*! * Gets the wire definition of the port. * - * @return The wire definition. + * @return The wire definition. */ QSharedPointer getWire() const; /*! * Checks if the port has transactional definition. * - * @return True, if the port is a transactional definition, otherwise false. + * @return True, if the port is a transactional definition, otherwise false. */ bool hasTransactional() const; /*! * Sets the transactional definition for the port. * - * @param [in] transactional The transactional definition to set. + * @param [in] transactional The transactional definition to set. */ void setTransactional(QSharedPointer transactional); /*! * Gets the transactional definition of the port. * - * @return The transactional definition. + * @return The transactional definition. */ QSharedPointer getTransactional() const; /*! * Sets the packets of the port. * - * @param [in] packets The packets to set. + * @param [in] packets The packets to set. */ void setPackets(QSharedPointer > > packets); /*! * Gets the packets of the port. * - * @return The port packets. + * @return The port packets. */ QSharedPointer > > getPackets() const; /*! Get the default value of the wire port. * - * @return The default value set for the wire port. + * @return The default value set for the wire port. */ QString getDefaultValue() const; /*! Set the default value for the wire port. * - * @param [in] defaultValue The default value to set. + * @param [in] defaultValue The default value to set. */ void setDefaultValue(QString const& defaultValue); /*! * Gets the wire qualifier. * - * @return The wire qualifier. + * @return The wire qualifier. */ QSharedPointer getQualifier(); /*! * Sets the wire driver requirement. * - * @param [in] requiresDriver Whether or not the driver is required on the wire. + * @param [in] requiresDriver Whether or not the driver is required on the wire. */ void setRequiresDriver(bool requiresDriver); /*! * Checks if the wire requires a driver. * - * @return True, if a driver is required, otherwise false. + * @return True, if a driver is required, otherwise false. */ bool requiresDriver() const; /*! * Gets the presence requirement for the port in given interface mode. * - * @param [in] mode The mode to get the presence for. - * @param [in] systemGroup The system group, if applicable. + * @param [in] mode The mode to get the presence for. + * @param [in] systemGroup The system group, if applicable. * - * @return The required presence for the mode. + * @return The required presence for the mode. */ PresenceTypes::Presence getPresence(General::InterfaceMode mode, QString const& systemGroup) const; /*! * Check if the port has the selected interface mode. * - * @param [in] mode The selected interface mode. - * @param [in] systemGroup The system group, if applicable. + * @param [in] mode The selected interface mode. + * @param [in] systemGroup The system group, if applicable. * - * @return True, if the port has the selected mode, otherwise false. + * @return True, if the port has the selected mode, otherwise false. */ bool hasMode(General::InterfaceMode mode, QString const& systemGroup) const; diff --git a/IPXACTmodels/AbstractionDefinition/TransactionalAbstraction.h b/IPXACTmodels/AbstractionDefinition/TransactionalAbstraction.h index fdb769b6a..cfc9413a8 100644 --- a/IPXACTmodels/AbstractionDefinition/TransactionalAbstraction.h +++ b/IPXACTmodels/AbstractionDefinition/TransactionalAbstraction.h @@ -47,158 +47,158 @@ class IPXACTMODELS_EXPORT TransactionalAbstraction /*! * Sets a qualifier for the information the transaction carries. * - * @param [in] qualifier The qualifier to set. + * @param [in] qualifier The qualifier to set. */ void setQualifier(QSharedPointer qualifier); /*! * Add a qualifier type for the information the transaction carries. * - * @param [in] qualifierType The qualifier type to add. + * @param [in] qualifierType The qualifier type to add. */ void addQualifier(Qualifier::Type qualifierType); /*! * Gets the qualifier for the information the transaction carries. * - * @return The wire qualifier. + * @return The wire qualifier. */ QSharedPointer getQualifier(); /*! * Adds a system port definition for the transaction definition. * - * @param [in] systemPort The system transaction port to add. + * @param [in] systemPort The system transaction port to add. */ void addSystemPort(QSharedPointer systemPort); /*! * Gets the system port definitions for the transaction definition. * - * @return The system ports for the transaction definition. + * @return The system ports for the transaction definition. */ QSharedPointer > > getSystemPorts() const; /*! * Find the selected system port. * - * @param [in] systemGroup The selected interface system group. + * @param [in] systemGroup The selected interface system group. * - * @return The selected system port, if it exists. + * @return The selected system port, if it exists. */ QSharedPointer findSystemPort(QString const& systemGroup) const; /*! * Checks if the transactional has a port definition for initiator mode. * - * @return True, if initiator mode is defined, otherwise false. + * @return True, if initiator mode is defined, otherwise false. */ bool hasInitiatorPort() const; /*! * Sets the initiator mode port definitions for the transactional. * - * @param [in] initiatorPort The initiator port definition for the transactional. + * @param [in] initiatorPort The initiator port definition for the transactional. */ void setInitiatorPort(QSharedPointer initiatorPort); /*! * Gets the initiator mode port definitions for the transactional. * - * @return The initiator port definition for the transactional. + * @return The initiator port definition for the transactional. */ QSharedPointer getInitiatorPort() const; /*! * Checks if the transactional has a port definition for target mode. * - * @return True, if target mode is defined, otherwise false. + * @return True, if target mode is defined, otherwise false. */ bool hasTargetPort() const; /*! * Sets the target mode port definitions for the transactional. * - * @param [in] slavePort The target port definition for the transactional. + * @param [in] slavePort The target port definition for the transactional. */ void setTargetPort(QSharedPointer targetPort); /*! * Gets the target mode port definitions for the transactional. * - * @return The target port definition for the transactional. + * @return The target port definition for the transactional. */ QSharedPointer getTargetPort() const; /*! * Checks if the transaction definition has a port definition for master mode. * - * @return True, if master mode is defined, otherwise false. + * @return True, if master mode is defined, otherwise false. */ bool hasMasterPort() const; /*! * Sets the master mode port definitions for the transaction definition. * - * @param [in] masterPort The master port definition for the transaction definition. + * @param [in] masterPort The master port definition for the transaction definition. */ void setMasterPort(QSharedPointer masterPort); /*! * Gets the master mode port definitions for the transaction definition. * - * @return The master port definition for the transaction definition. + * @return The master port definition for the transaction definition. */ QSharedPointer getMasterPort() const; /*! * Checks if the transaction definition has a port definition for slave mode. * - * @return True, if slave mode is defined, otherwise false. + * @return True, if slave mode is defined, otherwise false. */ bool hasSlavePort() const; /*! * Sets the slave mode port definitions for the transaction definition. * - * @param [in] slavePort The slave port definition for the transaction definition. + * @param [in] slavePort The slave port definition for the transaction definition. */ void setSlavePort(QSharedPointer slavePort); /*! * Gets the slave mode port definitions for the transaction definition. * - * @return The slave port definition for the transaction definition. + * @return The slave port definition for the transaction definition. */ QSharedPointer getSlavePort() const; /*! * Check if the transactional has the selected interface mode. * - * @param [in] mode The selected interface mode. - * @param [in] systemGroup The selected interface system group. + * @param [in] mode The selected interface mode. + * @param [in] systemGroup The selected interface system group. * - * @return True, if the transactional has the selected mode, otherwise false. + * @return True, if the transactional has the selected mode, otherwise false. */ bool hasMode(General::InterfaceMode mode, QString const& systemGroup) const; /*! * Get the initiative of the selected interface mode. * - * @param [in] mode The selected interface mode. - * @param [in] systemGroup The selected interface system group. + * @param [in] mode The selected interface mode. + * @param [in] systemGroup The selected interface system group. * - * @return The initiative of the selected mode. + * @return The initiative of the selected mode. */ QString getInitiative(General::InterfaceMode mode, QString const& systemGroup) const; /*! * Get the width of the selected interface mode. * - * @param [in] mode The selected interface mode. - * @param [in] systemGroup The selected interface system group. + * @param [in] mode The selected interface mode. + * @param [in] systemGroup The selected interface system group. * - * @return The width of the selected mode. + * @return The width of the selected mode. */ QString getWidth(General::InterfaceMode mode, QString const& systemGroup) const; diff --git a/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionReader.h b/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionReader.h index 2ff68e4ae..81ef5469e 100644 --- a/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionReader.h +++ b/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionReader.h @@ -30,9 +30,9 @@ namespace TransactionalAbstractionReader /*! * Creates a transactional for abstraction definition from XML description. * - * @param [in] transactionalNode The XML document to create the transactional definition from. + * @param [in] transactionalNode The XML document to create the transactional definition from. * - * @return The created transactional definition. + * @return The created transactional definition. */ QSharedPointer createTransactionalAbstractionFrom(QDomNode const& transactionalNode, Document::Revision revision); @@ -42,9 +42,9 @@ namespace TransactionalAbstractionReader /*! * Reads the qualifier from XML to a transactional. * - * @param [in] transactionalNode The XML description of the transactional. - * @param [in/out] transactional The transactional definition to insert the qualifier into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] transactionalNode The XML description of the transactional. + * @param [in/out] transactional The transactional definition to insert the qualifier into. + * @param [in] revision The standard revision of the XML document being read. */ void parseQualifier(QDomNode const& transactionalNode, QSharedPointer transactional, Document::Revision revision); @@ -52,33 +52,33 @@ namespace TransactionalAbstractionReader /*! * Reads the system ports from XML to a transactional. * - * @param [in] transactionalNode The XML description of the transactional. - * @param [in/out] transactional The transactional definition to insert the system ports into. + * @param [in] transactionalNode The XML description of the transactional. + * @param [in/out] transactional The transactional definition to insert the system ports into. */ void parseSystems(QDomNode const& transactionalNode, QSharedPointer transactional); /*! * Creates a transactionalPort for a transactional from XML description. * - * @param [in] transactionalPortNode The XML description of the transactionalPort. + * @param [in] transactionalPortNode The XML description of the transactionalPort. * - * @return The created transactionalPort. + * @return The created transactionalPort. */ QSharedPointer parseTransactionalPort(QDomNode const& portNode); /*! * Reads the protocol description for transactional port. * - * @param [in] portNode The XML description of the transactionalPort. - * @param [in/out] transactionalPort The transactional port to insert the protocol into. + * @param [in] portNode The XML description of the transactionalPort. + * @param [in/out] transactionalPort The transactional port to insert the protocol into. */ void parseProtocol(QDomNode const& portNode, QSharedPointer transactionalPort); /*! * Reads the initiator port from XML to a transactional. * - * @param [in] transactionalNode The XML description of the transactional. - * @param [in/out] transactional The transactional definition to insert the initiator port into. + * @param [in] transactionalNode The XML description of the transactional. + * @param [in/out] transactional The transactional definition to insert the initiator port into. */ void parseInitiator(QDomNode const& transactionalNode, QSharedPointer transactional, Document::Revision revision); @@ -86,8 +86,8 @@ namespace TransactionalAbstractionReader /*! * Reads the target port from XML to a transactional. * - * @param [in] transactionalNode The XML description of the transactional. - * @param [in/out] transactional The transactional definition to insert the target port into. + * @param [in] transactionalNode The XML description of the transactional. + * @param [in/out] transactional The transactional definition to insert the target port into. */ void parseTarget(QDomNode const& transactionalNode, QSharedPointer transactional, Document::Revision revision); diff --git a/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionWriter.h b/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionWriter.h index c2ac834a9..e7057056a 100644 --- a/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionWriter.h +++ b/IPXACTmodels/AbstractionDefinition/TransactionalAbstractionWriter.h @@ -31,9 +31,9 @@ namespace TransactionalAbstractionWriter /*! * Writes the given transactional description into XML. * - * @param [in] writer The XML writer to use. - * @param [in] transactional The transactional to write. - * @param [in] revision The document standard revision to use. + * @param [in] writer The XML writer to use. + * @param [in] transactional The transactional to write. + * @param [in] revision The document standard revision to use. */ IPXACTMODELS_EXPORT void writeTransactional(QXmlStreamWriter& writer, QSharedPointer transactional, Document::Revision revision); @@ -43,65 +43,65 @@ namespace TransactionalAbstractionWriter /*! * Writes the system port for the given transactional into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The transactional whose system port to write. + * @param [in] writer The XML writer to use. + * @param [in] wire The transactional whose system port to write. */ void writeSystem(QXmlStreamWriter& writer, QSharedPointer transactional); /*! * Writes the transactional port on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] port The transactional port to write. + * @param [in] writer The XML writer to use. + * @param [in] port The transactional port to write. */ void writeTransactionalPort(QXmlStreamWriter& writer, QSharedPointer port); /*! * Writes the transactional port presence on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] port The transactional port whose presence to write. + * @param [in] writer The XML writer to use. + * @param [in] port The transactional port whose presence to write. */ void writePresence(QXmlStreamWriter& writer, QSharedPointer port); /*! * Writes the transactional port initiative on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] port The transactional port whose initiative to write. + * @param [in] writer The XML writer to use. + * @param [in] port The transactional port whose initiative to write. */ void writeInitiative(QXmlStreamWriter& writer, QSharedPointer port); /*! * Writes the transactional port type on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] port The transactional port whose type to write. + * @param [in] writer The XML writer to use. + * @param [in] port The transactional port whose type to write. */ void writeKind(QXmlStreamWriter& writer, QSharedPointer port); /*! * Writes the transactional port width in bits on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] port The transactional port whose width to write. + * @param [in] writer The XML writer to use. + * @param [in] port The transactional port whose width to write. */ void writeBusWidth(QXmlStreamWriter& writer, QSharedPointer port); /*! * Writes the transactional port protocol vendor extensions on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] portProtocol The protocol whose vendor extensions to write. + * @param [in] writer The XML writer to use. + * @param [in] portProtocol The protocol whose vendor extensions to write. */ void writeVendorExtensions(QXmlStreamWriter& writer, QSharedPointer portProtocol); /*! * Writes the master port for the given transactional into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The transactional whose master port to write. - * @param [in] elementName The XML element name to use. + * @param [in] writer The XML writer to use. + * @param [in] wire The transactional whose master port to write. + * @param [in] elementName The XML element name to use. */ void writeMaster(QXmlStreamWriter& writer, QSharedPointer transactional, QString const& elementName); @@ -109,9 +109,9 @@ namespace TransactionalAbstractionWriter /*! * Writes the slave port for the given transactional into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The transactional whose slave port to write. - * @param [in] elementName The XML element name to use. + * @param [in] writer The XML writer to use. + * @param [in] wire The transactional whose slave port to write. + * @param [in] elementName The XML element name to use. */ void writeSlave(QXmlStreamWriter& writer, QSharedPointer transactional, QString const& elementName); diff --git a/IPXACTmodels/AbstractionDefinition/TransactionalPort.h b/IPXACTmodels/AbstractionDefinition/TransactionalPort.h index 913380a56..53ad3801f 100644 --- a/IPXACTmodels/AbstractionDefinition/TransactionalPort.h +++ b/IPXACTmodels/AbstractionDefinition/TransactionalPort.h @@ -40,70 +40,70 @@ class IPXACTMODELS_EXPORT TransactionalPort /*! * Sets the group name for system mode. * - * @param [in] groupName The system group to set. + * @param [in] groupName The system group to set. */ void setSystemGroup(QString const& group); /*! * Gets the group name for system mode. * - * @return The system group the transactional port belongs to. + * @return The system group the transactional port belongs to. */ QString getSystemGroup() const; /*! * Sets the presence restriction for the port. * - * @param [in] presence The restriction to set. + * @param [in] presence The restriction to set. */ void setPresence(PresenceTypes::Presence presence); /*! * Gets the presence restriction for the port. * - * @return The presence restriction for the port. + * @return The presence restriction for the port. */ PresenceTypes::Presence getPresence() const; /*! * Sets the access type for the transactional port. * - * @param [in] initiative The access type to set. + * @param [in] initiative The access type to set. */ void setInitiative(QString const& initiative); /*! * Gets the access type for the transactional port. * - * @return The access type for the port. + * @return The access type for the port. */ QString getInitiative() const; /*! * Sets the port type. * - * @param [in] kind The port type to set. + * @param [in] kind The port type to set. */ void setKind(QString const& kind); /*! * Gets the port type. * - * @return The port type. + * @return The port type. */ QString getKind() const; /*! * Sets the data width on the bus. * - * @param [in] widthExpression The number of bits on the bus. + * @param [in] widthExpression The number of bits on the bus. */ void setBusWidth(QString const& widthExpression); /*! * Gets the data width on the bus. * - * @return The number of bits on the bus. + * @return The number of bits on the bus. */ QString getBusWidth() const; @@ -111,21 +111,21 @@ class IPXACTMODELS_EXPORT TransactionalPort * Checks if a protocol has been defined for the port. * * - * @return True, if a protocol is defined, otherwise false. + * @return True, if a protocol is defined, otherwise false. */ bool hasProtocol() const; /*! * Sets the protocol for the information transportation. * - * @param [in] portProtocol The protocol to use on the port. + * @param [in] portProtocol The protocol to use on the port. */ void setProtocol(QSharedPointer portProtocol); /*! * Gets the protocol for the information transportation. * - * @return The protocol used on the port. + * @return The protocol used on the port. */ QSharedPointer getProtocol() const; diff --git a/IPXACTmodels/AbstractionDefinition/WireAbstraction.h b/IPXACTmodels/AbstractionDefinition/WireAbstraction.h index 6a22d1fdc..d6bba611b 100644 --- a/IPXACTmodels/AbstractionDefinition/WireAbstraction.h +++ b/IPXACTmodels/AbstractionDefinition/WireAbstraction.h @@ -42,177 +42,177 @@ class IPXACTMODELS_EXPORT WireAbstraction /*! Sets the default value for this wire. * - * @param [in] defaultValue The new default value. + * @param [in] defaultValue The new default value. */ void setDefaultValue(QString const& defaultValue); /*! Gets the default value of this wire. * - * @return The default value + * @return The default value */ QString getDefaultValue() const; /*! * Sets a qualifier for the information the wire carries. * - * @param [in] qualifier The qualifier to set. + * @param [in] qualifier The qualifier to set. */ void setQualifier(QSharedPointer qualifier); /*! * Add a qualifier type for the information the wire carries. * - * @param [in] qualifierType The qualifier type to add. + * @param [in] qualifierType The qualifier type to add. */ void addQualifier(Qualifier::Type qualifierType); /*! * Gets the qualifier for the information the wire carries. * - * @return The wire qualifier. + * @return The wire qualifier. */ QSharedPointer getQualifier(); /*! * Adds a system port definition for the wire. * - * @param [in] systemPort The system wire port to add. + * @param [in] systemPort The system wire port to add. */ void addSystemPort(QSharedPointer systemPort); /*! * Gets the system port definitions for the wire. * - * @return The system ports for the wire. + * @return The system ports for the wire. */ QSharedPointer > > getSystemPorts() const; /*! * Finds system port corresponding the name. * - * @return The wire port corresponding the name if it exists, else null. + * @return The wire port corresponding the name if it exists, else null. */ QSharedPointer findSystemPort(QString const& groupName) const; /*! * Checks if the wire has a port definition for initiator mode. * - * @return True, if initiator mode is defined, otherwise false. + * @return True, if initiator mode is defined, otherwise false. */ bool hasInitiatorPort() const; /*! * Sets the initiator mode port definitions for the wire. * - * @param [in] initiatorPort The initiator port definition for the wire. + * @param [in] initiatorPort The initiator port definition for the wire. */ void setInitiatorPort(QSharedPointer initiatorPort); /*! * Gets the initiator mode port definitions for the wire. * - * @return The initiator port definition for the wire. + * @return The initiator port definition for the wire. */ QSharedPointer getInitiatorPort() const; /*! * Checks if the wire has a port definition for target mode. * - * @return True, if target mode is defined, otherwise false. + * @return True, if target mode is defined, otherwise false. */ bool hasTargetPort() const; /*! * Sets the target mode port definitions for the wire. * - * @param [in] slavePort The target port definition for the wire. + * @param [in] slavePort The target port definition for the wire. */ void setTargetPort(QSharedPointer targetPort); /*! * Gets the target mode port definitions for the wire. * - * @return The target port definition for the wire. + * @return The target port definition for the wire. */ QSharedPointer getTargetPort() const; /*! * Checks if the wire has a port definition for master mode. * - * @return True, if master mode is defined, otherwise false. + * @return True, if master mode is defined, otherwise false. */ bool hasMasterPort() const; /*! * Sets the master mode port definitions for the wire. * - * @param [in] masterPort The master port definition for the wire. + * @param [in] masterPort The master port definition for the wire. */ void setMasterPort(QSharedPointer masterPort); /*! * Gets the master mode port definitions for the wire. * - * @return The master port definition for the wire. + * @return The master port definition for the wire. */ QSharedPointer getMasterPort() const; /*! * Checks if the wire has a port definition for slave mode. * - * @return True, if slave mode is defined, otherwise false. + * @return True, if slave mode is defined, otherwise false. */ bool hasSlavePort() const; /*! * Sets the slave mode port definitions for the wire. * - * @param [in] slavePort The slave port definition for the wire. + * @param [in] slavePort The slave port definition for the wire. */ void setSlavePort(QSharedPointer slavePort); /*! * Gets the slave mode port definitions for the wire. * - * @return The slave port definition for the wire. + * @return The slave port definition for the wire. */ QSharedPointer getSlavePort() const; /*! * Sets the wire to require a driver or not. * - * @param [in] requiresDriver The r. + * @param [in] requiresDriver The r. * - * @return . + * @return . */ void setRequiresDriver(bool requiresDriver); /*! * Checks if the wire requires a driver. * - * @return True, if the wire requires a driver, otherwise false. + * @return True, if the wire requires a driver, otherwise false. */ bool requiresDriver() const; /*! Sets the driver type for this wire. * - * @param [in] driverType The driver type to set. + * @param [in] driverType The driver type to set. */ void setDriverType(General::DriverType driverType); /*! Gets the driver type for this wire. * - * @return The driver type for this wire. + * @return The driver type for this wire. */ General::DriverType getDriverType() const; /*! * Gets the wire direction for a given interface mode. * - * @param [in] mode The mode to get the direction for. - * @param [in] systemGroup The system group to get direction for. + * @param [in] mode The mode to get the direction for. + * @param [in] systemGroup The system group to get direction for. * - * @return The direction of the wire for the given interface mode. + * @return The direction of the wire for the given interface mode. */ DirectionTypes::Direction getDirection(General::InterfaceMode mode, QString const& systemGroup) const; @@ -220,20 +220,20 @@ class IPXACTMODELS_EXPORT WireAbstraction /*! * Gets the wire width for a given interface mode. * - * @param [in] mode The mode to get the width for. - * @param [in] systemGroup The system group to get width for. + * @param [in] mode The mode to get the width for. + * @param [in] systemGroup The system group to get width for. * - * @return The width of the wire for the given interface mode. + * @return The width of the wire for the given interface mode. */ QString getWidth(General::InterfaceMode mode, QString const& systemGroup) const; /*! * Check if the wire has the selected interface mode. * - * @param [in] mode The selected interface mode. - * @param [in] systemGroup The selected interface system group. + * @param [in] mode The selected interface mode. + * @param [in] systemGroup The selected interface system group. * - * @return True, if the wire has the selected mode, otherwise false. + * @return True, if the wire has the selected mode, otherwise false. */ bool hasMode(General::InterfaceMode mode, QString const& systemGroup) const; diff --git a/IPXACTmodels/AbstractionDefinition/WireAbstractionReader.h b/IPXACTmodels/AbstractionDefinition/WireAbstractionReader.h index 35a04ebb7..6eccaeb5b 100644 --- a/IPXACTmodels/AbstractionDefinition/WireAbstractionReader.h +++ b/IPXACTmodels/AbstractionDefinition/WireAbstractionReader.h @@ -31,10 +31,10 @@ namespace WireAbstractionReader /*! * Creates a wire for abstraction definition from XML description. * - * @param [in] wireNode The XML document to create the wire definition from. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wireNode The XML document to create the wire definition from. + * @param [in] revision The standard revision of the XML document being read. * - * @return The created wire definition. + * @return The created wire definition. */ QSharedPointer createWireAbstractionFrom(QDomNode const& wireNode, Document::Revision revision); @@ -43,9 +43,9 @@ namespace WireAbstractionReader /*! * Reads the qualifier from XML to a wire. * - * @param [in] wireNode The XML description of the wire. - * @param [in/out] wire The wire definition to insert the qualifier into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wireNode The XML description of the wire. + * @param [in/out] wire The wire definition to insert the qualifier into. + * @param [in] revision The standard revision of the XML document being read. */ void parseQualifier(QDomNode const& wireNode, QSharedPointer wire, Document::Revision revision); @@ -53,71 +53,71 @@ namespace WireAbstractionReader /*! * Reads the system ports from XML to a wire. * - * @param [in] wireNode The XML description of the wire. - * @param [in/out] wire The wire definition to insert the system ports into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wireNode The XML description of the wire. + * @param [in/out] wire The wire definition to insert the system ports into. + * @param [in] revision The standard revision of the XML document being read. */ void parseSystems(QDomNode const& wireNode, QSharedPointer wire, Document::Revision revision); /*! * Creates a wirePort for a wire from XML description. * - * @param [in] wirePortNode The XML description of the wirePort. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wirePortNode The XML description of the wirePort. + * @param [in] revision The standard revision of the XML document being read. * - * @return The created wirePort. + * @return The created wirePort. */ QSharedPointer parseWirePort(QDomNode const& wirePortNode, Document::Revision revision); /*! * Reads the constraints for a wirePort from XML to a wire. * - * @param [in] wirePortNode The XML description of the wirePort. - * @param [in/out] wirePort The wirePort to insert the constraints into. + * @param [in] wirePortNode The XML description of the wirePort. + * @param [in/out] wirePort The wirePort to insert the constraints into. */ void parseConstraints(QDomNode const& wirePortNode, QSharedPointer wirePort); /*! * Creates a timing constraint for a wirePort from a XML description. * - * @param [in] timingNode The XML description of the timing constraint. + * @param [in] timingNode The XML description of the timing constraint. * - * @return The created timing constraint. + * @return The created timing constraint. */ QSharedPointer parseTimingConstraint(QDomElement const& timingNode); /*! * Creates a cell specification for load or drive constraint in a wirePort from a XML description. * - * @param [in] cellNode The XML description of the cell specification. + * @param [in] cellNode The XML description of the cell specification. * - * @return The created cell specification. + * @return The created cell specification. */ QSharedPointer parseCellSpecification(QDomElement const& cellNode); /*! * Reads the constraints for mirrored mode for a wirePort from XML to a wire. * - * @param [in] wirePortNode The XML description of the wirePort. - * @param [in/out] wirePort The wirePort to insert the mirrored constraints into. + * @param [in] wirePortNode The XML description of the wirePort. + * @param [in/out] wirePort The wirePort to insert the mirrored constraints into. */ void parseMirroredConstraints(QDomNode const& wirePortNode, QSharedPointer wirePort); /*! * Reads the initiator port from XML to a wire. * - * @param [in] wireNode The XML description of the wire. - * @param [in/out] wire The wire definition to insert the initiator port into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wireNode The XML description of the wire. + * @param [in/out] wire The wire definition to insert the initiator port into. + * @param [in] revision The standard revision of the XML document being read. */ void parseInitiator(QDomNode const& wireNode, QSharedPointer wire, Document::Revision revision); /*! * Reads the target port from XML to a wire. * - * @param [in] wireNode The XML description of the wire. - * @param [in/out] wire The wire definition to insert the target port into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] wireNode The XML description of the wire. + * @param [in/out] wire The wire definition to insert the target port into. + * @param [in] revision The standard revision of the XML document being read. */ void parseTarget(QDomNode const& wireNode, QSharedPointer wire, Document::Revision revision); } diff --git a/IPXACTmodels/AbstractionDefinition/WireAbstractionWriter.h b/IPXACTmodels/AbstractionDefinition/WireAbstractionWriter.h index b3f2bb1f7..b11e01c83 100644 --- a/IPXACTmodels/AbstractionDefinition/WireAbstractionWriter.h +++ b/IPXACTmodels/AbstractionDefinition/WireAbstractionWriter.h @@ -31,9 +31,9 @@ namespace WireAbstractionWriter /*! * Writes the given wire into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The wire to write. - * @param [in] revision The document standard revision to use. + * @param [in] writer The XML writer to use. + * @param [in] wire The wire to write. + * @param [in] revision The document standard revision to use. */ IPXACTMODELS_EXPORT void writeWire(QXmlStreamWriter& writer, QSharedPointer wire, Document::Revision revision); @@ -44,96 +44,96 @@ namespace WireAbstractionWriter /*! * Writes the system port for the given wire into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The wire whose system port to write. + * @param [in] writer The XML writer to use. + * @param [in] wire The wire whose system port to write. */ void writeSystem(QXmlStreamWriter& writer, QSharedPointer wire); /*! * Writes the wire port on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort to write. */ void writeWirePort(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes the wire port presence on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort whose presence to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort whose presence to write. */ void writePresence(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes the wire port width on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort whose width to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort whose width to write. */ void writeWidth(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes the wire port direction on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort whose direction to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort whose direction to write. */ void writeDirection(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes the wire mode constraints into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort whose mode constraints to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort whose mode constraints to write. */ void writeModeConstraints(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes a timing constraint into XML. * - * @param [in] writer The XML writer to use. - * @param [in] timing The timing constraint to write. + * @param [in] writer The XML writer to use. + * @param [in] timing The timing constraint to write. */ void writeTimingConstraint(QXmlStreamWriter& writer, QSharedPointer timing); /*! * Writes a drive constraint into XML. * - * @param [in] writer The XML writer to use. - * @param [in] driveConstraint The drive constraint to write. + * @param [in] writer The XML writer to use. + * @param [in] driveConstraint The drive constraint to write. */ void writeDriveConstraint(QXmlStreamWriter& writer, QSharedPointer driveConstraint); /*! * Writes a load constraint into XML. * - * @param [in] writer The XML writer to use. - * @param [in] loadConstraint The load constraint to write. + * @param [in] writer The XML writer to use. + * @param [in] loadConstraint The load constraint to write. */ void writeLoadConstraint(QXmlStreamWriter& writer, QSharedPointer loadConstraint); /*! * Writes a cell specification in load or drive constraint into XML. * - * @param [in] writer The XML writer to use. - * @param [in] specification The cell specification to write. + * @param [in] writer The XML writer to use. + * @param [in] specification The cell specification to write. */ void writeCellSpecification(QXmlStreamWriter& writer, QSharedPointer specification); /*! * Writes the wire mode constraints in mirrored mode into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wirePort The wirePort whose mirrored mode constraints to write. + * @param [in] writer The XML writer to use. + * @param [in] wirePort The wirePort whose mirrored mode constraints to write. */ void writeMirroredModeConstraints(QXmlStreamWriter& writer, QSharedPointer wirePort); /*! * Writes the initiator port for the given wire qualifier into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The wire whose initiator port to write. + * @param [in] writer The XML writer to use. + * @param [in] wire The wire whose initiator port to write. */ void writeInitiator(QXmlStreamWriter& writer, QSharedPointer wirePort, QString const& elementName); @@ -141,8 +141,8 @@ namespace WireAbstractionWriter /*! * Writes the target port for the given wire qualifier into XML. * - * @param [in] writer The XML writer to use. - * @param [in] wire The wire whose target port to write. + * @param [in] writer The XML writer to use. + * @param [in] wire The wire whose target port to write. */ void writeTarget(QXmlStreamWriter& writer, QSharedPointer wirePort, QString const& elementName); diff --git a/IPXACTmodels/AbstractionDefinition/WirePort.h b/IPXACTmodels/AbstractionDefinition/WirePort.h index ee8b00c3b..f28859477 100644 --- a/IPXACTmodels/AbstractionDefinition/WirePort.h +++ b/IPXACTmodels/AbstractionDefinition/WirePort.h @@ -42,49 +42,49 @@ class IPXACTMODELS_EXPORT WirePort /*! * Sets the group name for system mode. * - * @param [in] groupName The system group to set. + * @param [in] groupName The system group to set. */ void setSystemGroup(QString const& groupName); /*! * Gets the group name for system mode. * - * @return The system group the wire belongs to. + * @return The system group the wire belongs to. */ QString getSystemGroup() const; /*! * Sets the presence restriction for the port. * - * @param [in] presence The restriction to set. + * @param [in] presence The restriction to set. */ void setPresence(PresenceTypes::Presence presence); /*! * Gets the presence restriction for the port. * - * @return The presence restriction for the port. + * @return The presence restriction for the port. */ PresenceTypes::Presence getPresence() const; /*! * Sets the number of bits required for the port. * - * @param [in] widthExpression The number of bits to set. + * @param [in] widthExpression The number of bits to set. */ void setWidth(QString const& widthExpression); /*! * Gets the number of bits required for the port. * - * @return The number of bits to required for the port. + * @return The number of bits to required for the port. */ QString getWidth() const; /*! * Sets the allBits attribute for wire port width. * - * @param [in] allBits Flag for setting allBits. + * @param [in] allBits Flag for setting allBits. */ void setAllBits(bool allBits); @@ -98,98 +98,98 @@ class IPXACTMODELS_EXPORT WirePort /*! * Sets a direction restriction for the port. * - * @param [in] direction The required direction. + * @param [in] direction The required direction. */ void setDirection(DirectionTypes::Direction direction); /*! * Gets a direction restriction for the port. * - * @return The required direction. + * @return The required direction. */ DirectionTypes::Direction getDirection() const; /*! * Sets a timing constraint for the port. * - * @param [in] timeConstraint The constraint to set. + * @param [in] timeConstraint The constraint to set. */ void setTimingConstraint(QSharedPointer timeConstraint); /*! * Gets the timing constraint for the port. * - * @return The timing constraint. + * @return The timing constraint. */ QSharedPointer getTimingConstraint() const; /*! * Sets a load constraint for the port. * - * @param [in] loadConstraint The constraint to set. + * @param [in] loadConstraint The constraint to set. */ void setLoadConstraint(QSharedPointer loadConstraint); /*! * Gets the load constraint for the port. * - * @return The load constraint. + * @return The load constraint. */ QSharedPointer getLoadConstraint() const; /*! * Sets a drive constraint for the port. * - * @param [in] driveConstraint The constraint to set. + * @param [in] driveConstraint The constraint to set. */ void setDriveConstraint(QSharedPointer driveConstraint); /*! * Gets the drive constraint for the port. * - * @return The drive constraint. + * @return The drive constraint. */ QSharedPointer getDriveConstraint() const; /*! * Sets a timing constraint for the port in the mirrored mode. * - * @param [in] timeConstraint The constraint to set. + * @param [in] timeConstraint The constraint to set. */ void setMirroredTimingConstraint(QSharedPointer timeConstraint); /*! * Gets the timing constraint for the port in mirrored mode. * - * @return The timing constraint. + * @return The timing constraint. */ QSharedPointer getMirroredTimingConstraint() const; /*! * Sets a load constraint for the port in the mirrored mode. * - * @param [in] loadConstraint The constraint to set. + * @param [in] loadConstraint The constraint to set. */ void setMirroredLoadConstraint(QSharedPointer loadConstraint); /*! * Gets the load constraint for the port in mirrored mode. * - * @return The load constraint. + * @return The load constraint. */ QSharedPointer getMirroredLoadConstraint() const; /*! * Sets a drive constraint for the port in the mirrored mode. * - * @param [in] driveConstraint The constraint to set. + * @param [in] driveConstraint The constraint to set. */ void setMirroredDriveConstraint(QSharedPointer driveConstraint); /*! * Gets the drive constraint for the port in mirrored mode. * - * @return The drive constraint. + * @return The drive constraint. */ QSharedPointer getMirroredDriveConstraint() const; diff --git a/IPXACTmodels/AbstractionDefinition/validators/AbstractionDefinitionValidator.h b/IPXACTmodels/AbstractionDefinition/validators/AbstractionDefinitionValidator.h index 7f3f5fe8b..121aef22a 100644 --- a/IPXACTmodels/AbstractionDefinition/validators/AbstractionDefinitionValidator.h +++ b/IPXACTmodels/AbstractionDefinition/validators/AbstractionDefinitionValidator.h @@ -55,17 +55,17 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Validates the given AbstractionDefinition. * - * @param [in] AbstractionDefinition The AbstractionDefinition to validate. + * @param [in] AbstractionDefinition The AbstractionDefinition to validate. * - * @return True, if the AbstractionDefinition is valid IP-XACT, otherwise false. + * @return True, if the AbstractionDefinition is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer abstractionDefinition); /*! * Finds possible errors in a AbstractionDefinition and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] AbstractionDefinition The AbstractionDefinition whose errors to find. + * @param [in] errors List of found errors. + * @param [in] AbstractionDefinition The AbstractionDefinition whose errors to find. */ void findErrorsIn(QVector& errors, QSharedPointer abstractionDefinition); @@ -75,37 +75,37 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Get the bus definition used by the selected abstraction definition * - * @param [in] abstraction The selected abstraction definition. + * @param [in] abstraction The selected abstraction definition. * - * @return The bus definition used by the selected abstraction definition. + * @return The bus definition used by the selected abstraction definition. */ QSharedPointer getBusDefinition(QSharedPointer abstraction) const; /*! * Check if the extended port elements of the selected abstraction definition are valid. * - * @param [in] abstraction The selected abstraction definition. + * @param [in] abstraction The selected abstraction definition. * - * @return True, if the extend ports are valid, false otherwise. + * @return True, if the extend ports are valid, false otherwise. */ bool hasValidExtendPorts(QSharedPointer abstraction) const; /*! * Check if the wire of the selected extended abstraction port is valid. * - * @param [in] abstractionPort The selected abstraction port. - * @param [in] extendPort The extend abstraction port. + * @param [in] abstractionPort The selected abstraction port. + * @param [in] extendPort The extend abstraction port. * - * @return True, if the extended wire is valid, false otherwise. + * @return True, if the extended wire is valid, false otherwise. */ bool extendWirePortIsValid(QSharedPointer abstractionPort, QSharedPointer extendPort) const; @@ -113,10 +113,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Check if the transactional of the selected extended abstraction port is valid. * - * @param [in] abstractionPort The selected abstraction port. - * @param [in] extendPort The extend abstraction port. + * @param [in] abstractionPort The selected abstraction port. + * @param [in] extendPort The extend abstraction port. * - * @return True, if the extended transactional is valid, false otherwise. + * @return True, if the extended transactional is valid, false otherwise. */ bool extendTransactionalPortAbstractionIsValid(QSharedPointer abstractionPort, QSharedPointer extendPort) const; @@ -124,10 +124,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Check if the extended transactional port is valid. * - * @param [in] port The selected transactional port. - * @param [in] extendPort The extend transactional port. + * @param [in] port The selected transactional port. + * @param [in] extendPort The extend transactional port. * - * @return True, if the extended transactional port is valid, false otherwise. + * @return True, if the extended transactional port is valid, false otherwise. */ bool extendTransactionalPortIsValid(QSharedPointer port, QSharedPointer extendPort) const; @@ -135,10 +135,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Get the extended port abstraction matching the selected port abstraction. * - * @param [in] logicalPort The selected abstraction port. - * @param [in] extendAbstraction The extend abstraction definition. + * @param [in] logicalPort The selected abstraction port. + * @param [in] extendAbstraction The extend abstraction definition. * - * @return The extend port matching the selected port. + * @return The extend port matching the selected port. */ QSharedPointer getMatchingExtendPort(QSharedPointer logicalPort, QSharedPointer extendAbstraction) const; @@ -146,28 +146,28 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Check if the extend is valid. * - * @param [in] abstraction The selected abstraction definition. + * @param [in] abstraction The selected abstraction definition. * - * @return True, if the extend is valid, false otherwise. + * @return True, if the extend is valid, false otherwise. */ bool hasValidExtend(QSharedPointer abstraction) const; /*! * Check if the contained bus type defines the bus type of the extended abstraction definition. * - * @param [in] abstraction The selected abstraction definition. + * @param [in] abstraction The selected abstraction definition. * - * @return True, if the bus type defines the extend abstraction definition bus type, false otherwise. + * @return True, if the bus type defines the extend abstraction definition bus type, false otherwise. */ bool busTypeDefinesExtendedAbstractionBusType(QSharedPointer abstraction) const; /*! * Check if the selected bus type is extended from the other bus type. * - * @param [in] busType The selected bus type. - * @param [in] extendBustype The target bus type. + * @param [in] busType The selected bus type. + * @param [in] extendBustype The target bus type. * - * @return True, if the bus type is extended from the other bus type, false otherwise. + * @return True, if the bus type is extended from the other bus type, false otherwise. */ bool busTypeIsExtendedFromExtendBusType(QSharedPointer busType, QSharedPointer extendBustype) const; @@ -175,9 +175,9 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Get the extend abstraction definition. * - * @param [in] abstraction The selected abstraction definition. + * @param [in] abstraction The selected abstraction definition. * - * @return The extend abstraction definition. + * @return The extend abstraction definition. */ QSharedPointer getExtendedAbstractionDefinition( QSharedPointer abstraction) const; @@ -185,18 +185,18 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Get the bus type extended bus definition. * - * @param [in] busType The selected bus type. + * @param [in] busType The selected bus type. * - * @return The extend bus definition of the selected bus type. + * @return The extend bus definition of the selected bus type. */ QSharedPointer getBusTypeExtend(QSharedPointer busType) const; /*! * Find possible errors in extend of the selected abstraction definition and create a list of them. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] abstraction The selected abstraction definition. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] abstraction The selected abstraction definition. */ void findErrorsInExtend(QVector& errors, QString const& context, QSharedPointer abstraction) const; @@ -204,9 +204,9 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in extended port abstractions of the selected abstraction definition. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] abstraction The selected abstraction definition. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] abstraction The selected abstraction definition. */ void findErrorsInExtendPorts(QVector& errors, QString const& context, QSharedPointer abstraction) const; @@ -214,10 +214,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in wire abstraction of the selected extend port abstraction. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] port The selected abstraction port. - * @param [in] extendPort The extend port. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] port The selected abstraction port. + * @param [in] extendPort The extend port. */ void findErrorsInExtendWireAbstraction(QVector& errors, QString const& context, QSharedPointer port, QSharedPointer extendPort) const; @@ -225,12 +225,12 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in the selected extend wire port. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] port The selected wire port. - * @param [in] extendPort The extend port. - * @param [in] portName Name of the port. - * @param [in] modeName Name of the mode. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] port The selected wire port. + * @param [in] extendPort The extend port. + * @param [in] portName Name of the port. + * @param [in] modeName Name of the mode. */ void findErrorsInExtendWirePort(QVector& errors, QString const& context, QSharedPointer port, QSharedPointer extendPort, QString const& portName, @@ -239,10 +239,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in transactional abstraction of the selected extend port abstraction. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] port The selected abstraction port. - * @param [in] extendPort The extend port. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] port The selected abstraction port. + * @param [in] extendPort The extend port. */ void findErrorsInExtendTransactionalAbstraction(QVector& errors, QString const& context, QSharedPointer port, QSharedPointer extendPort) const; @@ -250,10 +250,10 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in transactional abstraction of the selected extend port abstraction. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] port The selected transactional port. - * @param [in] extendPort The extend port. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] port The selected transactional port. + * @param [in] extendPort The extend port. */ void findErrorsInExtendTransactionalPort(QVector& errors, QString const& context, QSharedPointer port, QSharedPointer extendPort) const; @@ -261,7 +261,7 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Check if the choices of the abstraction definition are valid. * - * @param [in] abstraction The abstraction definition to check. + * @param [in] abstraction The abstraction definition to check. * * @return True, if choices are valid, otherwise false. */ @@ -270,9 +270,9 @@ class IPXACTMODELS_EXPORT AbstractionDefinitionValidator /*! * Find errors in the choices of an abstraction definition. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] choices The choices to check. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] choices The choices to check. */ void findErrorsInChoices(QVector& errors, QString const& context, QSharedPointer > > choices) const; diff --git a/IPXACTmodels/AbstractionDefinition/validators/PacketValidator.h b/IPXACTmodels/AbstractionDefinition/validators/PacketValidator.h index 65ebc736a..d0ef81034 100644 --- a/IPXACTmodels/AbstractionDefinition/validators/PacketValidator.h +++ b/IPXACTmodels/AbstractionDefinition/validators/PacketValidator.h @@ -39,18 +39,18 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Validates the given Packet. * - * @param [in] packet The packet to validate. + * @param [in] packet The packet to validate. * - * @return True, if the Packet is valid IP-XACT, otherwise false. + * @return True, if the Packet is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer packet) const; /*! * Finds possible errors in a Packet and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] packet The AbstractionDefinition whose errors to find. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] packet The AbstractionDefinition whose errors to find. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QStringList& errors, QSharedPointer packet, QString const& context) const; @@ -59,7 +59,7 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Checks if packet field is valid. * - * @param [in] packetField The packet field to check. + * @param [in] packetField The packet field to check. * * @return True, if field is valid, otherwise false. */ @@ -68,16 +68,16 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Finds possible errors in a packet field and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the error. - * @param [in] packetField The packet field to check. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the error. + * @param [in] packetField The packet field to check. */ void findErrorsInPacketField(QStringList& errors, QString const& context, QSharedPointer packetField) const; /*! * Checks the validity of a packet or packet field name. * - * @param [in] name The name to check. + * @param [in] name The name to check. * * @return True, if name is valid, otherwise false. */ @@ -86,8 +86,8 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Parses the field width expression. * - * @param [in] width The width value to parse. - * @param [in] widthIsValid Indicates if the parsed width is valid. + * @param [in] width The width value to parse. + * @param [in] widthIsValid Indicates if the parsed width is valid. * * @return Resolved width expression in bits. */ @@ -96,8 +96,8 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Checks if the packet field contains a valid value. * - * @param [in] packetField The packet field to check. - * @param [in] fieldWidth The width of the field in bits. + * @param [in] packetField The packet field to check. + * @param [in] fieldWidth The width of the field in bits. * * @return True, if the value is valid, otherwise false. */ @@ -106,10 +106,10 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Finds possible errors in a packet field value. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the error. - * @param [in] packetField The packet field to check. - * @param [in] resolvedFieldWidth The width of the packet field in bits. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the error. + * @param [in] packetField The packet field to check. + * @param [in] resolvedFieldWidth The width of the packet field in bits. */ void findErrorsInPacketFieldValue(QStringList& errors, QString const& context, QSharedPointer packetField, QString const& resolvedFieldWidth) const; @@ -117,7 +117,7 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Parses a constant field value. * - * @param [in] token Description + * @param [in] token Description * * @return The resolved value expression in binary. */ @@ -126,9 +126,9 @@ class IPXACTMODELS_EXPORT PacketValidator /*! * Get the base for a given number. * - * @param [in] constantNumber The selected number. + * @param [in] constantNumber The selected number. * - * @return The base for the selected number. Either 2, 8, 10 or 16. + * @return The base for the selected number. Either 2, 8, 10 or 16. */ int baseOf(QString const& constantNumber) const; diff --git a/IPXACTmodels/AbstractionDefinition/validators/PortAbstractionValidator.h b/IPXACTmodels/AbstractionDefinition/validators/PortAbstractionValidator.h index 6074ec51d..1f1aab00b 100644 --- a/IPXACTmodels/AbstractionDefinition/validators/PortAbstractionValidator.h +++ b/IPXACTmodels/AbstractionDefinition/validators/PortAbstractionValidator.h @@ -36,8 +36,8 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * The constructor. * - * @param [in] library Library interface to use. - * @param [in] expressionParser Expression parser to use. + * @param [in] library Library interface to use. + * @param [in] expressionParser Expression parser to use. */ PortAbstractionValidator(LibraryInterface* library, QSharedPointer expressionParser); @@ -50,9 +50,9 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Validates the given PortAbstraction. * - * @param [in] port The PortAbstraction to validate. - * @param [in] abstractionDefinition The abstraction definition being validated. - * @param [in] busDefinition The bus definition used by the abstraction definition. + * @param [in] port The PortAbstraction to validate. + * @param [in] abstractionDefinition The abstraction definition being validated. + * @param [in] busDefinition The bus definition used by the abstraction definition. */ bool validate(QSharedPointer port, QSharedPointer abstractionDefinition, @@ -61,10 +61,10 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Finds possible errors in a PortAbstraction and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] port The PortAbstraction whose errors to find. - * @param [in] abstractionDefinition The abstraction definition. - * @param [in] busDefinition Bus definition used by the abstraction definition. + * @param [in] errors List of found errors. + * @param [in] port The PortAbstraction whose errors to find. + * @param [in] abstractionDefinition The abstraction definition. + * @param [in] busDefinition Bus definition used by the abstraction definition. */ void findErrorsIn(QStringList& errors, QSharedPointer port, @@ -76,7 +76,7 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Checks the validity of the default value of a wire port. * - * @param [in] wirePort The wire port to check. + * @param [in] wirePort The wire port to check. * * @return True, if the default value is valid, otherwise false. */ @@ -85,10 +85,10 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Validates the given WirePort. * - * @param [in] wirePort The WirePort to validate. - * @param [in] ports Collection of ports within the abstraction definition. + * @param [in] wirePort The WirePort to validate. + * @param [in] ports Collection of ports within the abstraction definition. * - * @return True, if the WirePort is valid IP-XACT, otherwise false. + * @return True, if the WirePort is valid IP-XACT, otherwise false. */ bool isValidWirePort(QSharedPointer wirePort, QSharedPointer > > ports) const; @@ -96,7 +96,7 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Checks the validity of the width of a wire port. * - * @param [in] wirePort The wire port to check. + * @param [in] wirePort The wire port to check. * * @return True, if the width is valid, otherwise false. */ @@ -105,14 +105,14 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Validates the given TransactionalPort. * - * @param [in] transPort The TransactionalPort to validate. + * @param [in] transPort The TransactionalPort to validate. */ bool isValidTransactionalPort(QSharedPointer transPort) const; /*! * Checks the validity of the bus width of a transactional port. * - * @param [in] transPort The transactional port to check. + * @param [in] transPort The transactional port to check. * * @return True, if the bus width is valid, otherwise false. */ @@ -121,8 +121,8 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Validates the given port qualifier. * - * @param [in] qualifier The qualifier to check. - * @param [in] documentRevision The IP-XACT standard revision of the document being checked. + * @param [in] qualifier The qualifier to check. + * @param [in] documentRevision The IP-XACT standard revision of the document being checked. * * @return True, if port qualifier is valid, otherwise false. */ @@ -133,8 +133,8 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Validates the constraints of parameter wirePort. * - * @param [in] wirePort The WirePort to validate. - * @param [in] ports Collection of ports within the abstraction definition. + * @param [in] wirePort The WirePort to validate. + * @param [in] ports Collection of ports within the abstraction definition. */ bool validateConstraints(QSharedPointer wirePort, QSharedPointer > > ports) const; @@ -142,7 +142,7 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Check if port packets are valid. * - * @param [in] port The port whose packets are checked. + * @param [in] port The port whose packets are checked. * * @return True if valid, otherwise false. */ @@ -152,10 +152,10 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Finds possible errors in constraints of parameter wirePort and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] wirePort The WirePort whose errors to find. - * @param [in] context Context to help locate the errors. - * @param [in] ports Collection of ports within the abstraction definition. + * @param [in] errors List of found errors. + * @param [in] wirePort The WirePort whose errors to find. + * @param [in] context Context to help locate the errors. + * @param [in] ports Collection of ports within the abstraction definition. */ void findErrorsInConstraints(QStringList& errors, QSharedPointer wirePort, QString const& context, QSharedPointer > > ports) const; @@ -163,10 +163,10 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Finds possible errors in a WirePort and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] wirePort The WirePort whose errors to find. - * @param [in] context Context to help locate the errors. - * @param [in] ports Collection of ports within the abstraction definition. + * @param [in] errors List of found errors. + * @param [in] wirePort The WirePort whose errors to find. + * @param [in] context Context to help locate the errors. + * @param [in] ports Collection of ports within the abstraction definition. */ void findErrorsInWirePort(QStringList& errors, QSharedPointer wirePort, QString const& context, QSharedPointer > > ports) const; @@ -175,9 +175,9 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Finds possible errors in a TransactionalPort and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] transPort The TransactionalPort whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] transPort The TransactionalPort whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInTransactionalPort(QStringList& errors, QString const& context, QSharedPointer transPort) const; @@ -185,9 +185,9 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Finds possible errors in a qualifier of a port and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] abstraction The abstraction definition being checked. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] abstraction The abstraction definition being checked. */ void findErrorsInPortQualifier(QStringList& errors, QSharedPointer qualifier, QString const& context, QSharedPointer abstraction) const; @@ -196,13 +196,13 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Find errors in the selected port system group. * - * @param [in] errors List of found errors. - * @param [in] systemGroup The selected system group. - * @param [in] context Context to help locate the errors. - * @param [in] availableSystemNames List of the available system names. - * @param [in] busDefinitionIdentifier Identifier for the bus definition containing the system names. + * @param [in] errors List of found errors. + * @param [in] systemGroup The selected system group. + * @param [in] context Context to help locate the errors. + * @param [in] availableSystemNames List of the available system names. + * @param [in] busDefinitionIdentifier Identifier for the bus definition containing the system names. * - * @return + * @return */ void findErrorsInSystemGroup(QVector& errors, QString const& systemGroup, QString const& context, QStringList const& availableSystemNames, QString const& busDefinitionIdentifier) const; @@ -210,10 +210,10 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Find errors in the packets of the selected port. * - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] port The port whose packets are checked. - * @param [in] revision The IP-XACT revision of the document. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] port The port whose packets are checked. + * @param [in] revision The IP-XACT revision of the document. */ void findErrorsInPortPackets(QVector& errors, QString const& context, QSharedPointer port, Document::Revision revision) const; @@ -221,7 +221,7 @@ class IPXACTMODELS_EXPORT PortAbstractionValidator /*! * Checks if the given expression is valid. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * * @return True, if the expression is valid, otherwise false. */ diff --git a/IPXACTmodels/BusDefinition/BusDefinition.h b/IPXACTmodels/BusDefinition/BusDefinition.h index cf8f0e636..7c7b36bff 100644 --- a/IPXACTmodels/BusDefinition/BusDefinition.h +++ b/IPXACTmodels/BusDefinition/BusDefinition.h @@ -52,147 +52,147 @@ class IPXACTMODELS_EXPORT BusDefinition: public Document /*! * Creates a perfect copy of the Bus Definition. * - * @return Copy of the bus definition. + * @return Copy of the bus definition. */ virtual QSharedPointer 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; /*! Sets the bus to support/not support direct master-slave connections. * - * @param [in] directConnection The wanted setting. + * @param [in] directConnection The wanted setting. */ void setDirectConnection(bool directConnection); /*! Check if the bus supports direct master-slave connections. * - * @return True, if the bus connects directly from master to slave, otherwise false. + * @return True, if the bus connects directly from master to slave, otherwise false. */ bool getDirectConnection() const; /*! * Sets the bus to support/not support broadcast mode. * - * @param [in] broadcast The wanted setting. + * @param [in] broadcast The wanted setting. */ void setBroadcast(bool broadcast); /*! * Checks if the bus supports broadcast mode. * - * @return True, if broadcast is supported, otherwise false. + * @return True, if broadcast is supported, otherwise false. */ BooleanValue getBroadcast() const; /*! Set the whether this bus uses addressing. * - * @param [in] isAddressable The value to set. + * @param [in] isAddressable The value to set. */ void setIsAddressable(bool isAddressable); /*! Check if the bus uses addressing. * - * @return True, if the bus is addressable, otherwise false. + * @return True, if the bus is addressable, otherwise false. */ bool getIsAddressable() const; /*! 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); /*! Set the maximum number of masters on this bus * - * @param [in] maxMasters The maximum number of masters + * @param [in] maxMasters The maximum number of masters */ void setMaxMasters(std::string const& maxMasters); /*! Get the maximum number of masters on this bus * - * @return unsigned int containing maximum number of masters + * @return unsigned int containing maximum number of masters */ std::string getMaxMasters() const; /*! Set the maximum number of slaves on this bus * - * @param [in] The maximum number of slaves + * @param [in] The maximum number of slaves */ void setMaxSlaves(std::string const& maxSlaves); /*! Get the maximum number of slaves on this bus * - * @return The maximum number of slaves + * @return The maximum number of slaves */ std::string getMaxSlaves() const; /*! Set the maximum number of initiators on this bus * - * @param [in] maxInitiators The maximum number of initiators + * @param [in] maxInitiators The maximum number of initiators */ void setMaxInitiators(std::string const& maxInitiators); /*! Get the maximum number of initiators on this bus * - * @return unsigned int containing maximum number of initiators + * @return unsigned int containing maximum number of initiators */ std::string getMaxInitiators() const; /*! Set the maximum number of targets on this bus * - * @param [in] The maximum number of targets + * @param [in] The maximum number of targets */ void setMaxTargets(std::string const& maxTargets); /*! Get the maximum number of targets on this bus * - * @return The maximum number of targets + * @return The maximum number of targets */ std::string getMaxTargets() const; /*! Set the systemGroupNames. * - * @param [in] systemGroupNames The names of the systemGroups available in onSystem mode. + * @param [in] systemGroupNames The names of the systemGroups available in onSystem mode. */ void setSystemGroupNames(QStringList const& systemGroupNames); /*! Gets the systemGroupNames. * - * @return The names of available systemGroups + * @return The names of available systemGroups */ QStringList getSystemGroupNames() const; /*! Sets the choices. * - * @param [in] choices The choices to set. + * @param [in] choices The choices to set. */ void setChoices(QSharedPointer > > choices); /*! Gets the choices. * - * @return A list of the busDefinition choices + * @return A list of the busDefinition choices */ QSharedPointer > > getChoices() const; /*! Get the VLNVs that this busDefinition depends on. * - * @return The dependency VLNVs. + * @return The dependency VLNVs. */ virtual QList 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. */ diff --git a/IPXACTmodels/BusDefinition/BusDefinitionReader.h b/IPXACTmodels/BusDefinition/BusDefinitionReader.h index d518839e8..b7da14a51 100644 --- a/IPXACTmodels/BusDefinition/BusDefinitionReader.h +++ b/IPXACTmodels/BusDefinition/BusDefinitionReader.h @@ -28,9 +28,9 @@ namespace BusDefinitionReader /*! * Creates a bus definition from XML description. * - * @param [in] document The XML document to create the bus definition from. + * @param [in] document The XML document to create the bus definition from. * - * @return The created bus definition. + * @return The created bus definition. */ IPXACTMODELS_EXPORT QSharedPointer createBusDefinitionFrom(QDomNode const& document); @@ -39,64 +39,64 @@ namespace BusDefinitionReader /*! * Reads the direct connection property from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the direct connection property into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the direct connection property into. */ void parseDirectConnection(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the broadcast property from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the broadcast property into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the broadcast property into. */ void parseBroadcast(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the isAddressable property from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the isAddressable property into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the isAddressable property into. */ void parseIsAddressable(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the extends property from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the extends property into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the extends property into. */ void parseExtends(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the maximum number of initiators from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the maximum number of initiators into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the maximum number of initiators into. */ void parseMaximumInitiators(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the maximum number of targets from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the maximum number of targets into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the maximum number of targets into. */ void parseMaximumTargets(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the system group names from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the system group names into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the system group names into. */ void parseSystemGroupNames(QDomNode const& busNode, QSharedPointer busDefinition); /*! * Reads the choices from XML to a bus definition. * - * @param [in] busNode The XML description of the bus definition. - * @param [in/out] busDefinition The bus definition to insert the choices into. + * @param [in] busNode The XML description of the bus definition. + * @param [in/out] busDefinition The bus definition to insert the choices into. */ void parseChoices(QDomNode const& busNode, QSharedPointer busDefinition); } diff --git a/IPXACTmodels/BusDefinition/BusDefinitionWriter.h b/IPXACTmodels/BusDefinition/BusDefinitionWriter.h index 5b54fdb0e..617a9baab 100644 --- a/IPXACTmodels/BusDefinition/BusDefinitionWriter.h +++ b/IPXACTmodels/BusDefinition/BusDefinitionWriter.h @@ -32,8 +32,8 @@ namespace BusDefinitionWriter /*! * Writes the given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition to write. */ IPXACTMODELS_EXPORT void writeBusDefinition(QXmlStreamWriter& writer, QSharedPointer busDefinition); @@ -42,65 +42,65 @@ namespace BusDefinitionWriter /*! * Writes the broadcast property of a given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose broadcast to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose broadcast to write. */ void writeBroadcast(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the bus definition extended in a given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose extends property to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose extends property to write. */ void writeExtends(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the maximum number of initiators allowed in a given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose initiator count to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose initiator count to write. */ void writeMaximumInitiators(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the maximum number of targets allowed in a given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose targets count to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose targets count to write. */ void writeMaximumTargets(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the system group names defined in a given bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose system group names to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose system group names to write. */ void writeSystemGroupNames(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the choices of a bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose choices to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose choices to write. */ void writeChoices(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Writes the description of a bus definition into xml. * - * @param [in] writer The xml writer to use. - * @param [in] busDefinition The bus definition whose choices to write. + * @param [in] writer The xml writer to use. + * @param [in] busDefinition The bus definition whose choices to write. */ void writeDescription(QXmlStreamWriter& writer, QSharedPointer busDefinition); /*! * Converts boolean value to string. * - * @param [in] value The boolean value to convert. + * @param [in] value The boolean value to convert. * - * @return The string representation of the boolean value. + * @return The string representation of the boolean value. */ QString bool2Str(bool value); } diff --git a/IPXACTmodels/BusDefinition/validators/BusDefinitionValidator.h b/IPXACTmodels/BusDefinition/validators/BusDefinitionValidator.h index 57667d7a6..f4a4f3d05 100644 --- a/IPXACTmodels/BusDefinition/validators/BusDefinitionValidator.h +++ b/IPXACTmodels/BusDefinition/validators/BusDefinitionValidator.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT BusDefinitionValidator /*! * The constructor. * - * @param [in] library The library interface. - * @param [in] expressionParser The expression parser to use. + * @param [in] library The library interface. + * @param [in] expressionParser The expression parser to use. */ BusDefinitionValidator(LibraryInterface* library, QSharedPointer expressionParser); @@ -45,17 +45,17 @@ class IPXACTMODELS_EXPORT BusDefinitionValidator /*! * Validates the given BusDefinition. * - * @param [in] BusDefinition The BusDefinition to validate. + * @param [in] BusDefinition The BusDefinition to validate. * - * @return True, if the BusDefinition is valid IP-XACT, otherwise false. + * @return True, if the BusDefinition is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer busDefinition) const; /*! * Finds possible errors in a BusDefinition and creates a list of them. * - * @param [out] errors List of found errors. - * @param [in] BusDefinition The BusDefinition whose errors to find. + * @param [out] errors List of found errors. + * @param [in] BusDefinition The BusDefinition whose errors to find. */ virtual void findErrorsIn(QVector& errors, QSharedPointer busDefinition) const; @@ -68,9 +68,9 @@ class IPXACTMODELS_EXPORT BusDefinitionValidator /*! * Check if the extend value of the selected bus definition is valid. * - * @param [in] busDefinition The selected bus definition. + * @param [in] busDefinition The selected bus definition. * - * @return True, if the extend value is valid, false otherwise. + * @return True, if the extend value is valid, false otherwise. */ bool extendIsValid(QSharedPointer busDefinition) const; diff --git a/IPXACTmodels/Catalog/Catalog.h b/IPXACTmodels/Catalog/Catalog.h index dddbc9528..84bade094 100644 --- a/IPXACTmodels/Catalog/Catalog.h +++ b/IPXACTmodels/Catalog/Catalog.h @@ -46,88 +46,88 @@ class IPXACTMODELS_EXPORT Catalog: public Document /*! * Creates a perfect copy of the catalog. * - * @return Copy of the catalog. + * @return Copy of the catalog. */ virtual QSharedPointer clone() const; /*! Set the VLNV for the catalog. * - * @param [in] vlnv The vlnv to set + * @param [in] vlnv The vlnv to set */ virtual void setVlnv(const VLNV& vlnv); /*! * Get the catalog descriptions in the catalog. * - * @return The catalogs referenced by this catalog. + * @return The catalogs referenced by this catalog. */ QSharedPointer > > getCatalogs() const; /*! * Get the bus definitions descriptions in the catalog. * - * @return The bus definitions referenced by this catalog. + * @return The bus definitions referenced by this catalog. */ QSharedPointer > > getBusDefinitions() const; /*! * Get the abstractions definitions in the catalog. * - * @return The abstractions definitions referenced by this catalog. + * @return The abstractions definitions referenced by this catalog. */ QSharedPointer > > getAbstractionDefinitions() const; /*! * Get the component descriptions in the catalog. * - * @return The components referenced by this catalog. + * @return The components referenced by this catalog. */ QSharedPointer > > getComponents() const; /*! * Get the abstractor descriptions in the catalog. * - * @return The abstractors referenced by this catalog. + * @return The abstractors referenced by this catalog. */ QSharedPointer > > getAbstractors() const; /*! * Get the design descriptions in the catalog. * - * @return The designs referenced by this catalog. + * @return The designs referenced by this catalog. */ QSharedPointer > > getDesigns() const; /*! * Get the design configuration descriptions in the catalog. * - * @return The design configurations referenced by this catalog. + * @return The design configurations referenced by this catalog. */ QSharedPointer > > getDesignConfigurations() const; /*! * Get the generator chain descriptions in the catalog. * - * @return The generator chains referenced by this catalog. + * @return The generator chains referenced by this catalog. */ QSharedPointer > > getGeneratorChains() const; /*! * Get the type definitions in the catalog. * - * @return The type definitions referenced by this catalog. + * @return The type definitions referenced by this catalog. */ QSharedPointer > > getTypeDefinitions() const; /*! Get the VLNVs that this catalog depends on. * - * @return The dependency VLNVs. + * @return The dependency VLNVs. */ virtual QList getDependentVLNVs() const; /*! Get the file dependencies of this catalog. * - * @return The dependency files. + * @return The dependency files. * * @remark This function never returns anything because catalog only has VLNV dependencies. */ @@ -138,14 +138,14 @@ class IPXACTMODELS_EXPORT Catalog: public Document /*! * Copies file descriptions from another catalog. * - * @param [in] other The catalog to copy from. + * @param [in] other The catalog to copy from. */ void copyIpxactFiles(Catalog const& other); /*! * Gets all the ipxact files in the catalog regardless of the type. * - * @return All ipxact files in the catalog. + * @return All ipxact files in the catalog. */ QList > getAllFiles() const; diff --git a/IPXACTmodels/Catalog/CatalogReader.h b/IPXACTmodels/Catalog/CatalogReader.h index 361bd71c7..33651de33 100644 --- a/IPXACTmodels/Catalog/CatalogReader.h +++ b/IPXACTmodels/Catalog/CatalogReader.h @@ -30,9 +30,9 @@ namespace CatalogReader /*! * Creates a catalog from XML description. * - * @param [in] document The XML document to create the catalog from. + * @param [in] document The XML document to create the catalog from. * - * @return The created catalog. + * @return The created catalog. */ IPXACTMODELS_EXPORT QSharedPointer createCatalogFrom(QDomNode const& document); @@ -42,92 +42,92 @@ namespace CatalogReader /*! * Reads the catalog file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseCatalogs(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the bus definition file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseBusDefinitions(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the abstraction definition file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseAbstractionDefinitions(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the component file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseComponents(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the abstractor file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseAbstractors(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the design file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseDesigns(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the design configuration file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseDesignCongfigurations(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the generator chain file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file descriptions into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file descriptions into. */ void parseGeneratorChains(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads the type definition file descriptions to the catalog. * - * @param [in] catalogNode The XML description of the catalog. - * @param [in/out] catalog The catalog to insert the file description into. + * @param [in] catalogNode The XML description of the catalog. + * @param [in/out] catalog The catalog to insert the file description into. */ void parseTypeDefinitions(QDomNode const& catalogNode, QSharedPointer catalog); /*! * Reads XML node containing ipxactFile elements and creates a list of the parsed elements. * - * @param [in] filesNode The XML description to read. - * @param [in] documentType The type of IP-XACT document. + * @param [in] filesNode The XML description to read. + * @param [in] documentType The type of IP-XACT document. * - * @return List of the parsed ipxactFiles. + * @return List of the parsed ipxactFiles. */ QList > parseIpxactFileList(QDomElement& filesNode, VLNV::IPXactType documentType); /*! * Parses an XML node to ipxactFile element. * - * @param [in] fileNode The XML description to parse.. - * @param [in] documentType The type of IP-XACT document. + * @param [in] fileNode The XML description to parse.. + * @param [in] documentType The type of IP-XACT document. * - * @return The parsed ipxactFile. + * @return The parsed ipxactFile. */ QSharedPointer createIpxactFileFrom(QDomNode const& fileNode, VLNV::IPXactType documentType); } diff --git a/IPXACTmodels/Catalog/CatalogWriter.h b/IPXACTmodels/Catalog/CatalogWriter.h index 810beae0d..46035ee49 100644 --- a/IPXACTmodels/Catalog/CatalogWriter.h +++ b/IPXACTmodels/Catalog/CatalogWriter.h @@ -34,8 +34,8 @@ namespace CatalogWriter /*! * Writes the given catalog into XML. * - * @param [in] writer The XML writer to use. - * @param [in] catalog The catalog to write. + * @param [in] writer The XML writer to use. + * @param [in] catalog The catalog to write. */ IPXACTMODELS_EXPORT void writeCatalog(QXmlStreamWriter& writer, QSharedPointer catalog); diff --git a/IPXACTmodels/Catalog/IpxactFile.h b/IPXACTmodels/Catalog/IpxactFile.h index 2c3400543..4191cca96 100644 --- a/IPXACTmodels/Catalog/IpxactFile.h +++ b/IPXACTmodels/Catalog/IpxactFile.h @@ -41,37 +41,37 @@ class IPXACTMODELS_EXPORT IpxactFile: public Extendable /*! Set the VLNV for the file. * - * @param [in] vlnv The vlnv to set. + * @param [in] vlnv The vlnv to set. */ void setVlnv(const VLNV& vlnv); /*! Get the VLNV for the file. * - * @return The vlnv referenced in the file. + * @return The vlnv referenced in the file. */ VLNV getVlnv() const; /*! Set the name (path) for the file. * - * @param [in] name The name to set. + * @param [in] name The name to set. */ void setName(QString const& name); /*! Get the name (path) for the file. * - * @return The path to the xml file. + * @return The path to the xml file. */ QString getName() const; /*! Set the description for the file. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description); /*! Get the description for the file. * - * @return The description for the file. + * @return The description for the file. */ QString getDescription() const; diff --git a/IPXACTmodels/Catalog/validators/CatalogValidator.h b/IPXACTmodels/Catalog/validators/CatalogValidator.h index 9bdd0e002..eca429d41 100644 --- a/IPXACTmodels/Catalog/validators/CatalogValidator.h +++ b/IPXACTmodels/Catalog/validators/CatalogValidator.h @@ -41,17 +41,17 @@ class IPXACTMODELS_EXPORT CatalogValidator /*! * Validates the given Catalog. * - * @param [in] Catalog The Catalog to validate. + * @param [in] Catalog The Catalog to validate. * - * @return True, if the catalog is valid IP-XACT, otherwise false. + * @return True, if the catalog is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer catalog) const; /*! * Finds possible errors in a catalog and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] Catalog The catalog whose errors to find. + * @param [in] errors List of found errors. + * @param [in] Catalog The catalog whose errors to find. */ virtual void findErrorsIn(QVector& errors, QSharedPointer catalog) const; @@ -64,27 +64,27 @@ class IPXACTMODELS_EXPORT CatalogValidator /*! * Validates the given set of ipxactFiles. * - * @param [in] files The files to validate. + * @param [in] files The files to validate. * - * @return True, if all files are valid, otherwise false. + * @return True, if all files are valid, otherwise false. */ bool validateFiles(QSharedPointer > > files) const; /*! * Validates the given ipxactFile. * - * @param [in] files The file to validate. + * @param [in] files The file to validate. * - * @return True, if the file is valid, otherwise false. + * @return True, if the file is valid, otherwise false. */ bool validateFile(QSharedPointer file) const; /*! * Finds possible errors in the given set of files and creates a list of them. * - * @param [in/out] errors List of found errors. - * @param [in] files The files whose errors to find. - * @param [in] context Context for the files to help locate errors. + * @param [in/out] errors List of found errors. + * @param [in] files The files whose errors to find. + * @param [in] context Context for the files to help locate errors. */ void findErrorsInFiles(QVector& errors, QSharedPointer > > files, diff --git a/IPXACTmodels/Component/AbstractionType.h b/IPXACTmodels/Component/AbstractionType.h index 7caf234c7..2b393beb7 100644 --- a/IPXACTmodels/Component/AbstractionType.h +++ b/IPXACTmodels/Component/AbstractionType.h @@ -51,76 +51,76 @@ class IPXACTMODELS_EXPORT AbstractionType /*! * Set the view references. * - * @param [in] newViewReferences List containing the new view references. + * @param [in] newViewReferences List containing the new view references. */ void setViewReferences(QSharedPointer newViewReferences); /*! * Get the view references. * - * @return List of the referenced views. + * @return List of the referenced views. */ QSharedPointer getViewReferences() const; /*! * Set the abstraction reference. * - * @param [in] abstractionRef The referenced abstraction definition. + * @param [in] abstractionRef The referenced abstraction definition. */ void setAbstractionRef(QSharedPointer abstractionRef); /*! * Get the referenced abstraction definition. * - * @return The referenced abstraction definition. + * @return The referenced abstraction definition. */ QSharedPointer getAbstractionRef() const; /*! * Get the port maps. * - * @return A list of port maps. + * @return A list of port maps. */ QSharedPointer > > getPortMaps() const; /*! * Get the names of the mapped physical ports. * - * @return A list containing the names of the mapped physical ports. + * @return A list containing the names of the mapped physical ports. */ QStringList getPhysicalPortNames() const; /*! * Get the names of the mapped logical ports. * - * @return A list containing the names of the mapped logical ports. + * @return A list containing the names of the mapped logical ports. */ QStringList getLogicalPortNames() const; /*! * Check if the selected logical port has been mapped. * - * @param [in] portName Name of the selected logical port. + * @param [in] portName Name of the selected logical port. * - * @return True, if the selected logical port has been mapped, false otherwise. + * @return True, if the selected logical port has been mapped, false otherwise. */ bool hasLogicalPort(QString const& portName) const; /*! * Check if the selected physical port has been mapped. * - * @param [in] portName Name of the selected physical port. + * @param [in] portName Name of the selected physical port. * - * @return True, if the selected physical port has been mapped, false otherwise. + * @return True, if the selected physical port has been mapped, false otherwise. */ bool hasPhysicalPort(QString const& portName) const; /*! * Get the name of the logical port that has been mapped to the selected physical port. * - * @param [in] physicalPortName Name of the selected physical port. + * @param [in] physicalPortName Name of the selected physical port. * - * @return The name of the logical port that has been mapped to the selected physical port. + * @return The name of the logical port that has been mapped to the selected physical port. */ QString getMappedLogicalPortName(QString const& physicalPortName) const; @@ -129,7 +129,7 @@ class IPXACTMODELS_EXPORT AbstractionType /*! * Copy the selected view references. * - * @param [in] newViewReferences The selected view references. + * @param [in] newViewReferences The selected view references. */ void copyViewReferences(QSharedPointer newViewReferences); diff --git a/IPXACTmodels/Component/AccessPolicy.h b/IPXACTmodels/Component/AccessPolicy.h index 36dfeecaf..a0ac606f7 100644 --- a/IPXACTmodels/Component/AccessPolicy.h +++ b/IPXACTmodels/Component/AccessPolicy.h @@ -42,7 +42,7 @@ class IPXACTMODELS_EXPORT AccessPolicy : public Extendable /*! * Set the mode references of the field access policy. * - * @param [in] modeRefs The mode references to set. + * @param [in] modeRefs The mode references to set. */ void setModeReferences(QSharedPointer > > modeRefs); @@ -56,7 +56,7 @@ class IPXACTMODELS_EXPORT AccessPolicy : public Extendable /*! * Set the access value. * - * @param [in] newAccess The new access value. + * @param [in] newAccess The new access value. */ void setAccess(AccessTypes::Access newAccess); diff --git a/IPXACTmodels/Component/AccessPolicyReader.h b/IPXACTmodels/Component/AccessPolicyReader.h index 16f7e32db..c903c9e9a 100644 --- a/IPXACTmodels/Component/AccessPolicyReader.h +++ b/IPXACTmodels/Component/AccessPolicyReader.h @@ -24,7 +24,7 @@ namespace AccessPolicyReader /*! * Create a field access policy from XML description. * - * @param [in] accessPolicyNode The XML description of the access policy. + * @param [in] accessPolicyNode The XML description of the access policy. * * @return The created field access policy. */ @@ -35,16 +35,16 @@ namespace AccessPolicyReader /*! * Read mode references. * - * @param [in] rootNode The containing element. - * @param [in/out] modeRefList The mode reference list to read to. + * @param [in] rootNode The containing element. + * @param [in/out] modeRefList The mode reference list to read to. */ void parseModeRefs(QDomNode const& rootNode, QSharedPointer > > modeRefList); /*! * Parse field access policy access value. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseAccess(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); } diff --git a/IPXACTmodels/Component/AccessPolicyWriter.h b/IPXACTmodels/Component/AccessPolicyWriter.h index e6f044414..9bad0540d 100644 --- a/IPXACTmodels/Component/AccessPolicyWriter.h +++ b/IPXACTmodels/Component/AccessPolicyWriter.h @@ -24,8 +24,8 @@ namespace AccessPolicyWriter /*! * Write a given access policy to XML. * - * @param [in] writer The XML writer to use. - * @param [in] accessPolicy The field access policy to write. + * @param [in] writer The XML writer to use. + * @param [in] accessPolicy The field access policy to write. */ IPXACTMODELS_EXPORT void writeAccessPolicy(QXmlStreamWriter& writer, QSharedPointer accessPolicy); diff --git a/IPXACTmodels/Component/AddressBlock.h b/IPXACTmodels/Component/AddressBlock.h index aa61530b1..a24cac855 100644 --- a/IPXACTmodels/Component/AddressBlock.h +++ b/IPXACTmodels/Component/AddressBlock.h @@ -37,8 +37,8 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * The constructor. * - * @param [in] name Name of the address block. - * @param [in] baseAddress The base address. + * @param [in] name Name of the address block. + * @param [in] baseAddress The base address. */ AddressBlock(QString const& name = QString(), QString const& baseAddress = QString()); @@ -54,63 +54,63 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Clone this address block and return pointer to the copy. * - * @return Pointer to the cloned address block. + * @return Pointer to the cloned address block. */ virtual QSharedPointer clone() const; /*! * Get the type identifier. * - * @return Address block type identifier. + * @return Address block type identifier. */ QString getTypeIdentifier() const; /*! * Set the type identifier. * - * @param [in] newTypeIdentifier The new type identifier. + * @param [in] newTypeIdentifier The new type identifier. */ void setTypeIdentifier(QString const& newTypeIdentifier); /*! * Get the address range of the address block. * - * @return The address range. + * @return The address range. */ QString getRange() const; /*! * Set the address range of the address block. * - * @param [in] newRange The new range value. + * @param [in] newRange The new range value. */ void setRange(QString const& newRange); /*! * Get the attributes linked to range element. * - * @return The range attributes. + * @return The range attributes. */ QMap getRangeAttributes() const; /*! * Set the attributes linked to range element. * - * @param [in] newRangeAttributes The new range attributes. + * @param [in] newRangeAttributes The new range attributes. */ void setRangeAttributes(QMap const& newRangeAttributes); /*! * Get the bit width of a row in the address block. * - * @return The width of the address block. + * @return The width of the address block. */ QString getWidth() const; /*! * Set the bit width of a row in the address block. * - * @param [in] newWidth The new width. + * @param [in] newWidth The new width. */ void setWidth(QString const& newWidth); @@ -124,21 +124,21 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the attributes linked to the width element. * - * @param [in] newWidthAttributes The new attributes for the width element. + * @param [in] newWidthAttributes The new attributes for the width element. */ void setWidthAttributes(QMap const& newWidthAttributes); /*! * Get the type of usage for the address block. * - * @return Usage. + * @return Usage. */ General::Usage getUsage() const; /*! * Set the type of usage for the address block. * - * @param [in] newUsage The new usage type. + * @param [in] newUsage The new usage type. */ void setUsage(General::Usage newUsage); @@ -152,7 +152,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the volatile setting. * - * @param [in] newVolatileSetting True for volatile address block, false otherwise. + * @param [in] newVolatileSetting True for volatile address block, false otherwise. */ void setVolatile(bool newVolatileValue); @@ -164,35 +164,35 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Get the access information. * - * @return Accessibility of the address block data. + * @return Accessibility of the address block data. */ AccessTypes::Access getAccess() const; /*! * Set the accessibility of the address block. * - * @param [in] newAccess The new access type of the address block. + * @param [in] newAccess The new access type of the address block. */ void setAccess(AccessTypes::Access newAccess); /*! * Get the list containing the register elements of address block. * - * @return Pointer to a list containing the register elements. + * @return Pointer to a list containing the register elements. */ QSharedPointer > > getRegisterData() const; /*! * Set the register elements. * - * @param [in] newRegisterData The new register elements. + * @param [in] newRegisterData The new register elements. */ void setRegisterData(QSharedPointer > > newRegisterData); /*! * Get offsets from each of the address block's registers. * - * @return A list of offsets from all the registers. + * @return A list of offsets from all the registers. */ QStringList getAllRegisterOffsets() const; @@ -206,7 +206,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the memory array of the address block. * - * @param [in] newMemoryArray The memory array to set. + * @param [in] newMemoryArray The memory array to set. */ void setMemoryArray(QSharedPointer newMemoryArray); @@ -220,7 +220,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the misalignment allowed attribute. * - * @param [in] newMisalignmentAllowed New misalignment allowed value. + * @param [in] newMisalignmentAllowed New misalignment allowed value. */ void setMisalignmentAllowed(bool newMisalignmentAllowed); @@ -234,7 +234,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the address block definition reference. * - * @param [in] newAddressBlockDefinitionRef The definition reference to set. + * @param [in] newAddressBlockDefinitionRef The definition reference to set. */ void setAddressBlockDefinitionRef(QString const& newAddressBlockDefinitionRef); @@ -248,7 +248,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the type definitions reference. * - * @param [in] newTypeDefinitionsRef The type definitions reference to set. + * @param [in] newTypeDefinitionsRef The type definitions reference to set. */ void setTypeDefinitionsRef(QString const& newTypeDefinitionsRef); @@ -262,7 +262,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Set the access policies of the address block. * - * @param [in] newAccessPolicies The access policies to set. + * @param [in] newAccessPolicies The access policies to set. */ void setAccessPolicies(QSharedPointer > > newAccessPolicies); @@ -271,7 +271,7 @@ class IPXACTMODELS_EXPORT AddressBlock: public MemoryBlockBase /*! * Copy the register elements. * - * @param [in] other Address block being copied. + * @param [in] other Address block being copied. */ void copyRegisterData(const AddressBlock& other); diff --git a/IPXACTmodels/Component/AddressBlockReader.h b/IPXACTmodels/Component/AddressBlockReader.h index dfe49fb64..a7b267370 100644 --- a/IPXACTmodels/Component/AddressBlockReader.h +++ b/IPXACTmodels/Component/AddressBlockReader.h @@ -30,9 +30,9 @@ namespace AddressBlockReader /*! * Creates a new address block from a given address block node. * - * @param [in] addressBlockNode XML description of the address block. + * @param [in] addressBlockNode XML description of the address block. * - * @return The created address block. + * @return The created address block. */ IPXACTMODELS_EXPORT QSharedPointer createAddressBlockFrom(QDomNode const& addressBlockNode, Document::Revision docRevision); @@ -42,88 +42,88 @@ namespace AddressBlockReader /*! * Reads the type identifier. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseTypeIdentifier(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the range. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseRange(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the width. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseWidth(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the usage. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseUsage(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the volatile value. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseVolatile(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the access value. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseAccess(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the register data. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseRegisterData(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock, Document::Revision docRevision); /*! * Reads the memory array of the address block. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseMemoryArray(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the misalignment allowed attribute of the address block. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseMisalignmentAllowed(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the address block definition reference. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseAddressBlockDefinitionRef(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); /*! * Reads the access policies of the address block. * - * @param [in] addressBlockNode XML description of the address block. - * @param [in] newAddressBlock The new address block. + * @param [in] addressBlockNode XML description of the address block. + * @param [in] newAddressBlock The new address block. */ void parseAccessPolicies(QDomNode const& addressBlockNode, QSharedPointer newAddressBlock); } diff --git a/IPXACTmodels/Component/AddressBlockWriter.h b/IPXACTmodels/Component/AddressBlockWriter.h index a9dd13d24..ab481b68d 100644 --- a/IPXACTmodels/Component/AddressBlockWriter.h +++ b/IPXACTmodels/Component/AddressBlockWriter.h @@ -31,8 +31,8 @@ namespace AddressBlockWriter /*! * Write an address block to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] addressBlock The address block to be written. + * @param [in] writer The used XML writer. + * @param [in] addressBlock The address block to be written. */ IPXACTMODELS_EXPORT void writeAddressBlock(QXmlStreamWriter& writer, QSharedPointer addressBlock, Document::Revision docRevision); @@ -42,56 +42,56 @@ namespace AddressBlockWriter /*! * Write the type identifier. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeTypeIdentifier(QXmlStreamWriter& writer, QSharedPointer addressBlock); /*! * Write the usage. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeUsage(QXmlStreamWriter& writer, QSharedPointer addressBlock); /*! * Write the volatile status. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeVolatile(QXmlStreamWriter& writer, QSharedPointer addressBlock); /*! * Write the access value. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeAccess(QXmlStreamWriter& writer, QSharedPointer addressBlock); /*! * Write register data. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeRegisterData(QXmlStreamWriter& writer, QSharedPointer addressBlock, Document::Revision docRevision); /*! * Write the address block definition reference. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeDefinitionReference(QXmlStreamWriter& writer, QSharedPointer addressBlock); /*! * Write the access policies of the address block. * - * @param [in] writer Used XML writer. - * @param [in] addressBlock Selected address block. + * @param [in] writer Used XML writer. + * @param [in] addressBlock Selected address block. */ void writeAccessPolicies(QXmlStreamWriter& writer, QSharedPointer addressBlock); } diff --git a/IPXACTmodels/Component/AddressSpace.h b/IPXACTmodels/Component/AddressSpace.h index b6787cb19..ed72cdfa7 100644 --- a/IPXACTmodels/Component/AddressSpace.h +++ b/IPXACTmodels/Component/AddressSpace.h @@ -36,9 +36,9 @@ class IPXACTMODELS_EXPORT AddressSpace : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the address space. - * @param [in] range The range. - * @param [in] width The width. + * @param [in] name Name of the address space. + * @param [in] range The range. + * @param [in] width The width. */ AddressSpace(QString const& name = QString(), QString const& range = QString(), QString const& width = QString()); @@ -55,105 +55,105 @@ class IPXACTMODELS_EXPORT AddressSpace : public NameGroup, public Extendable /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the address unit bits * - * @return The address unit bits. + * @return The address unit bits. */ QString getAddressUnitBits() const; /*! * Get the range of the address space. * - * @return The range of the address space + * @return The range of the address space */ QString getRange() const; /*! * Get the width of a row in an address space. * - * @return The width of the address space. + * @return The width of the address space. */ QString getWidth() const; /*! * Set the address unit bits. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void setAddressUnitBits(QString const& newAddressUnitBits); /*! * Set the range for the address space. * - * @param [in] newRange The new range. + * @param [in] newRange The new range. */ void setRange(QString const& newRange); /*! * Set the width of the address space. * - * @param [in] newWidth The new width. + * @param [in] newWidth The new width. */ void setWidth(QString const& newWidth); /*! * Get the pointer to the local memory map. * - * @return A pointer to the local memory map. + * @return A pointer to the local memory map. */ QSharedPointer getLocalMemoryMap(); /*! * Check if the address space contains a local memory map. * - * @return True if a local memory map is found. + * @return True if a local memory map is found. */ bool hasLocalMemoryMap() const; /*! * Set the local memory map. * - * @param [in] localMemoryMap A pointer to the new local memory map + * @param [in] localMemoryMap A pointer to the new local memory map */ void setLocalMemoryMap(QSharedPointer localMemoryMap); /*! * Get the parameters of the address space. * - * @return Pointer to a lis containing pointers to the parameters. + * @return Pointer to a lis containing pointers to the parameters. */ QSharedPointer > > getParameters() const; /*! * Set the parameters. * - * @param [in] newParameters Pointer to a list containing the new parameters. + * @param [in] newParameters Pointer to a list containing the new parameters. */ void setParameters(QSharedPointer > > newParameters); /*! * Get the segments contained in this address space. * - * @return Pointer to a list containing pointers to the segments. + * @return Pointer to a list containing pointers to the segments. */ QSharedPointer > > getSegments() const; /*! * Set the segments for this address space. * - * @param [in] segments Pointer to a list containing the new segments for the address space. + * @param [in] segments Pointer to a list containing the new segments for the address space. */ void setSegments(QSharedPointer > > segments); @@ -162,21 +162,21 @@ class IPXACTMODELS_EXPORT AddressSpace : public NameGroup, public Extendable /*! * Copy the local memory map. * - * @param [in] other The address space being copied. + * @param [in] other The address space being copied. */ void copyLocalMemoryMap(const AddressSpace& other); /*! * Copy the segments. * - * @param [in] other The address space being copied. + * @param [in] other The address space being copied. */ void copySegments(const AddressSpace& other); /*! * Copy the parameters. * - * @param [in] other The address space being copied. + * @param [in] other The address space being copied. */ void copyParameters(const AddressSpace& other); diff --git a/IPXACTmodels/Component/AddressSpaceReader.h b/IPXACTmodels/Component/AddressSpaceReader.h index 4328e0b93..ca3990681 100644 --- a/IPXACTmodels/Component/AddressSpaceReader.h +++ b/IPXACTmodels/Component/AddressSpaceReader.h @@ -28,8 +28,8 @@ namespace AddressSpaceReader /*! * Creates a new AddressSpace from a given AddressSpace node. * - * @param [in] AddressSpaceNode XML description of the address space. - * @param [in] docRevision The standard revision to use. + * @param [in] AddressSpaceNode XML description of the address space. + * @param [in] docRevision The standard revision to use. * * @return The created address space. */ @@ -41,65 +41,65 @@ namespace AddressSpaceReader /*! * Parse the name group. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. */ void parseNameGroup(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace); /*! * Parse the block size group. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. */ void readBlockSize(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace); /*! * Parse the segments. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. */ void readSegments(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace); /*! * Parse the address offset. * - * @param [in] segmentNode XML description of a segment. - * @param [in] newSegment The new segment. + * @param [in] segmentNode XML description of a segment. + * @param [in] newSegment The new segment. */ void parseAddressOffset(QDomNode const& segmentNode, QSharedPointer newSegment); /*! * Parse the range. * - * @param [in] segmentNode XML description of a segment. - * @param [in] newSegment The new segment. + * @param [in] segmentNode XML description of a segment. + * @param [in] newSegment The new segment. */ void parseRange(QDomNode const& segmentNode, QSharedPointer newSegment); /*! * Parse the address unit bits. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. */ void parseAddressUnitBits(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace); /*! * Parse the local memory map. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. */ void parseLocalMemoryMap(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace, Document::Revision docRevision); /*! * Parse the parameters. * - * @param [in] addressSpaceNode XML description of the address space. - * @param [in] newAddressSpace The new address space. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] addressSpaceNode XML description of the address space. + * @param [in] newAddressSpace The new address space. + * @param [in] docRevision The IP-XACT standard revision to comply to. * */ void readParameters(QDomNode const& addressSpaceNode, QSharedPointer newAddressSpace, diff --git a/IPXACTmodels/Component/AddressSpaceWriter.h b/IPXACTmodels/Component/AddressSpaceWriter.h index 1555d52c7..ebcbf06fb 100644 --- a/IPXACTmodels/Component/AddressSpaceWriter.h +++ b/IPXACTmodels/Component/AddressSpaceWriter.h @@ -30,9 +30,9 @@ namespace AddressSpaceWriter /*! * Write a AddressSpace to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] AddressSpace The AddressSpace to be written. - * @param [in] docRevision The standard revision to use. + * @param [in] writer The used xml writer. + * @param [in] AddressSpace The AddressSpace to be written. + * @param [in] docRevision The standard revision to use. */ IPXACTMODELS_EXPORT void writeAddressSpace(QXmlStreamWriter& writer, QSharedPointer addressSpace, Document::Revision docRevision); @@ -43,49 +43,49 @@ namespace AddressSpaceWriter /*! * Writes block size of the item. * - * @param [in] writer The used writer. - * @param [in] addressSpace The address space being written. + * @param [in] writer The used writer. + * @param [in] addressSpace The address space being written. */ void writeBlockSize(QXmlStreamWriter& writer, QSharedPointer addressSpace); /*! * Writes segments, if any exists * - * @param [in] addressSpace The address space which is to be written to XML. - * @param [in] writer The writer use to write XLM. + * @param [in] addressSpace The address space which is to be written to XML. + * @param [in] writer The writer use to write XLM. */ void writeSegments(QSharedPointer addressSpace, QXmlStreamWriter& writer); /*! * Writes a single segment. * - * @param [in] writer The used writer. - * @param [in] segment The segment being written. + * @param [in] writer The used writer. + * @param [in] segment The segment being written. */ void writeSingleSegment(QXmlStreamWriter& writer, QSharedPointer segment); /*! * Writes block size of the item. * - * @param [in] writer The used writer. - * @param [in] addressSpace The written attributes. + * @param [in] writer The used writer. + * @param [in] addressSpace The written attributes. */ void writeAttributeMap(QXmlStreamWriter& writer, QMap attributes); /*! * Writes address unit bits. * - * @param [in] writer The used writer. - * @param [in] addressSpace The address space being written. + * @param [in] writer The used writer. + * @param [in] addressSpace The address space being written. */ void writeAddressUnitBits(QXmlStreamWriter& writer, QSharedPointer addressSpace); /*! * Writes the local memory map. * - * @param [in] writer The used writer. - * @param [in] addressSpace The address space being written. - * @param [in] docRevision The standard revision in use. + * @param [in] writer The used writer. + * @param [in] addressSpace The address space being written. + * @param [in] docRevision The standard revision in use. */ void writeLocalMemoryMap(QXmlStreamWriter& writer, QSharedPointer addressSpace, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/AlternateRegister.h b/IPXACTmodels/Component/AlternateRegister.h index 3c4aeebf9..d485e8226 100644 --- a/IPXACTmodels/Component/AlternateRegister.h +++ b/IPXACTmodels/Component/AlternateRegister.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT AlternateRegister : public RegisterDefinition /*! * The constructor. * - * @param [in] name Name of the alternate register. - * @param [in] alternateGroup Name of the first alternate group. + * @param [in] name Name of the alternate register. + * @param [in] alternateGroup Name of the first alternate group. */ AlternateRegister(QString const& name = QString(), QString const& alternateGroup = QString()); @@ -51,20 +51,20 @@ class IPXACTMODELS_EXPORT AlternateRegister : public RegisterDefinition /*! * Clone the alternate register and return pointer to the copy. * - * @return Pointer to the cloned alternate register. + * @return Pointer to the cloned alternate register. */ virtual QSharedPointer clone(); /*! * Get the list of the alternate groups. * - * @return A QList containing the names of the groups. + * @return A QList containing the names of the groups. */ QSharedPointer getAlternateGroups() const; /*! * Set the alternateGroups for this alternateRegister. * - * @param [in] newAlternateGroups A QList containing names of the new groups. + * @param [in] newAlternateGroups A QList containing names of the new groups. */ void setAlternateGroups(QSharedPointer newAlternateGroups); @@ -78,7 +78,7 @@ class IPXACTMODELS_EXPORT AlternateRegister : public RegisterDefinition /*! * Set the mode references of the alternate register. * - * @param [in] newModeReferences The mode references to set. + * @param [in] newModeReferences The mode references to set. */ void setModeReferences(QSharedPointer > > newModeReferences); @@ -87,7 +87,7 @@ class IPXACTMODELS_EXPORT AlternateRegister : public RegisterDefinition /*! * Copy the alternate groups. * - * @param [in] other The alternate register being copied. + * @param [in] other The alternate register being copied. */ void copyAlternateGroups(const AlternateRegister& other); diff --git a/IPXACTmodels/Component/BuildCommand.h b/IPXACTmodels/Component/BuildCommand.h index d71a0f917..d8c66c13d 100644 --- a/IPXACTmodels/Component/BuildCommand.h +++ b/IPXACTmodels/Component/BuildCommand.h @@ -42,28 +42,28 @@ class IPXACTMODELS_EXPORT BuildCommand : public BuildModel /*! * Get the target name. * - * @return The target name. + * @return The target name. */ QString getTargetName() const; /*! * Set the target name. * - * @param [in] targetName The new name of the target. + * @param [in] targetName The new name of the target. */ void setTargetName(const QString &targetName); /*! * Get the flags append value. * - * @return QString containing true for boolean true, false for false and empty for an unspecified. + * @return QString containing true for boolean true, false for false and empty for an unspecified. */ QString getFlagsAppend() const; /*! * Set a new boolean value for the flags append. * - * @param [in] newAppend The new flags append value. + * @param [in] newAppend The new flags append value. */ void setFlagsAppend(bool newAppend); diff --git a/IPXACTmodels/Component/BusInterface.h b/IPXACTmodels/Component/BusInterface.h index b9d34d43a..eed1251a6 100644 --- a/IPXACTmodels/Component/BusInterface.h +++ b/IPXACTmodels/Component/BusInterface.h @@ -84,112 +84,112 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the list of the bitSteering attributes. * - * @return A QMap containing the attributes for bitSteering element. + * @return A QMap containing the attributes for bitSteering element. */ QMap getBitSteeringAttributes(); /*! * Is the bitSteering on or off. * - * @return The bit of the bus interface. + * @return The bit of the bus interface. */ QString getBitSteering() const; /*! * Get bits in lau value. * - * @return The bits in lau value. + * @return The bits in lau value. */ QString getBitsInLau() const; /*! * Get the vlnv to the bus definition. * - * @return The vlnv tag of the bus definition that this bus interface references. + * @return The vlnv tag of the bus definition that this bus interface references. */ ConfigurableVLNVReference getBusType() const; /*! * Can this interface be left unconnected. * - * @return Qstring of true, false or empty. Empty means an unspecified requirement. + * @return Qstring of true, false or empty. Empty means an unspecified requirement. */ QString getConnectionRequired() const; /*! * Get the endianness of the bus interface. * - * @return BIG, LITTLE or UNSPECIFIED. + * @return BIG, LITTLE or UNSPECIFIED. */ Endianness getEndianness() const; /*! * Get the mode of this interface. * - * @return The interface mode. + * @return The interface mode. */ General::InterfaceMode getInterfaceMode() const; /*! * Get the parameters of the bus interface. * - * @return Pointer to a list holding the parameters for this interface. + * @return Pointer to a list holding the parameters for this interface. */ QSharedPointer > > getParameters() const; /*! * Get the abstraction types for this interface. * - * @return Pointer to a list containing the abstraction types for this interface. + * @return Pointer to a list containing the abstraction types for this interface. */ QSharedPointer > > getAbstractionTypes() const; /*! * Set the bit steering attributes for this interface. * - * @param [in] bitSteeringAttributes A QMap holding the new attributes. + * @param [in] bitSteeringAttributes A QMap holding the new attributes. */ void setBitSteeringAttributes(QMap const& bitSteeringAttributes); /*! * Set the bit steering for this interface. * - * @param [in] bitSteering The new bitSteering value. + * @param [in] bitSteering The new bitSteering value. */ void setBitSteering(QString const& bitSteering); /*! * Set the bits in lau value. * - * @param [in] newBitsInLau The new bits for the lau value. + * @param [in] newBitsInLau The new bits for the lau value. */ void setBitsInLau(QString const& newBitsInLau); /*! * Set the bus definition for this interface. * - * @param busType The vlnv of the bus definition. + * @param busType The vlnv of the bus definition. */ void setBusType(ConfigurableVLNVReference const& newBusType); /*! * Set the connectionRequired value. * - * @param [in] connectionRequired True or false. + * @param [in] connectionRequired True or false. */ void setConnectionRequired(bool connectionRequired); @@ -201,49 +201,49 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Set the endianness for this interface. * - * @param [in] endianness BIG, LITTLE or UNSPECIFIED. + * @param [in] endianness BIG, LITTLE or UNSPECIFIED. */ void setEndianness(Endianness endianness); /*! * Set the interface mode for this interface. * - * @param [in] interfaceMode The new interface mode. + * @param [in] interfaceMode The new interface mode. */ void setInterfaceMode(General::InterfaceMode interfaceMode); /*! * Set the port maps for this interface. * - * @param [in] portMaps Pointer to a list containing the port maps for this interface. + * @param [in] portMaps Pointer to a list containing the port maps for this interface. */ void setPortMaps(QSharedPointer > > portMaps); /*! * Set the port maps for this interface. * - * @param [in] abstractionTypes Pointer to a list containing the abstraction types for this interface. + * @param [in] abstractionTypes Pointer to a list containing the abstraction types for this interface. */ void setAbstractionTypes(QSharedPointer > > abstractionTypes); /*! * Get the pointer to the master-element. * - * @return A pointer to the master-instance of the interface. + * @return A pointer to the master-instance of the interface. */ QSharedPointer getMaster() const; /*! * Set the master element for this interface. * - * @param [in] master A pointer to the new master interface. + * @param [in] master A pointer to the new master interface. */ void setMaster(QSharedPointer master); /*! * Get the pointer to the initiator-element. * - * @return A pointer to the initiator-instance of the interface. + * @return A pointer to the initiator-instance of the interface. */ QSharedPointer getInitiator() const; @@ -252,28 +252,28 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Get the pointer to the monitor interface. * - * @return A pointer to the monitor interface. + * @return A pointer to the monitor interface. */ QSharedPointer getMonitor() const; /*! * Set the monitor element for this interface. * - * @param [in] monitor A pointer to the new monitor instance. + * @param [in] monitor A pointer to the new monitor instance. */ void setMonitor(QSharedPointer monitor); /*! * Get the pointer to the slave instance of the interface. * - * @return A pointer to the slave instance of the interface. + * @return A pointer to the slave instance of the interface. */ QSharedPointer getSlave() const; /*! * Set the slave element for this interface. * - * @param [in] slave A pointer to the new slave interface. + * @param [in] slave A pointer to the new slave interface. */ void setSlave(QSharedPointer slave); @@ -282,113 +282,113 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Get the system group name. * - * @return The system group name. + * @return The system group name. */ QString getSystem() const; /*! * Set the system element for this interface. * - * @param [in] systemGroupName The name of the system group to set. + * @param [in] systemGroupName The name of the system group to set. */ void setSystem(QString const& systemGroupName); /*! * Get the pointer to the mirroredSlace element * - * @return A pointer to the mirroredSlave element of this interface. + * @return A pointer to the mirroredSlave element of this interface. */ QSharedPointer getMirroredSlave() const; /*! * Set the mirroredSlave element for this interface. * - * @param [in] mirroredSlave A pointer to the new mirroredSlave instance. + * @param [in] mirroredSlave A pointer to the new mirroredSlave instance. */ void setMirroredSlave(QSharedPointer mirroredSlave); /*! * Get the pointer to the mirroredTarget element * - * @return A pointer to the mirroredTarget element of this interface. + * @return A pointer to the mirroredTarget element of this interface. */ QSharedPointer getMirroredTarget() const; /*! * Set the mirroredTarget element for this interface. * - * @param [in] mirroredTarget A pointer to the new mirroredTarget instance. + * @param [in] mirroredTarget A pointer to the new mirroredTarget instance. */ void setMirroredTarget(QSharedPointer mirroredTarget); /*! * Does this bus interface have a transparent bridge element defined. * - * @return True if a bridge is found, otherwise false. + * @return True if a bridge is found, otherwise false. */ bool hasTransparentBridge() const; /*! * Get the attributes of the bus interface. * - * @return QMap containing the attributes. + * @return QMap containing the attributes. */ QMap getAttributes() const; /*! * Set the attributes for the bus interface. * - * @param [in] attributes QMap containing the attributes. + * @param [in] attributes QMap containing the attributes. */ void setAttributes(QMap const& attributes); /*! * Check if the selected physical port has been mapped in the bus interface. * - * @param [in] portName Name of the selected physical port. + * @param [in] portName Name of the selected physical port. * - * @return True, if the physical port has been mapped, false otherwise. + * @return True, if the physical port has been mapped, false otherwise. */ bool containsMappedPhysicalPort(QString const& portName) const; /*! * Check if the selected logical port has been mapped in the bus interface. * - * @param [in] portName Name of the selected logical port. + * @param [in] portName Name of the selected logical port. * - * @return True, if the selected logical port has been mapped in the bus interface. + * @return True, if the selected logical port has been mapped in the bus interface. */ bool containsMappedlogicalPort(QString const& portName) const; /*! * Get the names of all the mapped physical ports. * - * @return A list of the names of all the mapped physical ports. + * @return A list of the names of all the mapped physical ports. */ QStringList getAllMappedPhysicalPorts() const; /*! * Get the port maps. * - * @return A list containing all the port maps. + * @return A list containing all the port maps. */ QSharedPointer > > getAllPortMaps() const; /*! * Get all the port maps contained within the abstraction type with the selected view reference. * - * @param [in] view Name of the view referenced by the selected abstraction type. + * @param [in] view Name of the view referenced by the selected abstraction type. * - * @return Port maps contained within the abstraction type referencing the selected view. + * @return Port maps contained within the abstraction type referencing the selected view. */ QList > getPortMapsForView(QString const& view) const; /*! * Get the abstraction type referencing the selected view. * - * @param [in] view Name of the selected view referenced by the abstraction type. + * @param [in] view Name of the selected view referenced by the abstraction type. * - * @return The abstraction type referencing the selected view. + * @return The abstraction type referencing the selected view. */ QSharedPointer getAbstractionContainingView(QString const& view) const; @@ -410,28 +410,28 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Sets the default position in the parent component's graphical representation. * - * @param [in] pos The position to set. + * @param [in] pos The position to set. */ void setDefaultPos(QPointF const& pos); /*! * Returns the default position in the parent component's graphical representation. * - * @return The default position. + * @return The default position. */ QPointF getDefaultPos(); /*! * Get the memory map reference of a slave interface. * - * @return The name of the memory map referenced by slave interface. + * @return The name of the memory map referenced by slave interface. */ QString getMemoryMapRef() const; /*! * Get the address space reference of a master or mirrored master interface. * - * @return The name of the address space referenced by interface. + * @return The name of the address space referenced by interface. */ QString getAddressSpaceRef() const; @@ -440,21 +440,21 @@ class IPXACTMODELS_EXPORT BusInterface : public NameGroup, public Extendable /*! * Copy the abstraction types. * - * @param [in] other The bus interface being copied. + * @param [in] other The bus interface being copied. */ void copyAbstractionTypes(const BusInterface& other); /*! * Copy the parameters. * - * @param [in] other The bus interface being copied. + * @param [in] other The bus interface being copied. */ void copyParameters(const BusInterface& other); /*! * Copy the interface modes. * - * @param [in] other The bus interface being copied. + * @param [in] other The bus interface being copied. */ void copyInterfaceModes(const BusInterface& other); diff --git a/IPXACTmodels/Component/BusInterfaceReader.h b/IPXACTmodels/Component/BusInterfaceReader.h index b7f04f7c4..1c5fe22b9 100644 --- a/IPXACTmodels/Component/BusInterfaceReader.h +++ b/IPXACTmodels/Component/BusInterfaceReader.h @@ -28,10 +28,10 @@ namespace BusinterfaceReader /*! * Creates a new businterface from a given bus interface XML description. * - * @param [in] businterfaceNode XML description of the businterface. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] businterfaceNode XML description of the businterface. + * @param [in] docRevision The applied IP-XACT standard revision. * - * @return A new BusInterface. + * @return A new BusInterface. */ IPXACTMODELS_EXPORT QSharedPointer createBusinterfaceFrom(QDomNode const& businterfaceNode, Document::Revision docRevision); @@ -41,49 +41,49 @@ namespace BusinterfaceReader /*! * Parses the bus type for the bus interface. * - * @param [in] businterfaceElement XML description of the businterface. - * @param [in] busInterface The new businterface item. + * @param [in] businterfaceElement XML description of the businterface. + * @param [in] busInterface The new businterface item. */ void parseBusType(QDomElement& businterfaceElement, QSharedPointer newbusinterface); /*! * Parses the connectionRequired element for the bus interface. * - * @param [in] businterfaceElement XML description of the businterface. - * @param [in] busInterface The new businterface item. + * @param [in] businterfaceElement XML description of the businterface. + * @param [in] busInterface The new businterface item. */ void parseConnectionRequired(QDomElement& businterfaceElement, QSharedPointer newbusinterface); /*! * Parses the bits in lau element for the bus interface. * - * @param [in] businterfaceElement XML description of the businterface. - * @param [in] busInterface The new businterface item. + * @param [in] businterfaceElement XML description of the businterface. + * @param [in] busInterface The new businterface item. */ void parseBitsInLau(QDomElement& businterfaceElement, QSharedPointer newbusinterface); /*! * Parses the bit steering element for the bus interface. * - * @param [in] businterfaceElement XML description of the businterface. - * @param [in] busInterface The new businterface item. + * @param [in] businterfaceElement XML description of the businterface. + * @param [in] busInterface The new businterface item. */ void parseBitSteering(QDomElement& businterfaceElement, QSharedPointer newbusinterface); /*! * Parses the endianess element for the bus interface. * - * @param [in] businterfaceElement XML description of the businterface. - * @param [in] busInterface The new businterface item. + * @param [in] businterfaceElement XML description of the businterface. + * @param [in] busInterface The new businterface item. */ void parseEndianess(QDomElement& businterfaceElement, QSharedPointer newbusinterface); /*! * Parses the abstraction types for the bus interface. * - * @param [in] businterfaceElement The potential XML-node to yield abstraction types. - * @param [in] busInterface The new businterface item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] businterfaceElement The potential XML-node to yield abstraction types. + * @param [in] busInterface The new businterface item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseAbstractionTypes(QDomElement const& businterfaceElement, QSharedPointer busInterface, Document::Revision docRevision); @@ -91,8 +91,8 @@ namespace BusinterfaceReader /*! * Reads the view references. * - * @param [in] abstractionNode The examined abstraction type node. - * @param [in] newAbstractionType The abstraction type matching the selected node. + * @param [in] abstractionNode The examined abstraction type node. + * @param [in] newAbstractionType The abstraction type matching the selected node. */ void parseViewReferences(QDomNode const& abstractionNode, QSharedPointer newAbstractionType); @@ -100,9 +100,9 @@ namespace BusinterfaceReader /*! * Tries to extract port maps from the parameter inspected and append them to parameter abstractionType. * - * @param [in] inspected The potential XML-node to yield abstraction types. - * @param [in] abstractionType The object that will receive extracted port maps as a field. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] inspected The potential XML-node to yield abstraction types. + * @param [in] abstractionType The object that will receive extracted port maps as a field. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parsePortMaps(QDomElement const& portMapsElement, QSharedPointer abstractionType, Document::Revision docRevision); @@ -110,24 +110,24 @@ namespace BusinterfaceReader /*! * Extracts a logical port from parameter logicalPortElement and sets it to parameter portMap. * - * @param [in] logicalPortElement The XML-node to yield port. - * @param [in] portMap The port map, which port is being set. + * @param [in] logicalPortElement The XML-node to yield port. + * @param [in] portMap The port map, which port is being set. */ void parseLogicalPort(QDomElement const& logicalPortElement, QSharedPointer portMap); /*! * Extracts a physical port from parameter physicalPortElement and sets it to parameter portMap. * - * @param [in] physicalPortElement The XML-node to yield port. - * @param [in] portMap The port map, which port is being set. + * @param [in] physicalPortElement The XML-node to yield port. + * @param [in] portMap The port map, which port is being set. */ void parsePhysicalPort(QDomElement const& physicalPortElement, QSharedPointer portMap); /*! * Tries to read interface mode from parameter busInterfaceElement and set it to newbusinterface. * - * @param [in] busInterfaceElement The potential XML-node to yield interface mode. - * @param [in] newbusinterface This interface will have the extracted interface mode. + * @param [in] busInterfaceElement The potential XML-node to yield interface mode. + * @param [in] newbusinterface This interface will have the extracted interface mode. */ void parseInterfaceMode(QDomElement const& busInterfaceElement, QSharedPointer newbusinterface, Document::Revision docRevision); @@ -135,8 +135,8 @@ namespace BusinterfaceReader /*! * Reads fields for a master interface struct from XML-input. * - * @param [in] masterInterfaceElement The XML description to parse the information from. - * @param [in] masterInterface The interface object, which fields will be assigned. + * @param [in] masterInterfaceElement The XML description to parse the information from. + * @param [in] masterInterface The interface object, which fields will be assigned. */ void parseMasterInterface(QDomElement const& masterInterfaceElement, QSharedPointer masterInterface); @@ -144,8 +144,8 @@ namespace BusinterfaceReader /*! * Reads fields for a slave interface struct from XML-input. * - * @param [in] slaveIntefaceElement The XML description to parse the information from. - * @param [in] slaveInterface The interface object, which fields will be assigned. + * @param [in] slaveIntefaceElement The XML description to parse the information from. + * @param [in] slaveInterface The interface object, which fields will be assigned. */ void parseSlaveInterface(QDomElement const& slaveIntefaceElement, QSharedPointer slaveInterface); @@ -153,8 +153,8 @@ namespace BusinterfaceReader /*! * Reads fields for a mirrored interface struct from XML-input. * - * @param [in] mirroredInterfaceElement The XML description to parse the information from. - * @param [in] mirroredSlaveInterface The interface object, which fields will be assigned. + * @param [in] mirroredInterfaceElement The XML description to parse the information from. + * @param [in] mirroredSlaveInterface The interface object, which fields will be assigned. */ void parseMirroredSlaveInterface(QDomElement const& mirroredInterfaceElement, QSharedPointer mirroredSlaveInterface); @@ -162,8 +162,8 @@ namespace BusinterfaceReader /*! * Reads fields for a monitor interface struct from XML-input. * - * @param [in] monitorElement The XML description to parse the information from. - * @param [in] newmode The interface object, which fields will be assigned. + * @param [in] monitorElement The XML description to parse the information from. + * @param [in] newmode The interface object, which fields will be assigned. */ void parseMonitorInterface(QDomElement const& monitorElement, QSharedPointer monitorInterface); @@ -179,8 +179,8 @@ namespace BusinterfaceReader /*! * Read the extensions of the bus interface. * - * @param [in] interfaceNode XML description of the bus interface. - * @param [in] newInterface The new bus interface item. + * @param [in] interfaceNode XML description of the bus interface. + * @param [in] newInterface The new bus interface item. */ void parseBusInterfaceExtensions(QDomNode const& interfaceNode, QSharedPointer newInterface); diff --git a/IPXACTmodels/Component/BusInterfaceWriter.h b/IPXACTmodels/Component/BusInterfaceWriter.h index f991e2164..20366090f 100644 --- a/IPXACTmodels/Component/BusInterfaceWriter.h +++ b/IPXACTmodels/Component/BusInterfaceWriter.h @@ -29,9 +29,9 @@ namespace BusInterfaceWriter /*! * Write a businterface to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT void writeBusInterface(QXmlStreamWriter& writer, QSharedPointer businterface, Document::Revision docRevision); @@ -42,41 +42,41 @@ namespace BusInterfaceWriter /*! * Writes the connection requirement. * - * @param [in] writer The used XML writer. - * @param [in] busInterface The bus interface to be written. + * @param [in] writer The used XML writer. + * @param [in] busInterface The bus interface to be written. */ void writeConnectionRequired(QXmlStreamWriter& writer, QSharedPointer busInterface); /*! * Writes the bits in lau. * - * @param [in] writer The used XML writer. - * @param [in] busInterface The bus interface to be written. + * @param [in] writer The used XML writer. + * @param [in] busInterface The bus interface to be written. */ void writeBitsInLau(QXmlStreamWriter& writer, QSharedPointer busInterface); /*! * Writes the endianness. * - * @param [in] writer The used XML writer. - * @param [in] busInterface The bus interface to be written. + * @param [in] writer The used XML writer. + * @param [in] busInterface The bus interface to be written. */ void writeEndianness(QXmlStreamWriter& writer, QSharedPointer busInterface); /*! * Write the bit steering of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. */ void writeBitSteering(QXmlStreamWriter& writer, QSharedPointer businterface); /*! * Write the abstraction types of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeAbstractionTypes(QXmlStreamWriter& writer, QSharedPointer businterface, Document::Revision docRevision); @@ -84,9 +84,9 @@ namespace BusInterfaceWriter /*! * Write the port maps of an abstraction type. * - * @param [in] writer The used xml writer. - * @param [in] abstractionType The abstraction type whose port maps to write. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] abstractionType The abstraction type whose port maps to write. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writePortMaps(QXmlStreamWriter& writer, QSharedPointer abstractionType, Document::Revision docRevision); @@ -94,48 +94,48 @@ namespace BusInterfaceWriter /*! * Write the logical port of port map. * - * @param [in] writer The used xml writer. - * @param [in] logicalPort The logical port to be written. + * @param [in] writer The used xml writer. + * @param [in] logicalPort The logical port to be written. */ void writeLogicalPort(QXmlStreamWriter& writer, QSharedPointer physicalPort); /*! * Write the physical port of port map. * - * @param [in] writer The used xml writer. - * @param [in] physicalPort The physical port to be written. + * @param [in] writer The used xml writer. + * @param [in] physicalPort The physical port to be written. */ void writePhysicalPort(QXmlStreamWriter& writer, QSharedPointer physicalPort); /*! * Write the interface mode of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. */ void writeInterfaceMode(QXmlStreamWriter& writer, QSharedPointer businterface); /*! * Write the master interface of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface master to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface master to be written. */ void writeMasterInterface(QXmlStreamWriter& writer, QSharedPointer masterInterface); /*! * Write the slave interface of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface slave to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface slave to be written. */ void writeSlaveInterface(QXmlStreamWriter& writer, QSharedPointer slave); /*! * Write the mirrored slave interface of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. */ void writeMirroredSlaveInterface(QXmlStreamWriter& writer, QSharedPointer mirroredSlave); @@ -143,8 +143,8 @@ namespace BusInterfaceWriter /*! * Write the monitor interface of businterface. * - * @param [in] writer The used xml writer. - * @param [in] businterface The businterface to be written. + * @param [in] writer The used xml writer. + * @param [in] businterface The businterface to be written. */ void writeMonitorInterface(QXmlStreamWriter& writer, QSharedPointer businterface); diff --git a/IPXACTmodels/Component/CPUReader.h b/IPXACTmodels/Component/CPUReader.h index 998b6bd82..30f18b430 100644 --- a/IPXACTmodels/Component/CPUReader.h +++ b/IPXACTmodels/Component/CPUReader.h @@ -28,7 +28,7 @@ namespace CPUReader /*! * Creates a new CPU from a given CPU node. * - * @param [in] cpuNode XML description of the CPU. + * @param [in] cpuNode XML description of the CPU. */ IPXACTMODELS_EXPORT QSharedPointer createCPUFrom(QDomNode const& cpuNode, Document::Revision docRevision); @@ -37,16 +37,16 @@ namespace CPUReader /*! * Reads the presence. * - * @param [in] cpuNode XML description of the cpu. - * @param [in] newCPU The new cpu item. + * @param [in] cpuNode XML description of the cpu. + * @param [in] newCPU The new cpu item. */ void parseIsPresent(QDomNode const& cpuNode, QSharedPointer newCPU); /*! * Reads the address space references. * - * @param [in] cpuNode XML description of the cpu. - * @param [in] newCPU The new cpu item. + * @param [in] cpuNode XML description of the cpu. + * @param [in] newCPU The new cpu item. */ void parseAddressSpaceRefs(QDomNode const& cpuNode, QSharedPointer newCpu); @@ -68,8 +68,8 @@ namespace CPUReader /*! * Reads the parameters. * - * @param [in] cpuNode XML description of the cpu. - * @param [in] newCPU The new cpu item. + * @param [in] cpuNode XML description of the cpu. + * @param [in] newCPU The new cpu item. */ void parseParameters(QDomNode const& cpuNode, QSharedPointer newCpu); } diff --git a/IPXACTmodels/Component/CPUWriter.h b/IPXACTmodels/Component/CPUWriter.h index d4d762312..7d55f6a6d 100644 --- a/IPXACTmodels/Component/CPUWriter.h +++ b/IPXACTmodels/Component/CPUWriter.h @@ -30,8 +30,8 @@ namespace CPUWriter /*! * Write a CPU to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] cpu The cpu to be written. + * @param [in] writer The used xml writer. + * @param [in] cpu The cpu to be written. */ IPXACTMODELS_EXPORT void writeCPU(QXmlStreamWriter& writer, QSharedPointer cpu, Document::Revision docRevision); @@ -40,8 +40,8 @@ namespace CPUWriter /*! * Writes the address space references. * - * @param [in] writer The used xml writer. - * @param [in] cpu The cpu to be written. + * @param [in] writer The used xml writer. + * @param [in] cpu The cpu to be written. */ void writeAddressSpaceRefs(QXmlStreamWriter& writer, QSharedPointer cpu); diff --git a/IPXACTmodels/Component/Channel.h b/IPXACTmodels/Component/Channel.h index 86ebd6e65..adc1632c4 100644 --- a/IPXACTmodels/Component/Channel.h +++ b/IPXACTmodels/Component/Channel.h @@ -62,20 +62,20 @@ class IPXACTMODELS_EXPORT Channel : public NameGroup, public Extendable /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! Get the references to bus interfaces that belong to this channel. * - * @return The interface name references. + * @return The interface name references. */ QStringList getInterfaceNames() const; @@ -83,7 +83,7 @@ class IPXACTMODELS_EXPORT Channel : public NameGroup, public Extendable /*! Set the interfaces that belong to this channel. * - * @param [in] interfaceNames The name references to interfaces. + * @param [in] interfaceNames The name references to interfaces. */ void setInterfaces(QStringList const& interfaceNames); diff --git a/IPXACTmodels/Component/ChannelReader.h b/IPXACTmodels/Component/ChannelReader.h index 1c74b9b8a..dd3fd1239 100644 --- a/IPXACTmodels/Component/ChannelReader.h +++ b/IPXACTmodels/Component/ChannelReader.h @@ -28,8 +28,8 @@ namespace ChannelReader /*! * Creates a new channel from a given channel node. * - * @param [in] channelNode XML description of the channel. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] channelNode XML description of the channel. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT QSharedPointer createChannelFrom(QDomNode const& channelNode, Document::Revision docRevision); @@ -40,9 +40,9 @@ namespace ChannelReader /*! * Parses the local interface references for the channel. * - * @param [in] channelNode XML description of the channel. - * @param [in] newChannel The channel to add the references to. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] channelNode XML description of the channel. + * @param [in] newChannel The channel to add the references to. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseInterfaceReferences(QDomNode const& channelNode, QSharedPointer newChannel, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/ChannelWriter.h b/IPXACTmodels/Component/ChannelWriter.h index 387c7998f..1010536ec 100644 --- a/IPXACTmodels/Component/ChannelWriter.h +++ b/IPXACTmodels/Component/ChannelWriter.h @@ -28,9 +28,9 @@ namespace ChannelWriter /*! * Write a channel to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] channel The channel to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] channel The channel to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT void writeChannel(QXmlStreamWriter& writer, QSharedPointer channel, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/Component.h b/IPXACTmodels/Component/Component.h index d416cfd80..3fee686f6 100644 --- a/IPXACTmodels/Component/Component.h +++ b/IPXACTmodels/Component/Component.h @@ -85,49 +85,49 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Clone this component and return pointer to the copy. * - * @return Pointer to the cloned component. + * @return Pointer to the cloned component. */ QSharedPointer clone() const final; /*! * Is this a bus component. * - * @return true if this is a bus component, false otherwise. + * @return true if this is a bus component, false otherwise. */ bool isBus() const; /*! * Does the component contain a channel-element. * - * @return True if a channel element is found. + * @return True if a channel element is found. */ bool isChannel() const; /*! * Does the component contain a transparent bridge element. * - * @return True if a transparent bridge element is found. + * @return True if a transparent bridge element is found. */ bool isTransparentBridge() const; /*! * Does the component contain an opaque bridge. * - * @return True if an opaque bridge is found. + * @return True if an opaque bridge is found. */ bool isOpaqueBridge() const; /*! * Is this component a cpu. * - * @return True, if this is a cpu, otherwise false. + * @return True, if this is a cpu, otherwise false. */ bool isCpu() const; /*! * Is this component a hierarchical component or not. * - * @return True if the component has design with subcomponents. False if the component is a flat component. + * @return True if the component has design with subcomponents. False if the component is a flat component. */ bool isHierarchical() const; @@ -136,14 +136,14 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get list of the bus interfaces of a component. * - * @return A list containing pointers to the bus interfaces. + * @return A list containing pointers to the bus interfaces. */ QSharedPointer > > getBusInterfaces() const; /*! * Set the bus interfaces for the component. * - * @param [in] newBusInterfaces A list containing the pointers to the new bus interfaces. + * @param [in] newBusInterfaces A list containing the pointers to the new bus interfaces. * */ void setBusInterfaces(QSharedPointer > > newBusInterfaces); @@ -159,7 +159,7 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the bus interfaces containing port maps referencing the selected port. * - * @param [in] portName The name of the selected port. + * @param [in] portName The name of the selected port. * * return A list of interfaces containing references to the selected port. */ @@ -168,112 +168,112 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the indirect interfaces of a component. * - * @return The indirect interfaces of the component. + * @return The indirect interfaces of the component. */ QSharedPointer > > getIndirectInterfaces() const; /*! * Get this component's channels. * - * @return A list containing component's channels. + * @return A list containing component's channels. */ QSharedPointer > > getChannels() const; /*! * Set this component's channels. * - * @param [in] newChannels A list containing the new channels to be set. + * @param [in] newChannels A list containing the new channels to be set. */ void setChannels(QSharedPointer > > newChannels); /*! * Get this component's remap states. * - * @return A list containing component's remap states. + * @return A list containing component's remap states. */ QSharedPointer > > getRemapStates() const; /*! * Get this component's modes. * - * @return The component's modes. + * @return The component's modes. */ QSharedPointer > > getModes() const; /*! * Set the remap states. * - * @param [in] newRemapStates A list containing the new remap states. + * @param [in] newRemapStates A list containing the new remap states. */ void setRemapStates(QSharedPointer > > newRemapStates); /*! * Get this component's address spaces. * - * @return A list containing component's address spaces. + * @return A list containing component's address spaces. */ QSharedPointer > > getAddressSpaces() const; /*! * Set this component's address spaces * - * @param [in] addressSpaces A list containing the address spaces to be set. + * @param [in] addressSpaces A list containing the address spaces to be set. */ void setAddressSpaces(QSharedPointer > > newAddressSpaces); /*! * Get this component's memory maps. * - * @return A list containing component's memory maps. + * @return A list containing component's memory maps. */ QSharedPointer > > getMemoryMaps() const; /*! * Set this components memory maps. * - * @param [in] newMemoryMaps A list containing the memory maps to be set. + * @param [in] newMemoryMaps A list containing the memory maps to be set. */ void setMemoryMaps(QSharedPointer > > newMemoryMaps); /*! * Get this component's model information. * - * @return Pointer to this component's model information. + * @return Pointer to this component's model information. */ QSharedPointer getModel() const; /*! * Set this component's model information. * - * @param [in] model Pointer to the model information to be set. + * @param [in] model Pointer to the model information to be set. */ void setModel(QSharedPointer newModel); /*! * Get the views of the component. * - * @return A list containing pointers to the views. + * @return A list containing pointers to the views. */ QSharedPointer > > getViews() const; /*! * Set the views. * - * @param [in] newViews A list containing the new views.. + * @param [in] newViews A list containing the new views.. */ void setViews(QSharedPointer > > newViews); /*! * Get the component instantiations. * - * @return A list containing component instantiations. + * @return A list containing component instantiations. */ QSharedPointer > > getComponentInstantiations() const; /*! * Set the component instantiations. * - * @param [in] newInstantiation A list containing the new component instantiations. + * @param [in] newInstantiation A list containing the new component instantiations. */ void setComponentInstantiations( QSharedPointer > > newInstantiation); @@ -281,21 +281,21 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the design instantiations. * - * @return A list containing the design instantiations. + * @return A list containing the design instantiations. */ QSharedPointer > > getDesignInstantiations() const; /*! * Set the design instantiations. * - * @param [in] newInstantiations A list containing the new design instantiations. + * @param [in] newInstantiations A list containing the new design instantiations. */ void setDesignInstantiations(QSharedPointer > > newInstantiations); /*! * Get the design configuration instantiations. * - * @return A list containing the design configuration instantiations. + * @return A list containing the design configuration instantiations. */ QSharedPointer > > getDesignConfigurationInstantiations() const; @@ -303,7 +303,7 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Set the design configuration instantiations. * - * @param [in] newInstantiations A list containing the new design configuration instantiations. + * @param [in] newInstantiations A list containing the new design configuration instantiations. */ void setDesignConfigurationInstantiations( QSharedPointer > > newInstantiations); @@ -311,224 +311,224 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the ports contained in this component. * - * @return A list containing pointers to the ports. + * @return A list containing pointers to the ports. */ QSharedPointer > > getPorts() const; /*! * Set the ports. * - * @param [in] newPorts A list containing the new ports. + * @param [in] newPorts A list containing the new ports. */ void setPorts(QSharedPointer > > newPorts); /*! * Get this components component generators. * - * @return A list containing component's component generators. + * @return A list containing component's component generators. */ QSharedPointer > > getComponentGenerators() const; /*! * Set this component's component generators. * - * @param [in] newGenerators A list containing the component generators to be set. + * @param [in] newGenerators A list containing the component generators to be set. */ void setComponentGenerators(QSharedPointer > > newGenerators); /*! * Get this component's choices. * - * @return A list containing component's choices. + * @return A list containing component's choices. */ QSharedPointer > > getChoices() const; /*! * Set the choices. * - * @param [in] newChoices A list containing the new choices. + * @param [in] newChoices A list containing the new choices. */ void setChoices(QSharedPointer > > newChoices); /*! * Get the file sets of this component. * - * @return A list containing pointers to the file sets. + * @return A list containing pointers to the file sets. */ QSharedPointer > > getFileSets() const; /*! * Set this component's file sets. * - * @param [in] newFileSets A list containing the file sets to be set. + * @param [in] newFileSets A list containing the file sets to be set. */ void setFileSets(QSharedPointer > > newFileSets); /*! * Get this component's cpus. * - * @return QList containing component's cpus. + * @return QList containing component's cpus. */ QSharedPointer > >getCpus() const; /*! * Set this component's cpus. * - * @param [in] cpus A list containing the cpus to be set. + * @param [in] cpus A list containing the cpus to be set. */ void setCpus(QSharedPointer > > newCpus); /*! * Get this component's other clock drivers. * - * @return A list containing component's other clock drivers. + * @return A list containing component's other clock drivers. */ QSharedPointer > > getOtherClockDrivers() const; /*! * Set other clock drivers for this component. * - * @param [in] newOtherClockDrivers A list containing the other clock drivers to be set. + * @param [in] newOtherClockDrivers A list containing the other clock drivers to be set. */ void setOtherClockDrivers(QSharedPointer > > newOtherClockDrivers); /*! * Get this component's reset types. * - * @return A list containing the reset types. + * @return A list containing the reset types. */ QSharedPointer > > getResetTypes() const; /*! * Set reset types for this component. * - * @param [in] newResetTypes A list containing the new reset types. + * @param [in] newResetTypes A list containing the new reset types. */ void setResetTypes(QSharedPointer > > newResetTypes); /*! * Returns the list of SW properties. * - * @return A list of sw properties. + * @return A list of sw properties. */ QList > getSWProperties() const; /*! * Sets the SW properties. * - * @param [in] properties A list of properties to set. + * @param [in] properties A list of properties to set. */ void setSWProperties(QList > newProperties); /*! * Get the system views of the component. * - * @return QList containing pointers to the system views. + * @return QList containing pointers to the system views. */ QList > getSystemViews() const; /*! * Set the system views. * - * @param [in] newSystemViews List containing the new system views. + * @param [in] newSystemViews List containing the new system views. */ void setSystemViews(QList > newSystemViews); /*! * Returns the COM interfaces. * - * @return A list of com interfaces. + * @return A list of com interfaces. */ QList > getComInterfaces() const; /*! * Set the com interfaces. * - * @param [in] newComInterfaces A list of the new com interfaces. + * @param [in] newComInterfaces A list of the new com interfaces. */ void setComInterfaces(QList > newComInterfaces); /*! * Returns the API interfaces. * - * @return A list of API interfaces. + * @return A list of API interfaces. */ QList > getApiInterfaces() const; /*! * Set the api interfaces. * - * @param [in] newApiInterfaces A list of new api interfaces. + * @param [in] newApiInterfaces A list of new api interfaces. */ void setApiInterfaces(QList > newApiInterfaces); /*! * Get this component's file dependencies. * - * @return QList containing component's file dependencies. + * @return QList containing component's file dependencies. */ QList > getFileDependencies() const; /*! * Set the file dependencies. * - * @param [in] newFileDependencies A list of new file dependencies. + * @param [in] newFileDependencies A list of new file dependencies. */ void setFileDependendencies(QList > newFileDependencies); /*! * Returns the pending dependency list for writing. * - * @return A list of pending dependencies. + * @return A list of pending dependencies. */ QList > getPendingFileDependencies() const; /*! * Set the pending file dependencies. * - * @param [in] newFileDependencies A list of new pending file dependencies. + * @param [in] newFileDependencies A list of new pending file dependencies. */ void setPendingFileDependencies(QList > newFileDependencies); /*! * Returns the list of source directories. * - * @return A list of source directiories. + * @return A list of source directiories. */ QStringList getSourceDirectories() const; /*! * Sets the source directories where to automatically scan files to file sets. * - * @param [in] sourceDirs The source directories to set. + * @param [in] sourceDirs The source directories to set. */ void setSourceDirectories(QStringList const& sourceDirs); /*! * Gets the author of the component. * - * @return The component author. + * @return The component author. */ QString getAuthor() const; /*! * Sets the author of the component. * - * @param [in] author The name of the component author. + * @param [in] author The name of the component author. */ void setAuthor(QString const& author); /*! * Get list of the files needed by this component. * - * @return A list containing the paths to the files. + * @return A list containing the paths to the files. */ QStringList getDependentFiles() const final; /*! * Get list of the VLNVs needed by this component. * - * @return QList containing pointers to the VLNVs. + * @return QList containing pointers to the VLNVs. */ QList getDependentVLNVs() const final; @@ -537,7 +537,7 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the names of the remap states. * - * @return A list containing the names of the remap states. + * @return A list containing the names of the remap states. */ QStringList getRemapStateNames() const; @@ -545,37 +545,37 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the names of the memory maps contained within this component. * - * @return QStringList containing the memory map names. + * @return QStringList containing the memory map names. */ QStringList getMemoryMapNames() const; /*! * Checks if the component contains views. * - * @return True if views exist. + * @return True if views exist. */ bool hasViews() const; /*! * Check if the component has a view with given name. * - * @param [in] viewName The name of the view to search for. + * @param [in] viewName The name of the view to search for. * - * @return True if the view is found. + * @return True if the view is found. */ bool hasView(const QString& viewName) const; /*! * Get the names of the views of the component. * - * @return QStringList containing the view names. + * @return QStringList containing the view names. */ QStringList getViewNames() const; /*! * Get the names of the CPU elements within component. * - * @return QStringList containing the CPU names. + * @return QStringList containing the CPU names. */ QStringList getCpuNames() const; @@ -589,144 +589,144 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the non-hierarchical views of a component. * - * @return QStringList containing the names of the non-hierarchical HW views. + * @return QStringList containing the names of the non-hierarchical HW views. */ QStringList getFlatViews() const; /*! * Get the design of a hierarchical component. * - * @return A vlnv of a design or configuration that is used within this component. + * @return A vlnv of a design or configuration that is used within this component. */ VLNV getHierRef(const QString viewName = QString()) const; /*! * Get the hierarchical references this component contains. * - * @return QList contains the VLNVs of the hierarchical references. + * @return QList contains the VLNVs of the hierarchical references. */ QList getHierRefs() const; /*! * Checks if the component contains system views. * - * @return True if system views exist. + * @return True if system views exist. */ bool hasSystemViews() const; /*! * Check if the component has a system view with given name. * - * @param [in] viewName The name of the system view to search for. + * @param [in] viewName The name of the system view to search for. * - * @return True if the view is found. + * @return True if the view is found. */ bool hasSystemView(const QString& viewName) const; /*! * Get the names of the system views of the component. * - * @return QStringList containing the system view names. + * @return QStringList containing the system view names. */ QStringList getSystemViewNames() const; /*! * Find a named system view within a component. * - * @param [in] name The name of the system view to search for. + * @param [in] name The name of the system view to search for. * - * @return Pointer to the specified system view. Null pointer if the system view was not found. + * @return Pointer to the specified system view. Null pointer if the system view was not found. */ QSharedPointer findSystemView(QString const& name) const; /*! * Find a system view which refers to the given VLNV. * - * @param [in] hierRef The VLNV to the design/configuration that is searched among the views. + * @param [in] hierRef The VLNV to the design/configuration that is searched among the views. * - * @return Pointer to the system view. Null pointer if no system view is found. + * @return Pointer to the system view. Null pointer if no system view is found. */ QSharedPointer findSystemView(const VLNV& hierRef) const; /*! * Get the system design of a hierarchical component. * - * @return A vlnv of a design or configuration that is used within this component. + * @return A vlnv of a design or configuration that is used within this component. */ VLNV getHierSystemRef(QString const& viewName = QString()) const; /*! * Get the hierarchical system references this component contains. * - * @return QList contains the VLNVs of the hierarchical system references. + * @return QList contains the VLNVs of the hierarchical system references. */ QList getHierSystemRefs() const; /*! * Get names of the file sets stored in the component. * - * @return QStringList containing the names of the file sets of the component. + * @return QStringList containing the names of the file sets of the component. */ QStringList getFileSetNames() const; /*! * Get the specified file set if one exists. * - * @param [in] name Name of the file set that is wanted. + * @param [in] name Name of the file set that is wanted. * - * @return Pointer to the file set. If file set was not found, creates and returns pointer to it. + * @return Pointer to the file set. If file set was not found, creates and returns pointer to it. */ QSharedPointer getFileSet(const QString& name) const; /*! * Check if the component has the named file set or not. * - * @param [in] fileSetName The name of the file set to search + * @param [in] fileSetName The name of the file set to search * - * @return True if the file set is found. + * @return True if the file set is found. */ bool hasFileSet(const QString& fileSetName) const; /*! * Checks if the component contains file sets. * - * @return True if file sets exist. + * @return True if file sets exist. */ bool hasFileSets() const; /*! * Returns all file pointers in all file sets that reference the given file name. * - * @param [in] filename The filename to search for. - * @param [out] files All found files that reference the given file name. + * @param [in] filename The filename to search for. + * @param [out] files All found files that reference the given file name. */ QList > getFiles(QString const& fileName) const; /*! * Find the files that match the specified file type. * - * @param [in] fileType The file type to search within the files. + * @param [in] fileType The file type to search within the files. * - * @return QStringList containing the file paths of files matching the file type. + * @return QStringList containing the file paths of files matching the file type. */ QStringList findFilesByFileType(const QString& fileType) const; /*! * Find the file set by the file set id. * - * @param [in] id Identifies the file set. + * @param [in] id Identifies the file set. * - * @return Pointer to the file set found, null pointer if none found. + * @return Pointer to the file set found, null pointer if none found. */ QSharedPointer findFileSetById(QString const& id) const; /*! * Get file paths of all specified file sets that match the specified file types. * - * @param [in] fileSetNames Contains the file sets to search from. - * @param [in] fileTypes Contains the file types that are searched among the file sets. + * @param [in] fileSetNames Contains the file sets to search from. + * @param [in] fileTypes Contains the file types that are searched among the file sets. * - * @return QStringList containing the relative file paths to the files. + * @return QStringList containing the relative file paths to the files. */ QStringList getFilesFromFileSets(const QStringList& fileSetNames, const QStringList& fileTypes) const; @@ -734,125 +734,125 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Check if the component has the given file in it's file sets. * - * @param [in] fileName The name of the file to search. + * @param [in] fileName The name of the file to search. * - * @return True if file is found in one of the file sets. + * @return True if file is found in one of the file sets. */ bool hasFile(const QString& fileName) const; /*! * Get list of names of all the bus interfaces in this component. * - * @return QStringList containing the names of the bus interfaces. + * @return QStringList containing the names of the bus interfaces. */ QStringList getBusInterfaceNames() const; /*! * Get a A bus interface. * - * @param [in] name Contains the name of the wanted bus interface. + * @param [in] name Contains the name of the wanted bus interface. * - * @return A pointer to the busInterface instance or null pointer. + * @return A pointer to the busInterface instance or null pointer. */ QSharedPointer getBusInterface(const QString& name) const; /*! * Get list of the slave interfaces that refer to given memory map. * - * @param [in] memoryMap The name of the memory map to search for. + * @param [in] memoryMap The name of the memory map to search for. * - * @return QStringList containing names of the slave interfaces. + * @return QStringList containing names of the slave interfaces. */ QStringList getTargetInterfaces(const QString& memoryMap) const; /*! * Get list of the master and mirrored master interfaces that refer to given address space. * - * @param [in] addressSpace The name of the address space to search for. + * @param [in] addressSpace The name of the address space to search for. * - * @return QStringList containing names of the master and mirrored master interfaces. + * @return QStringList containing names of the master and mirrored master interfaces. */ QStringList getInitiatorInterfaces(const QString& addressSpace) const; /*! * Get list of the master and mirrored master interface names. * - * @return QStringList containing the interface names. + * @return QStringList containing the interface names. */ QStringList getInitiatorInterfaces() const; /*! * Checks if the component contains bus interfaces. * - * @return bool True if bus interfaces exist. + * @return bool True if bus interfaces exist. */ bool hasInterfaces() const; /*! * Check if the component contains the named interface. * - * @param [in] interfaceName The name of the interface to search for. + * @param [in] interfaceName The name of the interface to search for. * - * @return True if the interface was found. + * @return True if the interface was found. */ bool hasInterface(const QString& interfaceName) const; /*! * Finds the COM interface with the given name. * - * @param [in] name The name of the COM interface. + * @param [in] name The name of the COM interface. * - * @return The COM interface, or 0 if there is no COM interface with the given name. + * @return The COM interface, or 0 if there is no COM interface with the given name. */ QSharedPointer getComInterface(QString const& name); /*! * Finds the API interface with the given name. * - * @param [in] name The name of the API interface. + * @param [in] name The name of the API interface. * - * @return The API interface, or 0 if there is no API interface with the given name. + * @return The API interface, or 0 if there is no API interface with the given name. */ QSharedPointer getApiInterface(QString const& name); /*! * Get the named port of a component * - * @param [in] name QString containing the name of the port + * @param [in] name QString containing the name of the port * - * @return Pointer to the port instance + * @return Pointer to the port instance */ QSharedPointer getPort(const QString& name) const; /*! * Get the ports that are found in specified interface. * - * @param [in] interfaceName The name of interface that's ports are requested. + * @param [in] interfaceName The name of interface that's ports are requested. * - * @return List containing pointers to the ports. + * @return List containing pointers to the ports. */ QList > getPortsMappedInInterface(const QString& interfaceName) const; /*! * Check if the component has the specified port or not. * - * @param [in] name The name of the port to be searched + * @param [in] name The name of the port to be searched * - * @return True if the port is found + * @return True if the port is found */ bool hasPort(const QString& name) const; /*! * Get list of port names for this component. * - * @return QStringList containing the port names. + * @return QStringList containing the port names. */ QStringList getPortNames() const; /*! * Checks if the component contains ports. * - * @return bool True if ports exist. + * @return bool True if ports exist. */ bool hasPorts() const; @@ -873,21 +873,21 @@ class IPXACTMODELS_EXPORT Component: public Document /*! * Get the names of the address spaces stored in this component. * - * @return QStringList containing the names of the address spaces. + * @return QStringList containing the names of the address spaces. */ QStringList getAddressSpaceNames() const; /*! * Check if the component contains at least one local memory map. * - * @return True if at least one local memory map is found. + * @return True if at least one local memory map is found. */ bool hasLocalMemoryMaps() const; /*! * Get the directories which this component needs. * - * @return QStringList containing the relative directory paths. + * @return QStringList containing the relative directory paths. */ QStringList getDependentDirs() const final; diff --git a/IPXACTmodels/Component/ComponentGenerator.h b/IPXACTmodels/Component/ComponentGenerator.h index f66cd1816..f3b30fc93 100644 --- a/IPXACTmodels/Component/ComponentGenerator.h +++ b/IPXACTmodels/Component/ComponentGenerator.h @@ -66,91 +66,91 @@ class IPXACTMODELS_EXPORT ComponentGenerator : public NameGroup, public Extendab /*! Set the hidden setting for this component generator. * - * @param [in] hidden The hidden value to set. + * @param [in] hidden The hidden value to set. */ void setHidden(bool hidden); /*! Get the hidden setting of this component generator. * - * @return The hidden setting. + * @return The hidden setting. */ BooleanValue getHidden() const; /*! Set the scope of this component generator. * - * @param [in] scope The scope to be set. + * @param [in] scope The scope to be set. */ void setScope(Scope scope); /*! Get the scope of this component generator. * - * @return The scope of the generator. + * @return The scope of the generator. */ Scope getScope() const; /*! Set the phase for the component generator. * - * @param [in] phase The phase value to set. + * @param [in] phase The phase value to set. */ void setPhase(QString const& phaseExpression); /*! Get the phase of the component generator. * - * @return The generator phase. + * @return The generator phase. */ QString getPhase() const; /*! Get the parameters for this component generator. * - * @return QList containing pointers to the parameters. + * @return QList containing pointers to the parameters. */ QSharedPointer > > getParameters(); /*! Set the ApiType for this Component Generator * - * @param [in] apiType enum ApiType containing the API type. + * @param [in] apiType enum ApiType containing the API type. */ void setApiType(ApiType apiType); /*! Get the API type of the generator. * - * @return The generator API type. + * @return The generator API type. */ ApiType getApiType() const; /*! Set the supported transport methods. * - * @param [in] transportMethods The transport methods to set. + * @param [in] transportMethods The transport methods to set. */ void setTransportMethods(QStringList const& transportMethods); /*! Get the supported transport methods. * - * @return The supported transport methods. + * @return The supported transport methods. */ QStringList getTransportMethods() const; /*! Set the path to the generator executable for this generator. * - * @param [in] generatorExe The path to the generator executable. + * @param [in] generatorExe The path to the generator executable. */ void setGeneratorExe(QString const& generatorExe); /*! Get the path of the generator executable. * - * @return The generator executable path. + * @return The generator executable path. */ QString getGeneratorExe() const; /*! Set the groups for this component generator. * - * @param [in] groups The names of the groups for this generator. + * @param [in] groups The names of the groups for this generator. */ void setGroups(QStringList const& groups); /*! Get list of the groups for this Component Generator * - * @return The names of the groups this generator belongs to. + * @return The names of the groups this generator belongs to. */ QStringList getGroups() const; diff --git a/IPXACTmodels/Component/ComponentGeneratorReader.h b/IPXACTmodels/Component/ComponentGeneratorReader.h index 0bd527675..fbd73e4e6 100644 --- a/IPXACTmodels/Component/ComponentGeneratorReader.h +++ b/IPXACTmodels/Component/ComponentGeneratorReader.h @@ -29,10 +29,10 @@ namespace ComponentGeneratorReader /*! * Creates a new ComponentGenerator from a given ComponentGenerator node. * - * @param [in] ComponentGeneratorNode XML description of the ComponentGenerator. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] ComponentGeneratorNode XML description of the ComponentGenerator. + * @param [in] docRevision The IP-XACT standard revision in use. - * @return The component generator described in the XML. + * @return The component generator described in the XML. */ IPXACTMODELS_EXPORT QSharedPointer createComponentGeneratorFrom( QDomNode const& componentGeneratorNode, Document::Revision docRevision); @@ -43,8 +43,8 @@ namespace ComponentGeneratorReader /*! * Extracts attributes from componentGeneratorNode. * - * @param [in] componentGeneratorNode The XML description of the component generator. - * @param [in/out] newComponentGenerator The created component generator. + * @param [in] componentGeneratorNode The XML description of the component generator. + * @param [in/out] newComponentGenerator The created component generator. */ void readAttributes(QDomNode const& componentGeneratorNode, QSharedPointer newComponentGenerator); @@ -52,9 +52,9 @@ namespace ComponentGeneratorReader /*! * Extracts parameters from parameters XML description. * - * @param [in] parametersNode The XML description of the parameters. - * @param [in/out] componentGenerator The created component generator. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parametersNode The XML description of the parameters. + * @param [in/out] componentGenerator The created component generator. + * @param [in] docRevision The IP-XACT standard revision in use. */ void readParameters(QDomNode const& parametersNode, QSharedPointer componentGenerator, @@ -63,24 +63,24 @@ namespace ComponentGeneratorReader /*! * Extracts API type from XML description. * - * @param [in] apiTypeNode The XML description of the API type. - * @param [in/out] newComponentGenerator The created component generator. + * @param [in] apiTypeNode The XML description of the API type. + * @param [in/out] newComponentGenerator The created component generator. */ void readApiType(QDomNode const& apiTypeNode, QSharedPointer newComponentGenerator); /*! * Extracts API service from XML description. * - * @param [in] apiServiceNode The XML description of the API service. - * @param [in/out] newComponentGenerator The created component generator. + * @param [in] apiServiceNode The XML description of the API service. + * @param [in/out] newComponentGenerator The created component generator. */ void readApiService(QDomNode const& apiServiceNode, QSharedPointer newComponentGenerator); /*! * Extracts the transport type methods from XML description. * - * @param [in] tempNode The XML description of transport methods. - * @param [in/out] newComponentGenerator The created component generator. + * @param [in] tempNode The XML description of transport methods. + * @param [in/out] newComponentGenerator The created component generator. */ void readTransportMethods(QDomElement const& methodsNode, QSharedPointer newComponentGenerator); @@ -88,8 +88,8 @@ namespace ComponentGeneratorReader /*! * Extracts the generator group names from XML description. * - * @param [in] componentGeneratorNode The XML description of component generator. - * @param [in/out] newComponentGenerator The created component generator. + * @param [in] componentGeneratorNode The XML description of component generator. + * @param [in/out] newComponentGenerator The created component generator. */ void parseGroups(QDomNode const& componentGeneratorNode, QSharedPointer newComponentGenerator); diff --git a/IPXACTmodels/Component/ComponentGeneratorWriter.h b/IPXACTmodels/Component/ComponentGeneratorWriter.h index 51f1e0861..b91506baa 100644 --- a/IPXACTmodels/Component/ComponentGeneratorWriter.h +++ b/IPXACTmodels/Component/ComponentGeneratorWriter.h @@ -30,9 +30,9 @@ namespace ComponentGeneratorWriter /*! * Write a ComponentGenerator to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] ComponentGenerator The ComponentGenerator to be written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used xml writer. + * @param [in] ComponentGenerator The ComponentGenerator to be written. + * @param [in] docRevision The IP-XACT standard revision in use. */ IPXACTMODELS_EXPORT void writeComponentGenerator(QXmlStreamWriter& writer, QSharedPointer componentGenerator, Document::Revision docRevision); @@ -43,33 +43,33 @@ namespace ComponentGeneratorWriter /*! * Writes the component generator attributes to XML. * - * @param [in] writer The used xml writer. - * @param [in] componentGenerator The component generator whose attributes to write. + * @param [in] writer The used xml writer. + * @param [in] componentGenerator The component generator whose attributes to write. */ void writeAttributes(QXmlStreamWriter& writer, QSharedPointer componentGenerator); /*! * Writes the component generator API type to XML. * - * @param [in] writer The used xml writer. - * @param [in] componentGenerator The component generator whose API type to write. + * @param [in] writer The used xml writer. + * @param [in] componentGenerator The component generator whose API type to write. */ void writeApiType(QXmlStreamWriter& writer, QSharedPointer componentGenerator, Document::Revision docRevision); /*! * Writes the component generator API service to XML. * - * @param [in] writer The used xml writer. - * @param [in] componentGenerator The component generator whose attributes to write. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used xml writer. + * @param [in] componentGenerator The component generator whose attributes to write. + * @param [in] docRevision The IP-XACT standard revision in use. */ void writeApiService(QXmlStreamWriter& writer, QSharedPointer componentGenerator, Document::Revision docRevision); /*! * Writes the component generator transport methods to XML. * - * @param [in] writer The used xml writer. - * @param [in] componentGenerator The component generator whose transport mehtods to write. + * @param [in] writer The used xml writer. + * @param [in] componentGenerator The component generator whose transport mehtods to write. */ void writeTransportMethods(QXmlStreamWriter& writer, QSharedPointer componentGenerator); diff --git a/IPXACTmodels/Component/ComponentInstantiation.h b/IPXACTmodels/Component/ComponentInstantiation.h index 136cbc1f9..69ff82fd0 100644 --- a/IPXACTmodels/Component/ComponentInstantiation.h +++ b/IPXACTmodels/Component/ComponentInstantiation.h @@ -37,9 +37,9 @@ class IPXACTMODELS_EXPORT ComponentInstantiation : public NameGroup, public Exte /*! * The constructor. * - * @param [in] name Name of the instantiation. - * @param [in] displayName Display name of the instantiation. - * @param [in] description Description of the instantiation. + * @param [in] name Name of the instantiation. + * @param [in] displayName Display name of the instantiation. + * @param [in] description Description of the instantiation. */ ComponentInstantiation(QString const& name = QString(), QString const& displayName = QString(), QString const& description = QString()); @@ -62,147 +62,147 @@ class IPXACTMODELS_EXPORT ComponentInstantiation : public NameGroup, public Exte /*! * Check if the instantiation is virtual. * - * @return True, if the instantiation is virtual, false otherwise. + * @return True, if the instantiation is virtual, false otherwise. */ bool isVirtual() const; /*! * Set the virtuality status of the instantiation. * - * @param [in] virtualStatus The virtuality status of the instantiation. + * @param [in] virtualStatus The virtuality status of the instantiation. */ void setVirtual(bool virtualStatus); /*! * Get the used HDL. * - * @return The used HDL. + * @return The used HDL. */ QString getLanguage() const; /*! * Set the used HDL. * - * @param [in] newLanguage The used HDL. + * @param [in] newLanguage The used HDL. */ void setLanguage(QString const& newLanguage); /*! * Check if the language is strict. * - * @return True, if the language is strict, false otherwise. + * @return True, if the language is strict, false otherwise. */ bool isLanguageStrict() const; /*! * Set the language strictness. * - * @param [in] virtualStatus The language strictness. + * @param [in] virtualStatus The language strictness. */ void setLanguageStrictness(bool strictness); /*! * Get the name of the library in which the model should be compiled. * - * @return The name of the library. + * @return The name of the library. */ QString getLibraryName() const; /*! * Set the name of the library in which the model should be compiled. * - * @param [in] newLanguage The new name of the library. + * @param [in] newLanguage The new name of the library. */ void setLibraryName(QString const& newLibraryName); /*! * Get the name of the VHDL package containing the interface of the model. * - * @return The name of the VHDL package. + * @return The name of the VHDL package. */ QString getPackageName() const; /*! * Set the name of the VHDL package containing the interface of the model. * - * @param [in] newPackageName The name of the VHDL package. + * @param [in] newPackageName The name of the VHDL package. */ void setPackageName(QString const& newPackageName); /*! * Get the module name or the VHDL entity name. * - * @return The module or VHDL entity name. + * @return The module or VHDL entity name. */ QString getModuleName() const; /*! * Set the module name or the VHDL entity name. * - * @param [in] newModuleName The module or VHDL entity name. + * @param [in] newModuleName The module or VHDL entity name. */ void setModuleName(QString const& newModuleName); /*! * Get the name of the VHDL architecture. * - * @return The name of the VHDL architecture. + * @return The name of the VHDL architecture. */ QString getArchitectureName() const; /*! * Set the name of the VHDL architecture. * - * @param [in] newArchitectureName The name of the VHDL architecture. + * @param [in] newArchitectureName The name of the VHDL architecture. */ void setArchitectureName(QString const& newArchitectureName); /*! * Get the name of configuration. * - * @return The name of the configuration. + * @return The name of the configuration. */ QString getConfigurationName() const; /*! * Set the name of configuration. * - * @param [in] newConfigurationName The name of the configuration. + * @param [in] newConfigurationName The name of the configuration. */ void setConfigurationName(QString const& newConfigurationName); /*! * Get the module parameters. * - * @return Pointer to a list containing module parameters. + * @return Pointer to a list containing module parameters. */ QSharedPointer > > getModuleParameters() const; /*! * Set the module parameters. * - * @param [in] newModuleParameters The new module parameters. + * @param [in] newModuleParameters The new module parameters. */ void setModuleParameters(QSharedPointer > > newModuleParameters); /*! * Get the default file builders. * - * @return A pointer to a list containing the default file builders. + * @return A pointer to a list containing the default file builders. */ QSharedPointer > > getDefaultFileBuilders() const; /*! * Set the default file builders. * - * @param [in] newDefaultFileBuilders The new file builders. + * @param [in] newDefaultFileBuilders The new file builders. */ void setDefaultFileBuilders(QSharedPointer > > newDefaultFileBuilders); /*! * Get the file set references. * - * @return Pointer to a list containing referenced file sets. + * @return Pointer to a list containing referenced file sets. */ QSharedPointer > > getFileSetReferences() const; @@ -216,21 +216,21 @@ class IPXACTMODELS_EXPORT ComponentInstantiation : public NameGroup, public Exte /*! * Set the file set references. * - * @param [in] newFileSetReferences The new file set references. + * @param [in] newFileSetReferences The new file set references. */ void setFileSetReferences(QSharedPointer > > newFileSetReferences); /*! * Get the parameters. * - * @return A pointer to a list containing parameters. + * @return A pointer to a list containing parameters. */ QSharedPointer > > getParameters() const; /*! * Set the parameters. * - * @param [in] newParameters The new parameters. + * @param [in] newParameters The new parameters. */ void setParameters(QSharedPointer > > newParameters); diff --git a/IPXACTmodels/Component/ComponentReader.h b/IPXACTmodels/Component/ComponentReader.h index a4631d6ef..da2d21e7f 100644 --- a/IPXACTmodels/Component/ComponentReader.h +++ b/IPXACTmodels/Component/ComponentReader.h @@ -40,9 +40,9 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Creates a new component from a given component document. * - * @param [in] addressBlockNode XML description of the component. + * @param [in] addressBlockNode XML description of the component. * - * @return The created component. + * @return The created component. */ QSharedPointer createComponentFrom(QDomDocument const& componentDocument) const; @@ -57,32 +57,32 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the bus interfaces. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseBusInterfaces(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the indirect interfaces. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseIndirectInterfaces(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the channels. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseChannels(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the remap states. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseRemapStates(QDomNode const& componentNode, QSharedPointer newComponent) const; @@ -91,33 +91,33 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the address spaces. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseAddressSpaces(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the memory maps. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseMemoryMaps(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the model. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseModel(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the views. * - * @param [in] modelElement XML description of the model. - * @param [in] newModel The new model item. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] modelElement XML description of the model. + * @param [in] newModel The new model item. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseViews(QDomElement const& modelElement, QSharedPointer newModel, Document::Revision docRevision) const; @@ -125,8 +125,8 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the instantiations. * - * @param [in] modelElement XML description of the model. - * @param [in] newModel The new model item. + * @param [in] modelElement XML description of the model. + * @param [in] newModel The new model item. */ void parseInstantiations(QDomElement const& modelElement, QSharedPointer newModel, Document::Revision docRevision) const; @@ -134,9 +134,9 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the component instantiations. * - * @param [in] instantiationsElement XML description of the instantiations element. - * @param [in] newModel The new model item. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationsElement XML description of the instantiations element. + * @param [in] newModel The new model item. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseComponentInstantiations(QDomElement const& instantiationsElement, QSharedPointer newModel, Document::Revision docRevision) const; @@ -144,17 +144,17 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the design instantiations. * - * @param [in] instantiationsElement XML description of the instantiations element. - * @param [in] newModel The new model item. + * @param [in] instantiationsElement XML description of the instantiations element. + * @param [in] newModel The new model item. */ void parseDesignInstantiations(QDomElement const& instantiationsElement, QSharedPointer newModel) const; /*! * Reads the design configuration instantiations. * - * @param [in] instantiationsElement XML description of the instantiations element. - * @param [in] newModel The new model item. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationsElement XML description of the instantiations element. + * @param [in] newModel The new model item. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseDesignConfigurationInstantiations(QDomElement const& instantiationsElement, QSharedPointer newModel, Document::Revision docRevision) const; @@ -162,112 +162,112 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the ports. * - * @param [in] modelElement XML description of the model. - * @param [in] newModel The new model item. + * @param [in] modelElement XML description of the model. + * @param [in] newModel The new model item. */ void parsePorts(QDomElement const& modelElement, QSharedPointer newModel, Document::Revision docRevisio) const; /*! * Reads the component generators. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseComponentGenerators(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the choices. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseChoices(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the file sets. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseFileSets(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the cpus. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseCPUs(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the other clock drivers. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseOtherClockDrivers(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the reset types. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseResetTypes(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the component extensions. * - * @param [in] componentNode XML description of the component. - * @param [in] newComponent The new component. + * @param [in] componentNode XML description of the component. + * @param [in] newComponent The new component. */ void parseComponentExtensions(QDomNode const& componentNode, QSharedPointer newComponent) const; /*! * Reads the swView extensions. * - * @param [in] swViewsNode XML description of the sw views. - * @param [in] newComponent The new component. + * @param [in] swViewsNode XML description of the sw views. + * @param [in] newComponent The new component. */ void parseSwViews(QDomNode const& swViewsNode, QSharedPointer newComponent) const; /*! * Reads the sw property extensions. * - * @param [in] propertiesNode XML description of the sw properties. - * @param [in] newComponent The new component. + * @param [in] propertiesNode XML description of the sw properties. + * @param [in] newComponent The new component. */ void parseSwProperties(QDomNode const& propertiesNode, QSharedPointer newComponent) const; /*! * Reads the system view extensions. * - * @param [in] viewsNode XML description of the system views. - * @param [in] newComponent The new component. + * @param [in] viewsNode XML description of the system views. + * @param [in] newComponent The new component. */ void parseSystemViews(QDomNode const& viewsNode, QSharedPointer newComponent) const; /*! * Reads the com interface extensions. * - * @param [in] interfaceNode XML description of the com interfaces. - * @param [in] newComponent The new component. + * @param [in] interfaceNode XML description of the com interfaces. + * @param [in] newComponent The new component. */ void parseComInterfaces(QDomNode const& interfaceNode, QSharedPointer newComponent) const; /*! * Reads the api interface extensions. * - * @param [in] interfaceNode XML description of the api interfaces. - * @param [in] newComponent The new component. + * @param [in] interfaceNode XML description of the api interfaces. + * @param [in] newComponent The new component. */ void parseApiInterfaces(QDomNode const& interfaceNode, QSharedPointer newComponent) const; /*! * Reades the source directories for file sets. * - * @param [in] singleExtensionNode XML description of the file source directories. - * @param [in] newComponent The new component. + * @param [in] singleExtensionNode XML description of the file source directories. + * @param [in] newComponent The new component. */ void parseFilesetSourceDirectories(QDomNode const& singleExtensionNode, QSharedPointer newComponent) const; @@ -275,16 +275,16 @@ class IPXACTMODELS_EXPORT ComponentReader : public DocumentReader /*! * Reads the file dependency extensions. * - * @param [in] fileNode XML description of the file dependencies. - * @param [in] newComponent The new component. + * @param [in] fileNode XML description of the file dependencies. + * @param [in] newComponent The new component. */ void parseFileDependencies(QDomNode const& fileNode, QSharedPointer newComponent) const; /*! * Reads the author vendor extension. * - * @param [in] authorNode XML description of the author. - * @param [in] newComponent The new component. + * @param [in] authorNode XML description of the author. + * @param [in] newComponent The new component. */ void parseAuthor(QDomNode const& authorNode, QSharedPointer newComponent) const; }; diff --git a/IPXACTmodels/Component/ComponentWriter.h b/IPXACTmodels/Component/ComponentWriter.h index 125ef38c3..3a5671882 100644 --- a/IPXACTmodels/Component/ComponentWriter.h +++ b/IPXACTmodels/Component/ComponentWriter.h @@ -40,8 +40,8 @@ class IPXACTMODELS_EXPORT ComponentWriter : public DocumentWriter /*! * Write a component to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] component The component to be written. + * @param [in] writer The used XML writer. + * @param [in] component The component to be written. */ void writeComponent(QXmlStreamWriter& writer, QSharedPointer component) const; @@ -54,32 +54,32 @@ class IPXACTMODELS_EXPORT ComponentWriter : public DocumentWriter /*! * Write the bus interfaces. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeBusInterfaces(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the indirect interfaces. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeIndirectInterfaces(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the channels. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeChannels(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the remap states. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeRemapStates(QXmlStreamWriter& writer, QSharedPointer component) const; @@ -88,104 +88,104 @@ class IPXACTMODELS_EXPORT ComponentWriter : public DocumentWriter /*! * Write the address spaces. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeAddressSpaces(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the memory maps. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeMemoryMaps(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the model. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeModel(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the views. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeViews(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the instantiations. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeInstantiations(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the ports. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writePorts(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the component generators. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeComponentGenerators(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the choices. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeChoices(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the file sets. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeFileSets(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the cpus. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeCPUs(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the other clock drivers. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeOtherClockDrivers(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the reset types. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeResetTypes(QXmlStreamWriter& writer, QSharedPointer component) const; /*! * Write the other component extensions. * - * @param [in] writer The used XML writer. - * @param [in] component The component being written. + * @param [in] writer The used XML writer. + * @param [in] component The component being written. */ void writeComponentExtensions(QXmlStreamWriter& writer, QSharedPointer component) const; void writePowerDomains(QXmlStreamWriter& writer, QSharedPointer component) const; diff --git a/IPXACTmodels/Component/Cpu.h b/IPXACTmodels/Component/Cpu.h index 7571c831b..535e6d584 100644 --- a/IPXACTmodels/Component/Cpu.h +++ b/IPXACTmodels/Component/Cpu.h @@ -46,35 +46,35 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] addressSpaceReference The address space reference. + * @param [in] addressSpaceReference The address space reference. */ AddressSpaceRef(QString const& addressSpaceReference = QString()); /*! * Get the address space reference. * - * @return Address space reference. + * @return Address space reference. */ QString getAddressSpaceRef() const; /*! * Set the address space reference. * - * @param [in] newAddressSpaceRef The new address space reference. + * @param [in] newAddressSpaceRef The new address space reference. */ void setAddressSpaceRef(QString const& newAddressSpaceRef); /*! * Get the is present. * - * @return Is present value. + * @return Is present value. */ QString getIsPresent() const; /*! * Set the is present value. * - * @param [in] newIsPresent The new is present value. + * @param [in] newIsPresent The new is present value. */ void setIsPresent(QString const& newIsPresent); }; @@ -82,7 +82,7 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * Default constructor. * - * @param [in] name Name of the cpu. + * @param [in] name Name of the cpu. */ Cpu(QString const& name = QString()); @@ -98,42 +98,42 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! * Get list of the address space references for this cpu. * - * @return A list containing the addressSpaceRefs. + * @return A list containing the addressSpaceRefs. */ QStringList getAddressSpaceRefs() const; /*! * Get the address space references. * - * @return List of address space references. + * @return List of address space references. */ QSharedPointer > > getAddressSpaceReferences() const; /*! * Set the address space references. * - * @param [in] addrSpaceNames The address space references to set. + * @param [in] addrSpaceNames The address space references to set. */ void setAddressSpaceRefs(QStringList addrSpaceNames); /*! * Set the address space references. * - * @param [in] newAddressSpaceRefs List containing the new address space references. + * @param [in] newAddressSpaceRefs List containing the new address space references. */ void setAddressSpaceReferences(QSharedPointer > > newAddressSpaceRefs); @@ -154,7 +154,7 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * Get the address unit bits * - * @return The address unit bits. + * @return The address unit bits. */ QString getAddressUnitBits() const; @@ -166,7 +166,7 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * Get the parameters of the cpu. * - * @return List containing pointers to the parameters for the cpu. + * @return List containing pointers to the parameters for the cpu. */ QSharedPointer > > getParameters(); @@ -175,14 +175,14 @@ class IPXACTMODELS_EXPORT Cpu : public NameGroup, public Extendable /*! * Copy the parameters. * - * @param [in] other The cpu being copied. + * @param [in] other The cpu being copied. */ void copyParameters(const Cpu& other); /*! * Copy the address space references. * - * @param [in] other The cpu being copied. + * @param [in] other The cpu being copied. */ void copyAddressSpaceRefs(const Cpu& other); diff --git a/IPXACTmodels/Component/DesignConfigurationInstantiation.h b/IPXACTmodels/Component/DesignConfigurationInstantiation.h index a7a5f8a47..6c36ddcf2 100644 --- a/IPXACTmodels/Component/DesignConfigurationInstantiation.h +++ b/IPXACTmodels/Component/DesignConfigurationInstantiation.h @@ -34,9 +34,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationInstantiation : public NameGroup, p /*! * The constructor. * - * @param [in] name Name of the instantiation. - * @param [in] displayName Display name of the instantiation. - * @param [in] description Description of the instantiation. + * @param [in] name Name of the instantiation. + * @param [in] displayName Display name of the instantiation. + * @param [in] description Description of the instantiation. */ DesignConfigurationInstantiation(QString const& name = QString(), QString const& displayName = QString(), QString const& description = QString()); @@ -59,56 +59,56 @@ class IPXACTMODELS_EXPORT DesignConfigurationInstantiation : public NameGroup, p /*! * Get the HDL used for instantiation. * - * @return The used HDL. + * @return The used HDL. */ QString getLanguage() const; /*! * Set the HDL for this instantiation. * - * @param [in] newLanguage The new HDL. + * @param [in] newLanguage The new HDL. */ void setLanguage(QString const& newLanguage); /*! * Check if the used language shall be strictly enforced. * - * @return True, if the language shall be strictly enforced, false otherwise. + * @return True, if the language shall be strictly enforced, false otherwise. */ bool isLangugageStrict() const; /*! * Set the strictness of the language. * - * @param [in] strictness If true, the language shall be strictly enforced. + * @param [in] strictness If true, the language shall be strictly enforced. */ void setLanguageStrict(bool strictness); /*! * Get the design configuration reference. * - * @return Pointer to the design configuration referenced by the instantiation. + * @return Pointer to the design configuration referenced by the instantiation. */ QSharedPointer getDesignConfigurationReference() const; /*! * Set the design configuration reference. * - * @param [in] newDesignReference The referenced design configuration. + * @param [in] newDesignReference The referenced design configuration. */ void setDesignConfigurationReference(QSharedPointer newDesignConfigurationReference); /*! * Get a list of parameters used in this instantiation. * - * @return A list of parameters. + * @return A list of parameters. */ QSharedPointer > > getParameters() const; /*! * Set a list of parameters. * - * @param [in] newParameters The new list of parameters. + * @param [in] newParameters The new list of parameters. */ void setParameters(QSharedPointer > > newParameters); @@ -117,7 +117,7 @@ class IPXACTMODELS_EXPORT DesignConfigurationInstantiation : public NameGroup, p /*! * Copy parameters from another design configuration instantiation. * - * @param [in] other The location of the copied parameters. + * @param [in] other The location of the copied parameters. */ void copyParameters(DesignConfigurationInstantiation const& other) const; diff --git a/IPXACTmodels/Component/DesignInstantiation.h b/IPXACTmodels/Component/DesignInstantiation.h index 100c59e74..e2b6c5648 100644 --- a/IPXACTmodels/Component/DesignInstantiation.h +++ b/IPXACTmodels/Component/DesignInstantiation.h @@ -33,9 +33,9 @@ class IPXACTMODELS_EXPORT DesignInstantiation : public NameGroup, public Extenda /*! * The constructor. * - * @param [in] name Name of the instantiation. - * @param [in] displayName Display name of the instantiation. - * @param [in] description Description of the instantiation. + * @param [in] name Name of the instantiation. + * @param [in] displayName Display name of the instantiation. + * @param [in] description Description of the instantiation. */ DesignInstantiation(QString const& name = QString(), QString const& displayName = QString(), QString const& description = QString()); @@ -58,14 +58,14 @@ class IPXACTMODELS_EXPORT DesignInstantiation : public NameGroup, public Extenda /*! * Get the design reference. * - * @return Pointer to the design referenced by the instantiation. + * @return Pointer to the design referenced by the instantiation. */ QSharedPointer getDesignReference() const; /*! * Set the design reference. * - * @param [in] newDesignReference The referenced design. + * @param [in] newDesignReference The referenced design. */ void setDesignReference(QSharedPointer newDesignReference); diff --git a/IPXACTmodels/Component/Driver.h b/IPXACTmodels/Component/Driver.h index b826e4a21..a11e14df4 100644 --- a/IPXACTmodels/Component/Driver.h +++ b/IPXACTmodels/Component/Driver.h @@ -27,35 +27,35 @@ class IPXACTMODELS_EXPORT Driver /*! * Create a copy of the Driver. * - * @return A Driver identical to this. + * @return A Driver identical to this. */ Driver* clone() const; /*! * Get the applied range for the driver. * - * @return The range the driver applies to. + * @return The range the driver applies to. */ Range getRange() const; /*! * Set the range the driver applies to * - * @param [in] range The range to set. + * @param [in] range The range to set. */ void setRange(Range const& range); /*! * Get the default value of the driver. * - * @return The default value. + * @return The default value. */ QString getDefaultValue() const; /*! * Set the default value in the driver. * - * @param [in] value The default value to set. + * @param [in] value The default value to set. */ void setDefaultValue(QString const& value); diff --git a/IPXACTmodels/Component/EnumeratedValue.h b/IPXACTmodels/Component/EnumeratedValue.h index a412e7001..cc5d33796 100644 --- a/IPXACTmodels/Component/EnumeratedValue.h +++ b/IPXACTmodels/Component/EnumeratedValue.h @@ -41,8 +41,8 @@ class IPXACTMODELS_EXPORT EnumeratedValue : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] enumerationName Name of the enumerated value. - * @param [in] value The enumerated value. + * @param [in] enumerationName Name of the enumerated value. + * @param [in] value The enumerated value. */ EnumeratedValue(QString const& enumerationName = QString(), QString const& value = QString()); @@ -58,47 +58,47 @@ class IPXACTMODELS_EXPORT EnumeratedValue : public NameGroup, public Extendable /*! * Get the usage. * - * @return The usage. + * @return The usage. */ EnumeratedUsage getUsage() const; /*! * Set the usage. * - * @param [in] usage The new usage value. + * @param [in] usage The new usage value. */ void setUsage(EnumeratedUsage usage); /*! * Get the value of the enumeratedValue. * - * @return The value. + * @return The value. */ QString getValue() const; /*! * Set the value of the enumeratedValue. * - * @param [in] value The new value. + * @param [in] value The new value. */ void setValue(QString const& value); /*! * Static function that translates enumeratedUsage to QString. * - * @param [in] usage The usage to be translated to QString + * @param [in] usage The usage to be translated to QString * - * @return String form of the usage. + * @return String form of the usage. */ static QString usage2Str(EnumeratedValue::EnumeratedUsage usage); /*! * Static function that translates QString to enumeratedUsage. * - * @param [in] usage QString that is translated into enumeratedUsage. - * @param [in] defaultValue The value that is returned if the string doesn't match any usage. + * @param [in] usage QString that is translated into enumeratedUsage. + * @param [in] defaultValue The value that is returned if the string doesn't match any usage. * - * @return EnumeratedValue that matches the string of defaultValue. + * @return EnumeratedValue that matches the string of defaultValue. */ static EnumeratedValue::EnumeratedUsage str2Usage(const QString& usage, EnumeratedUsage defaultValue); diff --git a/IPXACTmodels/Component/EnumeratedValueReader.h b/IPXACTmodels/Component/EnumeratedValueReader.h index bef815e38..72847a793 100644 --- a/IPXACTmodels/Component/EnumeratedValueReader.h +++ b/IPXACTmodels/Component/EnumeratedValueReader.h @@ -39,9 +39,9 @@ class IPXACTMODELS_EXPORT EnumeratedValueReader : public CommonItemsReader /*! * Creates a new enumerated value from a given enumerated value node. * - * @param [in] enumeratedValueNode XML description of the enumerated value. + * @param [in] enumeratedValueNode XML description of the enumerated value. * - * @return The created enumerated value. + * @return The created enumerated value. */ QSharedPointer createEnumeratedValueFrom(QDomNode const& enumeratedValueNode) const; @@ -54,24 +54,24 @@ class IPXACTMODELS_EXPORT EnumeratedValueReader : public CommonItemsReader /*! * Reads the usage. * - * @param [in] enumerationNode XML description of the enumerated value. - * @param [in] newEnumeration The new enumerated item. + * @param [in] enumerationNode XML description of the enumerated value. + * @param [in] newEnumeration The new enumerated item. */ void parseUsage(QDomNode const& enumerationNode, QSharedPointer newEnumeration) const; /*! * Reads the name group. * - * @param [in] enumerationNode XML description of the enumerated value. - * @param [in] newEnumeration The new enumerated item. + * @param [in] enumerationNode XML description of the enumerated value. + * @param [in] newEnumeration The new enumerated item. */ void parseNameGroup(QDomNode const& enumerationNode, QSharedPointer newEnumeration) const; /*! * Reads the value. * - * @param [in] enumerationNode XML description of the enumerated value. - * @param [in] newEnumeration The new enumerated item. + * @param [in] enumerationNode XML description of the enumerated value. + * @param [in] newEnumeration The new enumerated item. */ void parseValue(QDomNode const& enumerationNode, QSharedPointer newEnumeration) const; }; diff --git a/IPXACTmodels/Component/EnumeratedValueWriter.h b/IPXACTmodels/Component/EnumeratedValueWriter.h index 87a81bff1..6c1f7cf26 100644 --- a/IPXACTmodels/Component/EnumeratedValueWriter.h +++ b/IPXACTmodels/Component/EnumeratedValueWriter.h @@ -40,8 +40,8 @@ class IPXACTMODELS_EXPORT EnumeratedValueWriter : public CommonItemsWriter /*! * Write an enumerated value to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] enumeratedValue The enumerated value to be written. + * @param [in] writer The used xml writer. + * @param [in] enumeratedValue The enumerated value to be written. */ void writeEnumeratedValue(QXmlStreamWriter& writer, QSharedPointer enumeratedValue) const; @@ -54,24 +54,24 @@ class IPXACTMODELS_EXPORT EnumeratedValueWriter : public CommonItemsWriter /*! * Write the enumeration usage. * - * @param [in] writer Used XML writer. - * @param [in] enumeratedValue The selected enumerated value item. + * @param [in] writer Used XML writer. + * @param [in] enumeratedValue The selected enumerated value item. */ void writeUsage(QXmlStreamWriter& writer, QSharedPointer enumeratedValue) const; /*! * Write the name group. * - * @param [in] writer Used XML writer. - * @param [in] enumeratedValue The selected enumerated value item. + * @param [in] writer Used XML writer. + * @param [in] enumeratedValue The selected enumerated value item. */ void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer enumeratedValue) const; /*! * Write the value. * - * @param [in] writer Used XML writer. - * @param [in] enumeratedValue The selected enumerated value item. + * @param [in] writer Used XML writer. + * @param [in] enumeratedValue The selected enumerated value item. */ void writeValue(QXmlStreamWriter& writer, QSharedPointer enumeratedValue) const; }; diff --git a/IPXACTmodels/Component/ExecutableImage.h b/IPXACTmodels/Component/ExecutableImage.h index e6b5c24d8..b5ab7486b 100644 --- a/IPXACTmodels/Component/ExecutableImage.h +++ b/IPXACTmodels/Component/ExecutableImage.h @@ -34,7 +34,7 @@ class IPXACTMODELS_EXPORT ExecutableImage : public NameGroup, public Extendable /*! * The default constructor. * - * @param [in] name Name of the executable image. + * @param [in] name Name of the executable image. */ ExecutableImage(QString const& name = QString()); @@ -50,56 +50,56 @@ class IPXACTMODELS_EXPORT ExecutableImage : public NameGroup, public Extendable /*! * Get the imageId attribute. * - * @return The imageId attribute. + * @return The imageId attribute. */ QString getImageId() const; /*! * Set the imageId attribute. * - * @param [in] id The id to set. + * @param [in] id The id to set. */ void setImageId(QString const& id); /*! * Get the imageType attribute. * - * @return The imageType attribute. + * @return The imageType attribute. */ QString getImageType() const; /*! * Set the imageType attribute. * - * @param [in] type The imageType to set. + * @param [in] type The imageType to set. */ void setImageType(QString const& type); /*! * Get the parameters of the executable image. * - * @return Pointer to a list holding the parameters for this executable image. + * @return Pointer to a list holding the parameters for this executable image. */ QSharedPointer > > getParameters() const; /*! * Set the parameter for the executable image. * - * @param [in] parameters The parameters to set. + * @param [in] parameters The parameters to set. */ void setParameters(QSharedPointer > > parameters); /*! * Get the language tools defined for the executable image. * - * @return The language tools of the executable image. + * @return The language tools of the executable image. */ QSharedPointer getLanguageTools() const; /*! * Set the language tools for the executable image. * - * @param [in] languageTools The language tools to set. + * @param [in] languageTools The language tools to set. */ void setLanguageTools(QSharedPointer languageTools); diff --git a/IPXACTmodels/Component/Field.h b/IPXACTmodels/Component/Field.h index 2cc7fbb46..fca853e6b 100644 --- a/IPXACTmodels/Component/Field.h +++ b/IPXACTmodels/Component/Field.h @@ -46,7 +46,7 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the bit field. + * @param [in] name Name of the bit field. */ Field(QString const& name = QString()); @@ -68,14 +68,14 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Get the id of the field. * - * @return The field's id. + * @return The field's id. */ QString getId() const; /*! * Set the id for the field. * - * @param [in] newId The id to set for the field. + * @param [in] newId The id to set for the field. * */ void setId(QString const& newId); @@ -83,14 +83,14 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Get the isPresent value of the field. * - * @return The is present value. + * @return The is present value. */ QString getIsPresent() const; /*! * Set the is present value for the field. * - * @param [in] newIsPresent The new is present value. + * @param [in] newIsPresent The new is present value. */ void setIsPresent(QString const& newIsPresent); @@ -104,98 +104,98 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Set the field's memory array. * - * @param [in] memArray Description + * @param [in] memArray Description */ void setMemoryArray(QSharedPointer memArray); /*! * Get the bit offset. * - * @return Bit offset. + * @return Bit offset. */ QString getBitOffset() const; /*! * Set the bit offset. * - * @param [in] newBitOffset The new bit offset. + * @param [in] newBitOffset The new bit offset. */ void setBitOffset(QString const& newBitOffset); /*! * Get the field definition reference. * - * @return The field definition reference. + * @return The field definition reference. */ QString getFieldDefinitionRef() const; /*! * Set the field definition reference. * - * @param [in] newFieldDefRef Description + * @param [in] newFieldDefRef Description */ void setFieldDefinitionRef(QString const& newFieldDefRef); /*! * Get the type definitions reference. * - * @return The type definitions reference. + * @return The type definitions reference. */ QString getTypeDefinitionsRef() const; /*! * Set the type definitions reference. * - * @param [in] newTypeDefRef Description + * @param [in] newTypeDefRef Description */ void setTypeDefinitionsRef(QString const& newTypeDefRef); /*! * Get a list of the reset for the field. * - * @return Pointer to a list containing the resets. + * @return Pointer to a list containing the resets. */ QSharedPointer > > getResets() const; /*! * Set the reset for the field. * - * @param [in] newResets Pointer to a list containing the new resets. + * @param [in] newResets Pointer to a list containing the new resets. */ void setResets(QSharedPointer > > newResets); /*! * Get the typeIdentifier. * - * @return The typeIdentifier. + * @return The typeIdentifier. */ QString getTypeIdentifier() const; /*! * Set the typeIdentifier for the field. * - * @param [in] newTypeIdentifier The new typeIdentifier. + * @param [in] newTypeIdentifier The new typeIdentifier. */ void setTypeIdentifier(QString const& newTypeIdentifier); /*! * Get the bit width. * - * @return Bit width. + * @return Bit width. */ QString getBitWidth() const; /*! * Set the bit width for the field. * - * @param [in] newBitwidth The new bit width. + * @param [in] newBitwidth The new bit width. */ void setBitWidth(QString const& newBitWidth); /*! * Get the volatile state of the field. * - * @return The volatile state. + * @return The volatile state. */ BooleanValue getVolatile() const; @@ -207,7 +207,7 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Set the volatile state for the field. * - * @param [in] volatileValue The new volatile state to set. + * @param [in] volatileValue The new volatile state to set. */ void setVolatile(bool volatileValue); @@ -221,49 +221,49 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Set the field reference. * - * @param [in] fieldRef The new field reference. + * @param [in] fieldRef The new field reference. */ void setFieldReference(QSharedPointer fieldRef); /*! * Get the access type of the field. * - * @return The access type of the field. + * @return The access type of the field. */ AccessTypes::Access getAccess() const; /*! * Set the access type for the field. * - * @param [in] access The access type to set. + * @param [in] access The access type to set. */ void setAccess(AccessTypes::Access access); /*! * Get the list of the enumeratedValues. * - * @return Pointer to a list containing the enumerated values. + * @return Pointer to a list containing the enumerated values. */ QSharedPointer > > getEnumeratedValues() const; /*! * Set the enumerated values for the field. * - * @param [in] newEnumeratedValues Pointer to a list containing the enumerated values. + * @param [in] newEnumeratedValues Pointer to a list containing the enumerated values. */ void setEnumeratedValues(QSharedPointer > > newEnumeratedValues); /*! * Get the modified write value setting of the field. * - * @return The modified write value setting. + * @return The modified write value setting. */ General::ModifiedWrite getModifiedWrite() const; /*! * Set the modified write value setting for the field. * - * @param [in] newModWriteValue The value to set. + * @param [in] newModWriteValue The value to set. * */ void setModifiedWrite(General::ModifiedWrite const& newModifiedWriteValue); @@ -271,70 +271,70 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Get the modify attribute of the modified write value. * - * @return The modify attribute of the modified write value. + * @return The modify attribute of the modified write value. */ QString getModifiedWriteModify() const; /*! * Set the modify attribute of the modified write value. * - * @param [in] newModify The new modified attribute. + * @param [in] newModify The new modified attribute. */ void setModifiedWriteModify(QString const& newModify); /*! * Get the write constraint of the field. * - * @return Pointer to the write constraint. + * @return Pointer to the write constraint. */ QSharedPointer getWriteConstraint() const; /*! * Set the write value constraint. * - * @param [in] newWriteValueConstraint Pointer to the new write value constraint. + * @param [in] newWriteValueConstraint Pointer to the new write value constraint. */ void setWriteConstraint(QSharedPointer newWriteValueConstraint); /*! * Get the read action setting of the field. * - * @return The read action setting. + * @return The read action setting. */ General::ReadAction getReadAction() const; /*! * Set the read action setting for the field. * - * @param [in] readAction The new read action -value. + * @param [in] readAction The new read action -value. */ void setReadAction(General::ReadAction const& readAction); /*! * Get the read action modify attribute. * - * @return The read action modify attribute. + * @return The read action modify attribute. */ QString getReadActionModify() const; /*! * Set the read action modify attribute. * - * @param [in] newModify The new modify attribute. + * @param [in] newModify The new modify attribute. */ void setReadActionModify(QString const& newModify); /*! * Get the testable setting of the field. * - * @return The testable setting. + * @return The testable setting. */ BooleanValue getTestable() const; /*! * Set the testable setting for the field. * - * @param [in] newTestable The new testable value. + * @param [in] newTestable The new testable value. */ void setTestable(bool newTestable); @@ -346,42 +346,42 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Get the test constraint setting of the field. * - * @return The test constraint of the field. + * @return The test constraint of the field. */ General::TestConstraint getTestConstraint() const; /*! * Set the test constraint for the field. * - * @param [in] testContraint The new test constraint. + * @param [in] testContraint The new test constraint. */ void setTestConstraint(General::TestConstraint const& newTestContraint); /*! * Get the reserved value. * - * @return The reserved value. + * @return The reserved value. */ QString getReserved() const; /*! * Set the reserved value. * - * @param [in] newReserved The new reserved value. + * @param [in] newReserved The new reserved value. */ void setReserved(QString const& newReserved); /*! * Get a list of the parameters for the field. * - * @return Pointer to a list containing the parameters. + * @return Pointer to a list containing the parameters. */ QSharedPointer > > getParameters() const; /*! * Set the parameters for the field. * - * @param [in] newParameters Pointer to a list containing the new parameters. + * @param [in] newParameters Pointer to a list containing the new parameters. */ void setParameters(QSharedPointer > > newParameters); @@ -395,7 +395,7 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Set the field access policies for the field. * - * @param [in] newFieldAccessPolicies The new field access policies. + * @param [in] newFieldAccessPolicies The new field access policies. */ void setFieldAccessPolicies(QSharedPointer > > newFieldAccessPolicies); @@ -404,7 +404,7 @@ class IPXACTMODELS_EXPORT Field : public NameGroup, public Extendable /*! * Copy the write value constraint. * - * @param [in] other The copied field. + * @param [in] other The copied field. */ void copyWriteValueConstraint(const Field& other); diff --git a/IPXACTmodels/Component/FieldAccessPolicy.h b/IPXACTmodels/Component/FieldAccessPolicy.h index 314c2e1a9..f557d9cce 100644 --- a/IPXACTmodels/Component/FieldAccessPolicy.h +++ b/IPXACTmodels/Component/FieldAccessPolicy.h @@ -56,14 +56,14 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Get the modified write value setting of the field. * - * @return The modified write value setting. + * @return The modified write value setting. */ General::ModifiedWrite getModifiedWrite() const; /*! * Set the modified write value setting for the field. * - * @param [in] modifiedWrite The value to set. + * @param [in] modifiedWrite The value to set. * */ void setModifiedWrite(General::ModifiedWrite modifiedWrite); @@ -71,70 +71,70 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Get the modify attribute of the modified write value. * - * @return The modify attribute of the modified write value. + * @return The modify attribute of the modified write value. */ QString getModifiedWriteModify() const; /*! * Set the modify attribute of the modified write value. * - * @param [in] modify The new modified attribute. + * @param [in] modify The new modified attribute. */ void setModifiedWriteModify(QString const& modify); /*! * Get the write constraint of the field. * - * @return Pointer to the write constraint. + * @return Pointer to the write constraint. */ QSharedPointer getWriteValueConstraint() const; /*! * Set the write value constraint. * - * @param [in] constraint Pointer to the new write value constraint. + * @param [in] constraint Pointer to the new write value constraint. */ void setWriteValueConstraint(QSharedPointer constraint); /*! * Get the read action setting of the field. * - * @return The read action setting. + * @return The read action setting. */ General::ReadAction getReadAction() const; /*! * Set the read action setting for the field. * - * @param [in] readAction The new read action -value. + * @param [in] readAction The new read action -value. */ void setReadAction(General::ReadAction readAction); /*! * Get the read action modify attribute. * - * @return The read action modify attribute. + * @return The read action modify attribute. */ QString getReadActionModify() const; /*! * Set the read action modify attribute. * - * @param [in] readActionModify The new modify attribute. + * @param [in] readActionModify The new modify attribute. */ void setReadActionModify(QString const& readActionModify); /*! * Get the testable setting of the field. * - * @return The testable setting. + * @return The testable setting. */ BooleanValue getTestable() const; /*! * Set the testable setting for the field. * - * @param [in] newTestable The new testable value. + * @param [in] newTestable The new testable value. */ void setTestable(bool newTestable); @@ -153,7 +153,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Set the read response of the field. * - * @param [in] response Description + * @param [in] response Description */ void setReadResponse(QString const& response); @@ -167,35 +167,35 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Set the broadcasts of the field. * - * @param [in] broadcasts Description + * @param [in] broadcasts Description */ void setBroadcasts(QSharedPointer > > broadcasts); /*! * Get the test constraint setting of the field. * - * @return The test constraint of the field. + * @return The test constraint of the field. */ General::TestConstraint getTestConstraint() const; /*! * Set the test constraint for the field. * - * @param [in] testContraint The new test constraint. + * @param [in] testContraint The new test constraint. */ void setTestConstraint(General::TestConstraint constraint); /*! * Get the reserved value. * - * @return The reserved value. + * @return The reserved value. */ QString getReserved() const; /*! * Set the reserved value. * - * @param [in] newReserved The new reserved value. + * @param [in] newReserved The new reserved value. */ void setReserved(QString const& reserved); @@ -209,7 +209,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Set the field access policy definition reference. * - * @param [in] definitionRef The definition reference to set. + * @param [in] definitionRef The definition reference to set. */ void setFieldAccessPolicyDefinitionRef(QString const& definitionRef); @@ -223,7 +223,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Set the field access policy type definitions reference. * - * @param [in] typeDefRef The type definitions reference to set. + * @param [in] typeDefRef The type definitions reference to set. */ void setFieldAccessPolicyTypeDefinitionRef(QString const& typeDefRef); @@ -237,7 +237,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicy : public AccessPolicy /*! * Set the access restrictions of the field access policy. * - * @param [in] newAccessRestrictions The access restrictions to set. + * @param [in] newAccessRestrictions The access restrictions to set. */ void setAccessRestrictions(QSharedPointer > > newAccessRestrictions); diff --git a/IPXACTmodels/Component/FieldAccessPolicyReader.h b/IPXACTmodels/Component/FieldAccessPolicyReader.h index 33b2bf4b0..fc48bec82 100644 --- a/IPXACTmodels/Component/FieldAccessPolicyReader.h +++ b/IPXACTmodels/Component/FieldAccessPolicyReader.h @@ -24,7 +24,7 @@ namespace FieldAccessPolicyReader /*! * Create a field access policy from XML description. * - * @param [in] fieldAccessPolicyNode The XML description of the field access policy. + * @param [in] fieldAccessPolicyNode The XML description of the field access policy. * * @return The created field access policy. */ @@ -35,88 +35,88 @@ namespace FieldAccessPolicyReader /*! * Read mode references. * - * @param [in] rootNode The containing element. - * @param [in] accessPolicy The created field access policy. + * @param [in] rootNode The containing element. + * @param [in] accessPolicy The created field access policy. */ void parseModeRefs(QDomNode const& rootNode, QSharedPointer accessPolicy); /*! * Read the access policy definition reference. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseDefinitionRef(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Parse field access policy access value. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseAccess(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the modified write value of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseModifiedWriteValue(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the write value constraint. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseWriteValueConstraint(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the read action. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseReadAction(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the read response of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseReadResponse(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the broadcasts of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseBroadcasts(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the access restrictions of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseAccessRestrictions(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the testable value of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseTestable(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); /*! * Read the reserved value of the field access policy. * - * @param [in] accessPolicyNode The XML description of the field access policy. - * @param [in] accessPolicy The created field access policy. + * @param [in] accessPolicyNode The XML description of the field access policy. + * @param [in] accessPolicy The created field access policy. */ void parseReserved(QDomNode const& accessPolicyNode, QSharedPointer accessPolicy); } diff --git a/IPXACTmodels/Component/FieldAccessPolicyWriter.h b/IPXACTmodels/Component/FieldAccessPolicyWriter.h index eac8e0f37..ae2f25d1b 100644 --- a/IPXACTmodels/Component/FieldAccessPolicyWriter.h +++ b/IPXACTmodels/Component/FieldAccessPolicyWriter.h @@ -24,8 +24,8 @@ namespace FieldAccessPolicyWriter /*! * Write a given field access policy to XML. * - * @param [in] writer The XML writer to use. - * @param [in] fieldAccessPolicy The field access policy to write. + * @param [in] writer The XML writer to use. + * @param [in] fieldAccessPolicy The field access policy to write. */ IPXACTMODELS_EXPORT void writeFieldAccessPolicy(QXmlStreamWriter& writer, QSharedPointer fieldAccessPolicy); diff --git a/IPXACTmodels/Component/FieldReader.h b/IPXACTmodels/Component/FieldReader.h index 1bce3a250..6cf19dd41 100644 --- a/IPXACTmodels/Component/FieldReader.h +++ b/IPXACTmodels/Component/FieldReader.h @@ -34,9 +34,9 @@ namespace FieldReader /*! * Creates a new field from a given field node. * - * @param [in] fieldNode XML description of the field. + * @param [in] fieldNode XML description of the field. * - * @return The created field. + * @return The created field. */ IPXACTMODELS_EXPORT QSharedPointer createFieldFrom(QDomNode const& fieldNode, Document::Revision docRevision); @@ -46,176 +46,176 @@ namespace FieldReader /*! * Reads the field ID. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseID(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the is present value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parsePresence(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the field memory array. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseMemoryArray(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the bit offset. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseBitOffset(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the std2022 field definition reference. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseFieldDefinitionRef(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the reset. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseResets(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the reset type reference. * - * @param [in] resetElement XML description of the reset. - * @param [in] fldReset The Reset Structure to parse into. + * @param [in] resetElement XML description of the reset. + * @param [in] fldReset The Reset Structure to parse into. */ void parseResetTypeRef(QDomElement const& resetElement, QSharedPointer fieldReset); /*! * Reads the reset value. * - * @param [in] resetElement XML description of the reset. - * @param [in] fldReset The Reset Structure to parse into. + * @param [in] resetElement XML description of the reset. + * @param [in] fldReset The Reset Structure to parse into. */ void parseResetValue(QDomElement const& resetElement, QSharedPointer fieldReset); /*! * Reads the reset mask. * - * @param [in] resetElement XML description of the reset. - * @param [in] fldReset The Reset Structure to parse into. + * @param [in] resetElement XML description of the reset. + * @param [in] fldReset The Reset Structure to parse into. */ void parseResetMask(QDomElement const& resetElement, QSharedPointer fieldReset); /*! * Reads the type identifier. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseTypeIdentifier(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the bit width. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseBitWidth(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the volatile value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseVolatile(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the field reference (ipxact:aliasOf). * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseFieldReference(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the access value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseAccess(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the enumerated values. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseEnumeratedValues(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the modified write value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseModifiedWriteValue(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the write value constraint. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseWriteValueConstraint(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the read action value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseReadAction(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the testable value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseTestable(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the reserved value. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseReserved(QDomElement const& fieldElement, QSharedPointer newField); /*! * Reads the parameters. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseParameters(QDomElement const& fieldElement, QSharedPointer newField); /*! * Parse 2022 std field access policies. * - * @param [in] fieldElement XML description of the field. - * @param [in] newField The new field item. + * @param [in] fieldElement XML description of the field. + * @param [in] newField The new field item. */ void parseFieldAccessPolicies(QDomElement const& fieldElement, QSharedPointer newField); } diff --git a/IPXACTmodels/Component/FieldReference.h b/IPXACTmodels/Component/FieldReference.h index 137ae878b..0d99ad685 100644 --- a/IPXACTmodels/Component/FieldReference.h +++ b/IPXACTmodels/Component/FieldReference.h @@ -76,15 +76,15 @@ class IPXACTMODELS_EXPORT FieldReference * Sets a reference by type. If the reference is of type bank or register file, * it will be added to the respective reference list. * - * @param [in] reference The reference to set. - * @param [in] refType The reference type. + * @param [in] reference The reference to set. + * @param [in] refType The reference type. */ void setReference(QSharedPointer reference, FieldReference::Type refType); /*! * Get the reference of a specific type. * - * @param [in] refType The reference type. + * @param [in] refType The reference type. * * @return The reference, or nullptr if invalid refType or the reference is a multiple reference. */ @@ -96,7 +96,7 @@ class IPXACTMODELS_EXPORT FieldReference * Get a list of references of a specific type. Can be called for all types, but can have multiple references * only for types bank and register file. * - * @param [in] refType The type of reference to get. + * @param [in] refType The type of reference to get. * * @return A list of references of a specific type. */ diff --git a/IPXACTmodels/Component/FieldReferenceReader.h b/IPXACTmodels/Component/FieldReferenceReader.h index 5fc6a4693..b2d6980ae 100644 --- a/IPXACTmodels/Component/FieldReferenceReader.h +++ b/IPXACTmodels/Component/FieldReferenceReader.h @@ -24,7 +24,7 @@ namespace FieldReferenceReader /*! * Create a field reference from a given parent document node. * - * @param [in] groupNode The containing element of the field reference group. + * @param [in] groupNode The containing element of the field reference group. * * @return The created field reference. */ @@ -35,8 +35,8 @@ namespace FieldReferenceReader /*! * Reads a single refrence element of the field reference. * - * @param [in] currentNode The current XML document node. - * @param [in] newFieldReference The created field reference. + * @param [in] currentNode The current XML document node. + * @param [in] newFieldReference The created field reference. */ void readSingleReferenceElement(QDomNode const& currentNode, QSharedPointer newFieldReference); @@ -44,8 +44,8 @@ namespace FieldReferenceReader /*! * Read the indices of a field reference element. * - * @param [in] referenceNode The XML document node of the field reference element. - * @param [in] newFieldRefElement The created field reference. + * @param [in] referenceNode The XML document node of the field reference element. + * @param [in] newFieldRefElement The created field reference. */ void readReferenceIndices(QDomNode const& referenceNode, QSharedPointer newFieldRefElement); diff --git a/IPXACTmodels/Component/FieldReferenceWriter.h b/IPXACTmodels/Component/FieldReferenceWriter.h index 950759a89..15d598c93 100644 --- a/IPXACTmodels/Component/FieldReferenceWriter.h +++ b/IPXACTmodels/Component/FieldReferenceWriter.h @@ -24,8 +24,8 @@ namespace FieldReferenceWriter /*! * Writes a given field reference to XML. * - * @param [in] writer The XML writer to use. - * @param [in] fieldReference The field reference to write. + * @param [in] writer The XML writer to use. + * @param [in] fieldReference The field reference to write. */ IPXACTMODELS_EXPORT void writeFieldReference(QXmlStreamWriter& writer, QSharedPointer fieldReference); @@ -34,9 +34,9 @@ namespace FieldReferenceWriter /*! * Write a given reference element of specified type. * - * @param [in] writer The XML writer to use. - * @param [in] referenceElement The field reference element to write. - * @param [in] refType The reference type to write. + * @param [in] writer The XML writer to use. + * @param [in] referenceElement The field reference element to write. + * @param [in] refType The reference type to write. */ void writeSingleFieldReference(QXmlStreamWriter& writer, QSharedPointer referenceElement, FieldReference::Type refType); @@ -44,9 +44,9 @@ namespace FieldReferenceWriter /*! * Write a list of similar field reference elements, e.g. bank refrences or register file references. * - * @param [in] writer The XML writer to use. - * @param [in] fieldReference The field reference to write. - * @param [in] refType The reference type to write. + * @param [in] writer The XML writer to use. + * @param [in] fieldReference The field reference to write. + * @param [in] refType The reference type to write. */ void writeMultipleFieldReference(QXmlStreamWriter& writer, QSharedPointer fieldReference, FieldReference::Type refType); @@ -54,8 +54,8 @@ namespace FieldReferenceWriter /*! * Write the indices of a reference element. * - * @param [in] writer The XML writer to use. - * @param [in] referenceElement The field reference element to write. + * @param [in] writer The XML writer to use. + * @param [in] referenceElement The field reference element to write. */ void writeFieldReferenceIndices(QXmlStreamWriter& writer, QSharedPointer referenceElement); diff --git a/IPXACTmodels/Component/FieldReset.h b/IPXACTmodels/Component/FieldReset.h index 6221d18b4..c996d68b9 100644 --- a/IPXACTmodels/Component/FieldReset.h +++ b/IPXACTmodels/Component/FieldReset.h @@ -48,42 +48,42 @@ class IPXACTMODELS_EXPORT FieldReset /*! * Get the reset type reference. * - * @return The reset type reference. + * @return The reset type reference. */ QString getResetTypeReference() const; /*! * Set the reset type reference. * - * @param [in] newResetTypeReference The new reset type reference. + * @param [in] newResetTypeReference The new reset type reference. */ void setResetTypeReference(QString const& newResetTypeReference); /*! * Get the reset value. * - * @return The reset value. + * @return The reset value. */ QString getResetValue() const; /*! * Set the reset value. * - * @param [in] newResetValue The new reset value. + * @param [in] newResetValue The new reset value. */ void setResetValue(QString const& newResetValue); /*! * Get the reset mask. * - * @return The reset mask. + * @return The reset mask. */ QString getResetMask() const; /*! * Set the reset mask. * - * @param [in] newResetMask The new reset mask. + * @param [in] newResetMask The new reset mask. */ void setResetMask(QString const& newResetMask); diff --git a/IPXACTmodels/Component/FieldWriter.h b/IPXACTmodels/Component/FieldWriter.h index 2b42c2be3..e955ab88f 100644 --- a/IPXACTmodels/Component/FieldWriter.h +++ b/IPXACTmodels/Component/FieldWriter.h @@ -32,8 +32,8 @@ namespace FieldWriter /*! * Write a field to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] field The field to be written. + * @param [in] writer The used xml writer. + * @param [in] field The field to be written. */ IPXACTMODELS_EXPORT void writeField(QXmlStreamWriter& writer, QSharedPointer field, Document::Revision docRevision = Document::Revision::Std14); @@ -43,80 +43,80 @@ namespace FieldWriter /*! * Write the field id attribute. * - * @param [in] writer Used XML writer. - * @param [in] fieldID The field id. + * @param [in] writer Used XML writer. + * @param [in] fieldID The field id. */ void writeID(QXmlStreamWriter& writer, QString const& fieldID, Document::Revision docRevision); /*! * Write the field memory array. * - * @param [in] writer The used xml writer. - * @param [in] field The field to be written. + * @param [in] writer The used xml writer. + * @param [in] field The field to be written. */ void writeMemoryArray(QXmlStreamWriter& writer, QSharedPointer field, Document::Revision docRevision); /*! * Write the field definition reference. * - * @param [in] writer The used XML writer. - * @param [in] field The field to be written. + * @param [in] writer The used XML writer. + * @param [in] field The field to be written. */ void writeFieldDefinitionRef(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the reset. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeResets(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the type identifier. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeTypeIdentifier(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the volatile value. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeVolatile(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the access value. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeAccess(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the enumerated values. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeEnumerations(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the modified write value. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeModifiedWriteValue(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the write value constraint. * - * @param [in] writer Used XML writer. - * @param [in] writeConstaint The field write value constraint. + * @param [in] writer Used XML writer. + * @param [in] writeConstaint The field write value constraint. */ void writeWriteValueConstraint(QXmlStreamWriter& writer, QSharedPointer writeConstraint) ; @@ -124,48 +124,48 @@ namespace FieldWriter /*! * Write the read action. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeReadAction(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the testable element. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeTestable(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the reserved value. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeReserved(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write field data using 2014 standard revision. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeFieldData2014(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write field data using 2022 standard revision. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeFieldData2022(QXmlStreamWriter& writer, QSharedPointer field); /*! * Write the field reference, i.e. ipxact:aliasOf. * - * @param [in] writer Used XML writer. - * @param [in] field The selected field item. + * @param [in] writer Used XML writer. + * @param [in] field The selected field item. */ void writeFieldReference(QXmlStreamWriter& writer, QSharedPointer field); } diff --git a/IPXACTmodels/Component/File.h b/IPXACTmodels/Component/File.h index 479517088..90540fa45 100644 --- a/IPXACTmodels/Component/File.h +++ b/IPXACTmodels/Component/File.h @@ -37,8 +37,8 @@ class IPXACTMODELS_EXPORT File : public Extendable /*! * The constructor. * - * @param [in] filePath Path to or name of the file. - * @param [in] fileType The file type. + * @param [in] filePath Path to or name of the file. + * @param [in] fileType The file type. */ File (QString const& filePath = QString(), QString const& fileType = QString()); @@ -60,283 +60,283 @@ class IPXACTMODELS_EXPORT File : public Extendable /*! * Get the id of the file. * - * @return The ID of the file. + * @return The ID of the file. */ QString getFileId() const; /*! * Set the id. * - * @param [in] newFileId The new id. + * @param [in] newFileId The new id. */ void setFileId(QString const& newFileId); /*! * Get the attributes for the file-element * - * @return QMap containing the attributes. + * @return QMap containing the attributes. */ QMap getAttributes() const; /*! * Set the attributes for the file * - * @param [in] newAttributes Qmap containing the new attributes. + * @param [in] newAttributes Qmap containing the new attributes. */ void setAttributes(QMap const& newAttributes); /*! * Get the name of the file * - * @return QString containing the name. + * @return QString containing the name. */ QString name() const; /*! * Set the name for this file. * - * @param [in] name QString containing the name. + * @param [in] name QString containing the name. */ void setName(QString const& newName); /*! * Get the presence of this file. * - * @return The presence of this file. + * @return The presence of this file. */ QString getIsPresent() const; /*! * Set the presence for this file. * - * @param [in] newIsPresent The new presence. + * @param [in] newIsPresent The new presence. */ void setIsPresent(QString const& newIsPresent); /*! * Get the file types * - * @return Pointer to a QList containing the file types. + * @return Pointer to a QList containing the file types. */ QSharedPointer > getFileTypes() const; /*! * Get the file types as a list * - * @return The file types. + * @return The file types. */ QStringList getFileTypeNames() const; /*! * Set the file types for this file * - * @param [in] fileTypes QList containing the new file types. + * @param [in] fileTypes QList containing the new file types. */ void setFileTypes(QSharedPointer > newFileTypes); /*! * Check if the file contains structural RTL. * - * @return True if the file contains structural RTL, false otherwise. + * @return True if the file contains structural RTL, false otherwise. */ bool isStructural() const; /*! * Set the file to contain structural RTL. * - * @param [in] structuralStatus The new structural status. + * @param [in] structuralStatus The new structural status. */ void setStructural(bool structuralStatus); /*! * Get the isIncludeFile setting. * - * @return True if the file is an include file, otherwise false. + * @return True if the file is an include file, otherwise false. */ bool isIncludeFile() const; /*! * Set the isIncludeFile setting for this file. * - * @param [in] includeFile boolean value to be set. + * @param [in] includeFile boolean value to be set. */ void setIncludeFile(bool includeFile); /*! * Get attribute value of external declarations. * - * @return True of the file has external declarations, otherwise false. + * @return True of the file has external declarations, otherwise false. */ bool hasExternalDeclarations() const; /*! * Set the externalDeclarations setting * - * @param [in] externalDeclarations Boolean value to be set. + * @param [in] externalDeclarations Boolean value to be set. */ void setExternalDeclarations(bool externalDeclarations); /*! * Get the logicalName of the file * - * @return QString containing the name. + * @return QString containing the name. */ QString getLogicalName() const; /*! * Set the logical name for this file. * - * @param [in] logicalName QString containing the new logical name. + * @param [in] logicalName QString containing the new logical name. */ void setLogicalName(QString const& logicalName); /*! * Get the default-attribute value of the logicalName element. * - * @return True of the logical name is default, otherwise false. + * @return True of the logical name is default, otherwise false. */ bool isLogicalNameDefault() const; /*! * Set the logical name attribute default. * - * @param [in] logicalNameDefault Boolean value of the attribute. + * @param [in] logicalNameDefault Boolean value of the attribute. */ void setLogicalNameDefault(bool logicalNameDefault); /*! * Get the exportedName for this file * - * @return QList containing the names that can be referenced externally. + * @return QList containing the names that can be referenced externally. */ QSharedPointer getExportedNames() const; /*! * Set the exported names for this file * - * @param [in] exportedNames QList containing the exported names. + * @param [in] exportedNames QList containing the exported names. */ void setExportedNames(QSharedPointer exportedNames); /*! * Get the build command for this file * - * @return A pointer to the BuildCommand containing the flags and commands. + * @return A pointer to the BuildCommand containing the flags and commands. */ QSharedPointer getBuildCommand() const; /*! * Set the buildCommand for this file * - * @param [in] buildcommand A pointer to the new build command. + * @param [in] buildcommand A pointer to the new build command. */ void setBuildcommand(QSharedPointer newBuildCommand); /*! * Get the dependencies for this file * - * @return QList containing the paths to the directories containing files on which this file depends on. + * @return QList containing the paths to the directories containing files on which this file depends on. */ QSharedPointer getDependencies(); /*! * Set the dependencies for this file. * - * @param [in] dependencies The paths to directories containing files on which this file depends on. + * @param [in] dependencies The paths to directories containing files on which this file depends on. */ void setDependencies(QSharedPointer newDependencies); /*! * Get the defines of the file * - * @return Name value pairs of the file defines. + * @return Name value pairs of the file defines. */ QSharedPointer > > getDefines(); /*! * Set the defines for this file. * - * @param [in] defines The new name-value pairs. + * @param [in] defines The new name-value pairs. */ void setDefines(QSharedPointer > > newDefines); /*! * Get the imageTypes of this file * - * @return QList containing the imageTypes. + * @return QList containing the imageTypes. */ QSharedPointer getImageTypes(); /*! * Set the image types for this file * - * @param [in] imageTypes QList containing the new image types. + * @param [in] imageTypes QList containing the new image types. */ void setImageTypes(QSharedPointer newImageTypes); /*! * Get the description of this file. * - * @return QString containing the description. + * @return QString containing the description. */ QString getDescription() const; /*! * Set the description for this file. * - * @param [in] description QString containing the description. + * @param [in] description QString containing the description. */ void setDescription(QString const& description); /*! * Returns the last calculated hash. * - * @return The last calculated hash. + * @return The last calculated hash. */ QString getLastHash() const; /*! * Set the last calculated hash. * - * @param [in] newHash The new hash value. + * @param [in] newHash The new hash value. */ void setLastHash(QString const& newHash); /*! * Gets the newest calculated hash pending for commit. * - * @return The pending hash. + * @return The pending hash. */ QString getPendingHash() const; /*! * Sets the newest calculated hash pending for commit. * - * @param [in] hash The calculated hash value. + * @param [in] hash The calculated hash value. */ void setPendingHash(QString const& hash); /*! * Check if the file matches at least one of the specified file types. * - * @param [in] fileTypes The file types to check. + * @param [in] fileTypes The file types to check. * - * @return True if at least on of the file types matches the file types of this file. + * @return True if at least on of the file types matches the file types of this file. */ bool matchesFileType(const QStringList& fileTypes) const; /*! * Check if the file matches the specified file type. * - * @param [in] fileType The file type to check. + * @param [in] fileType The file type to check. * - * @return True if the file type is found either in file types or user file types. + * @return True if the file type is found either in file types or user file types. */ bool matchesFileType(const QString& fileType) const; /*! Set the file types for the file to match the defined settings. * - * @param [in] settings Contains the file type settings. + * @param [in] settings Contains the file type settings. * */ void setFileTypes(QSettings& settings); @@ -344,7 +344,7 @@ class IPXACTMODELS_EXPORT File : public Extendable /*! * Add a new file type definition. * - * @param [in] fileType The name of the file type. + * @param [in] fileType The name of the file type. */ void addFileType(QString const& fileType, QString const& libext = QString()); @@ -362,50 +362,50 @@ class IPXACTMODELS_EXPORT File : public Extendable /*! * Get the build command's command-part * - * @return QString containing the command. + * @return QString containing the command. */ QString getCommand() const; /*! * Get the build flags for this file. * - * @return QString containing the flags for this file. + * @return QString containing the flags for this file. */ QString getFlags() const; /*! * Check if the file is a RTL file or not. * - * @return bool True if file is vhdl or verilog file. + * @return bool True if file is vhdl or verilog file. */ bool isRTLFile() const; /*! * Check if this file is a vhdl file. * - * @return bool True if the file is vhdl-file. + * @return bool True if the file is vhdl-file. */ bool isVhdlFile() const; /*! * Check if the file is a verilog file. * - * @return True if the file is a verilog file. + * @return True if the file is a verilog file. */ bool isVerilogFile() const; /*! * Set a build command for the file * - * @param [in] buildCommand QString containing the command. + * @param [in] buildCommand QString containing the command. */ void setCommand(const QString& buildCommand); /*! * Set the flags for the build command * - * @param [in] buildFlags QString containing the flags - * @param [in] replaceDefault Should the default flags be replaced or appended. + * @param [in] buildFlags QString containing the flags + * @param [in] replaceDefault Should the default flags be replaced or appended. * */ void setBuildFlags(QString const& buildFlags, QString const& replaceDefaultFlags); diff --git a/IPXACTmodels/Component/FileReader.h b/IPXACTmodels/Component/FileReader.h index d12d935e1..e6632a1dd 100644 --- a/IPXACTmodels/Component/FileReader.h +++ b/IPXACTmodels/Component/FileReader.h @@ -27,16 +27,16 @@ namespace FileReader /*! * Creates a new file from a given file node. * - * @param [in] fileNode XML description of the file. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileNode XML description of the file. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT QSharedPointer createFileFrom(QDomNode const& fileNode, Document::Revision docRevision); /*! * Creates a new file type from a given node. * - * @param [in] fileTypeNode XML description of the file type. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileTypeNode XML description of the file type. + * @param [in] docRevision The applied IP-XACT standard revision. */ FileType parseFileType(QDomNode const& fileTypeNode, Document::Revision docRevision); @@ -46,65 +46,65 @@ namespace FileReader /*! * Parses the file attributes. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseFileAttributes(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the file types. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseFileTypes(QDomElement const& fileElement, QSharedPointer newFile, Document::Revision docRevision); /*! * Parses the structural status. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseIsStructural(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the include file status. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseIsIncludeFile(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the logical name. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseLogicalName(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the exported names. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseExportedNames(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the file build command. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseBuildCommand(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the command used in the build command. * - * @param [in] buildCommandElement XML description of the build command. - * @param [in] newBuildCommand The new build command item. + * @param [in] buildCommandElement XML description of the build command. + * @param [in] newBuildCommand The new build command item. */ void parseBuildCommandCommand(QDomElement const& buildCommandElement, QSharedPointer newBuildCommand); @@ -112,8 +112,8 @@ namespace FileReader /*! * Parses the build command flags. * - * @param [in] buildCommandElement XML description of the build command. - * @param [in] newBuildCommand The new build command item. + * @param [in] buildCommandElement XML description of the build command. + * @param [in] newBuildCommand The new build command item. */ void parseBuildCommandFlags(QDomElement const& buildCommandElement, QSharedPointer newBuildCommand); @@ -121,8 +121,8 @@ namespace FileReader /*! * Parses the expression for build command flag replacement. * - * @param [in] buildCommandElement XML description of the build command. - * @param [in] newBuildCommand The new build command item. + * @param [in] buildCommandElement XML description of the build command. + * @param [in] newBuildCommand The new build command item. */ void parseBuildCommandReplaceFlags(QDomElement const& buildCommandElement, QSharedPointer newBuildCommand); @@ -130,8 +130,8 @@ namespace FileReader /*! * Parses the build command target. * - * @param [in] buildCommandElement XML description of the build command. - * @param [in] newBuildCommand The new build command item. + * @param [in] buildCommandElement XML description of the build command. + * @param [in] newBuildCommand The new build command item. */ void parseBuildCommandTarget(QDomElement const& buildCommandElement, QSharedPointer newBuildCommand); @@ -139,40 +139,40 @@ namespace FileReader /*! * Parses the dependencies. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseDependencies(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the defines. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseDefines(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the image types. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseImageTypes(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the description. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseDescription(QDomElement const& fileElement, QSharedPointer newFile); /*! * Parses the file vendor extensions. * - * @param [in] fileElement XML description of the file. - * @param [in] newFile The new file item. + * @param [in] fileElement XML description of the file. + * @param [in] newFile The new file item. */ void parseFileExtensions(QDomNode const& fileNode, QSharedPointer newFile); } diff --git a/IPXACTmodels/Component/FileSet.h b/IPXACTmodels/Component/FileSet.h index 4d3ee61a6..bf0452d2c 100644 --- a/IPXACTmodels/Component/FileSet.h +++ b/IPXACTmodels/Component/FileSet.h @@ -40,8 +40,8 @@ class IPXACTMODELS_EXPORT FileSet : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the file set. - * @param [in] group Group where this file set belongs to. + * @param [in] name Name of the file set. + * @param [in] group Group where this file set belongs to. */ FileSet(const QString& name = QString(), const QString& group = QString()); @@ -66,36 +66,36 @@ class IPXACTMODELS_EXPORT FileSet : public NameGroup, public Extendable /*! * Set the groups for this file set * - * @param [in] groups The new group names. + * @param [in] groups The new group names. */ void setGroups (QSharedPointer newGroups); /*! Clear the previous groups and add a new group identifier. * - * @param [in] groupName The group identifier which is set after clearing. + * @param [in] groupName The group identifier which is set after clearing. */ void setGroups(const QString& groupName); /*! * Get the files associated with this file set * - * @return Pointer to a list containing the files associated with this file set. + * @return Pointer to a list containing the files associated with this file set. */ QSharedPointer > > getFiles() const; /*! * Get the files that match the specified file types. * - * @param [in] fileTypes Contains the file types that are being searched. + * @param [in] fileTypes Contains the file types that are being searched. * - * @return The relative file paths to the matched files. + * @return The relative file paths to the matched files. */ QStringList getFileNames(const QStringList& fileTypes) const; /*! * Set the files for this file set * - * @param [in] files Pointer to a list containing the new files. + * @param [in] files Pointer to a list containing the new files. */ void setFiles(QSharedPointer > > newFiles); @@ -103,167 +103,167 @@ class IPXACTMODELS_EXPORT FileSet : public NameGroup, public Extendable /*! * Get the default file builders for this file set * - * @return Pointer to a list containing the file builders. + * @return Pointer to a list containing the file builders. */ QSharedPointer > > getDefaultFileBuilders() const; /*! * Set the default file builders for this file set. * - * @param [in] defaultFileBuilders Pointer to a list containing the new default file builders. + * @param [in] defaultFileBuilders Pointer to a list containing the new default file builders. */ void setDefaultFileBuilders(QSharedPointer > > newDefaultFileBuilders); /*! * Get the dependencies for this file set * - * @return Paths for the directories containing files on which this file set depends. + * @return Paths for the directories containing files on which this file set depends. */ QSharedPointer getDependencies() const; /*! * Set the dependencies for this file set * - * @param [in] dependencies The new dependencies. + * @param [in] dependencies The new dependencies. */ void setDependencies(QSharedPointer newDependencies); /*! Add a new dependent directory to the file set. * - * @param [in] path Relative path to the dependent directory to add. + * @param [in] path Relative path to the dependent directory to add. * */ void addDependency(const QString& path); /*! Get list of the functions for this file set * - * @return Pointer to a list containing the functions. + * @return Pointer to a list containing the functions. */ QSharedPointer > > getFunctions() const; /*! * Set the functions for this file set * - * @param [in] functions Pointer to a list containing the new functions. + * @param [in] functions Pointer to a list containing the new functions. */ void setFunctions(QSharedPointer > > newFunctions); /*! * Get the names of the vhdl libraries on this file set. * - * @return The library names. + * @return The library names. */ QStringList getVhdlLibraryNames() const; /*! * Get the file paths of the files stored in the file set. * - * @return The file paths. + * @return The file paths. */ QStringList getFilePaths() const; /*! * Add a new file to the file set. * - * @param [in] file Pointer to the new file to be added. + * @param [in] file Pointer to the new file to be added. */ void addFile(QSharedPointer file); /*! * Add a new file to the file set. * - * @param [in] filePath Path to the file to add (this should be relative path). - * @param [in] settings Contains the file type settings for Kactus2. + * @param [in] filePath Path to the file to add (this should be relative path). + * @param [in] settings Contains the file type settings for Kactus2. * - * @return Pointer to the new file. + * @return Pointer to the new file. */ QSharedPointer addFile(const QString& filePath, QSettings& settings); /*! * Get pointer to the file with given logical name. * - * @param [in] logicalName The logical name of the wanted file. The first one found is returned. + * @param [in] logicalName The logical name of the wanted file. The first one found is returned. * - * @return Pointer to the File instance, null pointer if none is found. + * @return Pointer to the File instance, null pointer if none is found. */ QSharedPointer getFile(QString const& logicalName) const; /*! * Get the name elements of the files stored within this file set. * - * @return The file names. + * @return The file names. */ QStringList getFileNames() const; /*! * Find the files that match the specified file type. * - * @param [in] fileType The file type to search within files. + * @param [in] fileType The file type to search within files. * - * @return The file paths to files that match the file type. + * @return The file paths to files that match the file type. */ QStringList findFilesByFileType(const QString& fileType) const; /*! * Remove the specified file from the file set. * - * @param [in] fileName The name of the file to be removed + * @param [in] fileName The name of the file to be removed */ void removeFile(const QString& fileName); /*! * Remove the specified file from the file set. * - * @param [in] file Pointer to the file that is to be removed + * @param [in] file Pointer to the file that is to be removed */ void removeFile(QSharedPointer file); /*! * Create a new file to the file set. * - * @return Pointer to the file that was created. + * @return Pointer to the file that was created. */ QSharedPointer createFile(); /*! * Get the default build command's command part for given file. * - * @param [in] file Pointer to the file that's command is wanted. + * @param [in] file Pointer to the file that's command is wanted. * - * @return Command of the selected file. + * @return Command of the selected file. */ QString getDefaultCommand(QSharedPointer file) const; /*! * Get the default build command's flags for given file. * - * @param [in] file Pointer to the file that's default flags are wanted. + * @param [in] file Pointer to the file that's default flags are wanted. * - * @return The default flags of selected file. + * @return The default flags of selected file. */ QString getDefaultFlags(QSharedPointer file) const; /*! * Get list of the RTL files contained in this file set. * - * @return Pointers to the files. + * @return Pointers to the files. */ QList > getRTLFiles() const; /*! * Does the file set contain file with given name. * - * @param [in] fileName The name of the file searched for. + * @param [in] fileName The name of the file searched for. * - * @return True if file is found, false otherwise. + * @return True if file is found, false otherwise. */ bool contains(const QString& fileName) const; /*! * Change the name of a file within this file set. * - * @param [in] from The current file name. - * @param [in] to The file name to set. + * @param [in] from The current file name. + * @param [in] to The file name to set. */ void changeFileName(const QString& from, const QString& to); @@ -275,14 +275,14 @@ class IPXACTMODELS_EXPORT FileSet : public NameGroup, public Extendable /*! * Get id of the file set. * - * @return The file set id. + * @return The file set id. */ QString getFileSetId() const; /*! * Set the file set id. * - * @param [in] id The id to be set. + * @param [in] id The id to be set. */ void setFileSetId(const QString& newId); @@ -291,28 +291,28 @@ class IPXACTMODELS_EXPORT FileSet : public NameGroup, public Extendable /*! * Copies the files. * - * @param [in] other The file set from which to copy the files. + * @param [in] other The file set from which to copy the files. */ void copyFiles(const FileSet& other); /*! * Copies the default file builders. * - * @param [in] other The file set from which to copy the default file builders. + * @param [in] other The file set from which to copy the default file builders. */ void copyDefaultFileBuilders(const FileSet& other); /*! * Copies the functions. * - * @param [in] other The file set from which to copy the functions. + * @param [in] other The file set from which to copy the functions. */ void copyFunctions(const FileSet& other); /*! * Copies the groups and dependencies. * - * @param [in] other The file set from which to copy the groups and dependencies. + * @param [in] other The file set from which to copy the groups and dependencies. */ void copyStringLists(const FileSet& other); diff --git a/IPXACTmodels/Component/FileSetReader.h b/IPXACTmodels/Component/FileSetReader.h index 4583229f0..9271b6e7c 100644 --- a/IPXACTmodels/Component/FileSetReader.h +++ b/IPXACTmodels/Component/FileSetReader.h @@ -27,8 +27,8 @@ namespace FileSetReader /*! * Creates a new file set from a given file set node. * - * @param [in] fileSetNode XML description of the file set. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileSetNode XML description of the file set. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT QSharedPointer createFileSetFrom(QDomNode const& fileSetNode, Document::Revision docRevision); @@ -37,26 +37,26 @@ namespace FileSetReader /*! * Reads the groups. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. */ void parseGroups(QDomElement const& fileSetElement, QSharedPointer newFileSet); /*! * Reads the files. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseFiles(QDomElement const& fileSetElement, QSharedPointer newFileSet, Document::Revision docRevision); /*! * Reads the default file builders. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseDefaultFileBuilders(QDomElement const& fileSetElement, QSharedPointer newFileSet, Document::Revision docRevision); @@ -64,64 +64,64 @@ namespace FileSetReader /*! * Reads the dependencies. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. */ void parseDependencies(QDomElement const& fileSetElement, QSharedPointer newFileSet); /*! * Reads the functions. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. */ void parseFunctions(QDomElement const& fileSetElement, QSharedPointer newFileSet); /*! * Reads the function entry point. * - * @param [in] functionElement XML description of the function. - * @param [in] newFunction The new function item. + * @param [in] functionElement XML description of the function. + * @param [in] newFunction The new function item. */ void parseFunctionEntryPoint(QDomElement const& functionElement, QSharedPointer newFunction); /*! * Reads the function return type. * - * @param [in] functionElement XML description of the function. - * @param [in] newFunction The new function item. + * @param [in] functionElement XML description of the function. + * @param [in] newFunction The new function item. */ void parseFunctionReturnType(QDomElement const& functionElement, QSharedPointer newFunction); /*! * Reads the function arguments. * - * @param [in] functionElement XML description of the function. - * @param [in] newFunction The new function item. + * @param [in] functionElement XML description of the function. + * @param [in] newFunction The new function item. */ void parseFunctionArguments(QDomElement const& functionElement, QSharedPointer newFunction); /*! * Reads the function disabled value. * - * @param [in] functionElement XML description of the function. - * @param [in] newFunction The new function item. + * @param [in] functionElement XML description of the function. + * @param [in] newFunction The new function item. */ void parseFunctionDisabled(QDomElement const& functionElement, QSharedPointer newFunction); /*! * Reads the function source files. * - * @param [in] functionElement XML description of the function. - * @param [in] newFunction The new function item. + * @param [in] functionElement XML description of the function. + * @param [in] newFunction The new function item. */ void parseFunctionSourceFiles(QDomElement const& functionElement, QSharedPointer newFunction); /*! * Reads the file set extensions. * - * @param [in] fileSetElement XML description of the file set. - * @param [in] newFileSet The new file set item. + * @param [in] fileSetElement XML description of the file set. + * @param [in] newFileSet The new file set item. */ void parseFileSetExtensions(QDomElement const& fileSetElement, QSharedPointer newFileSet); } diff --git a/IPXACTmodels/Component/FileSetWriter.h b/IPXACTmodels/Component/FileSetWriter.h index 68087fa87..e57cb2390 100644 --- a/IPXACTmodels/Component/FileSetWriter.h +++ b/IPXACTmodels/Component/FileSetWriter.h @@ -30,9 +30,9 @@ namespace FileSetWriter /*! * Write a file set to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] file The file set to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] file The file set to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT void writeFileSet(QXmlStreamWriter& writer, QSharedPointer fileSet, Document::Revision docRevision); @@ -43,17 +43,17 @@ namespace FileSetWriter /*! * Write the file set groups. * - * @param [in] writer Used XML writer. - * @param [in] groups The file set groups. + * @param [in] writer Used XML writer. + * @param [in] groups The file set groups. */ void writeGroups(QXmlStreamWriter& writer, QSharedPointer groups); /*! * Write the files. * - * @param [in] writer Used XML writer. - * @param [in] fileSetFiles The files. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] fileSetFiles The files. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeFiles(QXmlStreamWriter& writer, QSharedPointer > > fileSetFiles, Document::Revision docRevision); @@ -61,9 +61,9 @@ namespace FileSetWriter /*! * Write the default file builders. * - * @param [in] writer Used XML writer. - * @param [in] defaultFileBuilders The default file builders. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] defaultFileBuilders The default file builders. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeDefaultFileBuilders(QXmlStreamWriter& writer, QSharedPointer > > defaultFileBuilders, @@ -72,17 +72,17 @@ namespace FileSetWriter /*! * Write the dependencies. * - * @param [in] writer Used XML writer. - * @param [in] dependencies The dependencies of the file set. + * @param [in] writer Used XML writer. + * @param [in] dependencies The dependencies of the file set. */ void writeDependencies(QXmlStreamWriter& writer, QSharedPointer dependencies); /*! * Write the functions. * - * @param [in] writer Used XML writer. - * @param [in] functions The functions. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] functions The functions. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeFunctions(QXmlStreamWriter& writer, QSharedPointer > > functions, Document::Revision docRevision); @@ -90,24 +90,24 @@ namespace FileSetWriter /*! * Write the function entry point. * - * @param [in] writer Used XML writer. - * @param [in] function The selected function. + * @param [in] writer Used XML writer. + * @param [in] function The selected function. */ void writeFunctionEntryPoint(QXmlStreamWriter& writer, QSharedPointer function); /*! * Write the function return type. * - * @param [in] writer Used XML writer. - * @param [in] function The selected function. + * @param [in] writer Used XML writer. + * @param [in] function The selected function. */ void writeFunctionReturnType(QXmlStreamWriter& writer, QSharedPointer function); /*! * Write the function arguments. * - * @param [in] writer Used XML writer. - * @param [in] arguments The function arguments. + * @param [in] writer Used XML writer. + * @param [in] arguments The function arguments. */ void writeFunctionArguments(QXmlStreamWriter& writer, QSharedPointer > > arguments); @@ -115,17 +115,17 @@ namespace FileSetWriter /*! * Write the function disabled value. * - * @param [in] writer Used XML writer. - * @param [in] function The selected function. + * @param [in] writer Used XML writer. + * @param [in] function The selected function. */ void writeFunctionDisabledValue(QXmlStreamWriter& writer, QSharedPointer function); /*! * Write the function source files. * - * @param [in] writer Used XML writer. - * @param [in] function The selected function. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] function The selected function. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeFunctionSourceFiles(QXmlStreamWriter& writer, QSharedPointer > > sourceFiles, diff --git a/IPXACTmodels/Component/FileWriter.h b/IPXACTmodels/Component/FileWriter.h index b7352ca67..10436b3e4 100644 --- a/IPXACTmodels/Component/FileWriter.h +++ b/IPXACTmodels/Component/FileWriter.h @@ -30,18 +30,18 @@ namespace FileWriter /*! * Write a file to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT void writeFile(QXmlStreamWriter& writer, QSharedPointer file, Document::Revision docRevision); /*! * Write a file type to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] fileType The file type to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] fileType The file type to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeFileType(QXmlStreamWriter& writer, FileType const& fileType, Document::Revision docRevision); @@ -51,89 +51,89 @@ namespace FileWriter /*! * Write the file types. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeFileTypes(QXmlStreamWriter& writer, QSharedPointer file, Document::Revision docRevision); /*! * Write the file attributes. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeAttributes(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the structural status of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeIsStructural(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the include file status of the value. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeIsIncludeFile(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the logical name of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeLogicalName(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the exported names of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeExportedNames(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the build command of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeBuildCommand(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the dependencies of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeDependencies(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the defines of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeDefines(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the image types of the file. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeImageTypes(QXmlStreamWriter& writer, QSharedPointer file); /*! * Write the file extensions. * - * @param [in] writer The used xml writer. - * @param [in] file The file to be written. + * @param [in] writer The used xml writer. + * @param [in] file The file to be written. */ void writeFileExtensions(QXmlStreamWriter& writer, QSharedPointer file); } diff --git a/IPXACTmodels/Component/Function.h b/IPXACTmodels/Component/Function.h index 488464302..387a8cabd 100644 --- a/IPXACTmodels/Component/Function.h +++ b/IPXACTmodels/Component/Function.h @@ -45,8 +45,8 @@ class IPXACTMODELS_EXPORT Function /*! * The constructor. * - * @param [in] sourceName The name of the source file. - * @param [in] fileType The file type. + * @param [in] sourceName The name of the source file. + * @param [in] fileType The file type. */ IPXACTMODELS_EXPORT SourceFile(QString const& sourceName = QString(), QString const& fileType = QString()); @@ -56,28 +56,28 @@ class IPXACTMODELS_EXPORT Function /*! * Gets the source name. * - * @return The name of the source. + * @return The name of the source. */ IPXACTMODELS_EXPORT QString getSourceName() const; /*! * Set the source name. * - * @param [in] newSourceName The new name for the source. + * @param [in] newSourceName The new name for the source. */ IPXACTMODELS_EXPORT void setSourceName(QString const& newSourceName); /*! * Get the file type of the source. * - * @return The source file type. + * @return The source file type. */ IPXACTMODELS_EXPORT FileType getFileType() const; /*! * Set the file type for the source. * - * @param [in] newFileType The new source file type. + * @param [in] newFileType The new source file type. */ IPXACTMODELS_EXPORT void setFileType(FileType const& newFileType); }; @@ -85,7 +85,7 @@ class IPXACTMODELS_EXPORT Function /*! * The constructor. * - * @param [in] fileReference The referenced file. + * @param [in] fileReference The referenced file. */ Function(QString const& fileReference = QString()); @@ -103,112 +103,112 @@ class IPXACTMODELS_EXPORT Function /*! * Get the value of the replicate-attribute. * - * @return True for a replicated function, false otherwise. + * @return True for a replicated function, false otherwise. */ bool getReplicate() const; /*! * Set the replicate value. * - * @param [in] replicate The new replicate value. + * @param [in] replicate The new replicate value. */ void setReplicate(bool replicate); /*! * Get entry point of the function. * - * @return The entry point. + * @return The entry point. */ QString getEntryPoint() const; /*! * Set the entry point for the function. * - * @param [in] entryPoint The new entry point. + * @param [in] entryPoint The new entry point. */ void setEntryPoint(QString const& entryPoint); /*! * Get the file reference. * - * @return The file reference. + * @return The file reference. */ QString getFileRef() const; /*! * Set the file reference. * - * @param [in] fileRef The reference to the new file. + * @param [in] fileRef The reference to the new file. */ void setFileRef(QString const& fileRef); /*! * Get the return type of the function. * - * @return The return type. + * @return The return type. */ QString getReturnType() const; /*! * Set the return type of the function. * - * @param [in] returnType The new return type. Only void and int are appected. + * @param [in] returnType The new return type. Only void and int are appected. */ void setReturnType(QString const& returnType); /*! * Get the list of function arguments. * - * @return Pointer to a list containing the arguments. + * @return Pointer to a list containing the arguments. */ QSharedPointer > > getArguments() const; /*! * Set arguments for the function. * - * @param [in] arguments Pointer to a list containing the new arguments. + * @param [in] arguments Pointer to a list containing the new arguments. */ void setArguments(QSharedPointer > > arguments); /*! * Get the disabled value * - * @return The expression for the disabled value. + * @return The expression for the disabled value. */ QString getDisabled() const; /*! * Set the disabled value * - * @param [in] disabled The new disabled value. + * @param [in] disabled The new disabled value. */ void setDisabled(QString const& newDisabled); /*! * Get the attributes of the disabled-element. * - * @return QMap containing the attributes for disabled value. + * @return QMap containing the attributes for disabled value. */ QMap getDisabledAttributes() const; /*! * Set the attributes for the disabled-element. * - * @param [in] disabledAttributes The new attributes for the disabled value. + * @param [in] disabledAttributes The new attributes for the disabled value. */ void setDisabledAttributes(QMap& disabledAttributes); /*! * Get list of the source files for the function. * - * @return Pointer to a list containing the source files. + * @return Pointer to a list containing the source files. */ QSharedPointer > > getSourceFiles() const; /*! * Set the source files for the function. * - * @param [in] sourceFiles Pointer to a list containing the new source files. + * @param [in] sourceFiles Pointer to a list containing the new source files. */ void setSourceFiles(QSharedPointer > > newSourceFiles); @@ -217,14 +217,14 @@ class IPXACTMODELS_EXPORT Function /*! * Copy the arguments of a function. * - * @param [in] other The function being copied. + * @param [in] other The function being copied. */ void copyArguments(const Function& other); /*! * Copy the source files of a function. * - * @param [in] other The function being copied. + * @param [in] other The function being copied. */ void copySourceFiles(const Function& other); diff --git a/IPXACTmodels/Component/IndirectInterface.h b/IPXACTmodels/Component/IndirectInterface.h index 31ee60ab3..d9680a150 100644 --- a/IPXACTmodels/Component/IndirectInterface.h +++ b/IPXACTmodels/Component/IndirectInterface.h @@ -43,98 +43,98 @@ class IPXACTMODELS_EXPORT IndirectInterface : public NameGroup, public Extendabl /*! * Get the attributes of the indirect interface. * - * @return The attributes. + * @return The attributes. */ QMap getAttributes() const; /*! * Set the attributes for the indirect interface. * - * @param [in] attributes The attributes to set. + * @param [in] attributes The attributes to set. */ void setAttributes(QMap const& attributes); /*! * Sets the reference for the indirect access address field. * - * @param [in] addressFieldId The id for the address field. + * @param [in] addressFieldId The id for the address field. */ void setIndirectAddressRef(QString const& addressFieldId); /*! * Gets the reference for the indirect access address field. * - * @return The indirect address field id. + * @return The indirect address field id. */ QString getIndirectAddressRef() const; /*! * Sets the reference for the indirect access data field. * - * @param [in] dataFieldId The id for the data field. + * @param [in] dataFieldId The id for the data field. */ void setIndirectDataRef(QString const& dataFieldId); /*! * Gets the reference for the indirect access data field. * - * @return The indirect data field id. + * @return The indirect data field id. */ QString getIndirectDataRef() const; /*! * Sets the indirectly accessible memory map. * - * @param [in] memoryMapName The name of the accessible memory map. + * @param [in] memoryMapName The name of the accessible memory map. */ void setMemoryMapRef(QString const& memoryMapName); /*! * Gets the indirectly accessible memory map. * - * @return The name of the indirectly accessible memory map. + * @return The name of the indirectly accessible memory map. */ QString getMemoryMapRef() const; /*! * Gets the transparent bridges in the indirect interface. * - * @return The transparent bridges. + * @return The transparent bridges. */ QSharedPointer > > getTransparentBridges() const; /*! * Sets the number of bits in the least addressable unit. * - * @param [in] bitsInLau The number of bits to set. + * @param [in] bitsInLau The number of bits to set. */ void setBitsInLau(QString const& bitsInLau); /*! * Gets the number of bits in the least addressable unit. * - * @return The number of bits in the least addressable unit. + * @return The number of bits in the least addressable unit. */ QString getBitsInLau() const; /*! * Sets the endianness (little/big) for the indirect interface. * - * @param [in] endianness The endianness to set. + * @param [in] endianness The endianness to set. */ void setEndianness(QString const& endianness); /*! * Gets the endianness (little/big) for the indirect interface. * - * @return The endianness of the indirect interface. + * @return The endianness of the indirect interface. */ QString getEndianness() const; /*! * Gets the parameters in the indirect interface. * - * @return The parameters of the indirect interface. + * @return The parameters of the indirect interface. */ QSharedPointer > > getParameters() const; diff --git a/IPXACTmodels/Component/IndirectInterfaceReader.h b/IPXACTmodels/Component/IndirectInterfaceReader.h index 7b3d69b4b..f6b01896e 100644 --- a/IPXACTmodels/Component/IndirectInterfaceReader.h +++ b/IPXACTmodels/Component/IndirectInterfaceReader.h @@ -26,9 +26,9 @@ namespace IndirectInterfaceReader /*! * Creates an indirect interface definition from an XML description. * - * @param [in] interfaceNode The XML node describing the interface. + * @param [in] interfaceNode The XML node describing the interface. * - * @return The created indirect interface. + * @return The created indirect interface. */ IPXACTMODELS_EXPORT QSharedPointer createIndirectInterfaceFrom(QDomNode const& interfaceNode, Document::Revision docRevision); @@ -38,16 +38,16 @@ namespace IndirectInterfaceReader /*! * Reads the attributes from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the attributes into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the attributes into. */ void parseAttributes(QDomNode const& interfaceNode, QSharedPointer indirectInterface); /*! * Reads the indirect address and data from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the address and data into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the address and data into. */ void parseIndirectAddressAndData(QDomNode const& interfaceNode, QSharedPointer indirectInterface); @@ -55,16 +55,16 @@ namespace IndirectInterfaceReader /*! * Reads the memory map reference from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the memory map reference into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the memory map reference into. */ void parseMemoryMapRef(QDomNode const& interfaceNode, QSharedPointer indirectInterface); /*! * Reads the transparent bridges from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the transparent bridges into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the transparent bridges into. */ void parseTransparentBridges(QDomNode const& interfaceNode, QSharedPointer indirectInterface, Document::Revision docRevision); @@ -72,24 +72,24 @@ namespace IndirectInterfaceReader /*! * Reads the endianness from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the endianness into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the endianness into. */ void parseEndianness(QDomNode const& interfaceNode, QSharedPointer indirectInterface); /*! * Reads the bits in lau element from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the bits in lau info into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the bits in lau info into. */ void parseBitsInLau(QDomNode const& interfaceNode, QSharedPointer indirectInterface); /*! * Reads the parameters from XML to an indirect interface. * - * @param [in] interfaceNode The XML description of the indirect interface. - * @param [in/out] indirectInterface The indirect interface to insert the parameters into. + * @param [in] interfaceNode The XML description of the indirect interface. + * @param [in/out] indirectInterface The indirect interface to insert the parameters into. */ void parseParameters(QDomNode const& interfaceNode, QSharedPointer indirectInterface, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/IndirectInterfaceWriter.h b/IPXACTmodels/Component/IndirectInterfaceWriter.h index bf1daa83d..5232e76df 100644 --- a/IPXACTmodels/Component/IndirectInterfaceWriter.h +++ b/IPXACTmodels/Component/IndirectInterfaceWriter.h @@ -30,9 +30,9 @@ namespace IndirectInterfaceWriter /*! * Write the name group of the indirect interface. * - * @param [in] writer The used XML writer. - * @param [in] indirectInterface The indirect interface being written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] indirectInterface The indirect interface being written. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT void writeIndirectInterface(QXmlStreamWriter& writer, QSharedPointer indirectInterface, Document::Revision docRevision) ; @@ -42,17 +42,17 @@ namespace IndirectInterfaceWriter /*! * Write the indirect address and data fields of the indirect interface. * - * @param [in] writer The used XML writer. - * @param [in] indirectInterface The indirect interface being written. + * @param [in] writer The used XML writer. + * @param [in] indirectInterface The indirect interface being written. */ void writeIndirectFields(QXmlStreamWriter& writer, QSharedPointer indirectInterface); /*! * Write the transparent bridges of the indirect interface. * - * @param [in] writer The used XML writer. - * @param [in] indirectInterface The indirect interface being written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] indirectInterface The indirect interface being written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeTransparentBridges(QXmlStreamWriter& writer, QSharedPointer indirectInterface, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/InitiatorInterface.h b/IPXACTmodels/Component/InitiatorInterface.h index 0375296a3..e0643c9b7 100644 --- a/IPXACTmodels/Component/InitiatorInterface.h +++ b/IPXACTmodels/Component/InitiatorInterface.h @@ -41,39 +41,39 @@ class IPXACTMODELS_EXPORT InitiatorInterface: public Extendable /*! Set the address space reference. * - * @param [in] addressSpaceRef The name of the address space to reference. + * @param [in] addressSpaceRef The name of the address space to reference. */ void setAddressSpaceRef(QString const& addressSpaceRef); /*! Get the address space reference. * - * @return QString containing the address space name + * @return QString containing the address space name */ QString getAddressSpaceRef() const; /*! * Set the presence value. * - * @param [in] newIsPresent The new isPresent value. + * @param [in] newIsPresent The new isPresent value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the presence. * - * @return The isPresent value. + * @return The isPresent value. */ QString getIsPresent() const; /*! Set the base address. * - * @param [in] baseAddress The base address to set. + * @param [in] baseAddress The base address to set. */ void setBaseAddress(QString const& baseAddress); /*! Get the base address. * - * @return The base address for the initiator interface. + * @return The base address for the initiator interface. */ QString getBaseAddress() const; diff --git a/IPXACTmodels/Component/InstantiationsReader.h b/IPXACTmodels/Component/InstantiationsReader.h index e18db4137..3f898af22 100644 --- a/IPXACTmodels/Component/InstantiationsReader.h +++ b/IPXACTmodels/Component/InstantiationsReader.h @@ -31,19 +31,19 @@ namespace InstantiationsReader /*! * Creates a new design instantiation. * - * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiationNode XML description of the instantiation. * - * @return Pointer to the created design instantiation. + * @return Pointer to the created design instantiation. */ IPXACTMODELS_EXPORT QSharedPointer createDesignInstantiationFrom(QDomNode const& instantiationNode); /*! * Creates a new design configuration instantiation. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] docRevision The IP-XACT standard revision to comply to. * - * @return The created design configuration instantiation. + * @return The created design configuration instantiation. */ IPXACTMODELS_EXPORT QSharedPointer createDesignConfigurationInstantiationFrom (QDomNode const& instantiationNode, Document::Revision docRevision); @@ -51,10 +51,10 @@ namespace InstantiationsReader /*! * Creates a new component instantiation. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] docRevision The IP-XACT standard to comply to. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] docRevision The IP-XACT standard to comply to. * - * @return The created component instantiation. + * @return The created component instantiation. */ IPXACTMODELS_EXPORT QSharedPointer createComponentInstantiationFrom(QDomNode const& instantiationNode, Document::Revision docRevision); @@ -64,26 +64,26 @@ namespace InstantiationsReader /*! * Get the used HDL from XML. * - * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiationNode XML description of the instantiation. * - * @return The used HDL. + * @return The used HDL. */ QString parseLanguageFrom(QDomNode const& instantiationNode); /*! * Get the strictness of the used HDL from XML. * - * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiationNode XML description of the instantiation. * - * @return True, if the language shall be strictly enforced, false otherwise. + * @return True, if the language shall be strictly enforced, false otherwise. */ bool parseLanguageStrictnessFrom(QDomNode const& instantiationNode); /*! * Reads the name references from XML. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] instantiation The selected instantiation. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiation The selected instantiation. */ void parseNameReferences(QDomNode const& instantiationNode, QSharedPointer instantiation); @@ -91,9 +91,9 @@ namespace InstantiationsReader /*! * Reads the module parameter from XML. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] instantiation The selected instantiation. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiation The selected instantiation. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseModuleParameters(QDomNode const& instantiationNode, QSharedPointer instantiation, Document::Revision docRevision); @@ -101,9 +101,9 @@ namespace InstantiationsReader /*! * Reads the default file builders from XML. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] instantiation The selected instantiation. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiation The selected instantiation. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseDefaultFileBuilders(QDomNode const& instantiationNode, QSharedPointer instantiation, @@ -112,9 +112,9 @@ namespace InstantiationsReader /*! * Reads the file set references from XLM. * - * @param [in] instantiationNode XML description of the instantiation. - * @param [in] instantiation The selected instantiation. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] instantiationNode XML description of the instantiation. + * @param [in] instantiation The selected instantiation. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseFileSetReferences(QDomNode const& instantiationNode, QSharedPointer instantiation, diff --git a/IPXACTmodels/Component/InstantiationsWriter.h b/IPXACTmodels/Component/InstantiationsWriter.h index efc5d48d8..a2408b0eb 100644 --- a/IPXACTmodels/Component/InstantiationsWriter.h +++ b/IPXACTmodels/Component/InstantiationsWriter.h @@ -30,9 +30,9 @@ namespace InstantiationsWriter /*! * Write a design instantiation to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] instantiation The instantiation to be written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] instantiation The instantiation to be written. + * @param [in] docRevision The IP-XACT standard revision in use. */ IPXACTMODELS_EXPORT void writeDesignInstantiation(QXmlStreamWriter& writer, QSharedPointer instantiation, Document::Revision docRevision); @@ -40,9 +40,9 @@ namespace InstantiationsWriter /*! * Write a design configuration instantiation to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] instantiation The instantiation to be written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] instantiation The instantiation to be written. + * @param [in] docRevision The IP-XACT standard revision in use. */ IPXACTMODELS_EXPORT void writeDesignConfigurationInstantiation(QXmlStreamWriter& writer, QSharedPointer instantiation, Document::Revision docRevision); @@ -50,9 +50,9 @@ namespace InstantiationsWriter /*! * Writes a component instantiation to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] instantiation The instantiation to be written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] instantiation The instantiation to be written. + * @param [in] docRevision The IP-XACT standard revision in use. */ IPXACTMODELS_EXPORT void writeComponentInstantiation(QXmlStreamWriter& writer, QSharedPointer instantiation, Document::Revision docRevision); @@ -63,9 +63,9 @@ namespace InstantiationsWriter /*! * Write a reference to an IP-XACT item. * - * @param [in] writer The used XML writer. - * @param [in] reference The referenced item. - * @param [in] elementName The name of the reference containing element. + * @param [in] writer The used XML writer. + * @param [in] reference The referenced item. + * @param [in] elementName The name of the reference containing element. */ void writeReference(QXmlStreamWriter& writer, QSharedPointer reference, QString const& elementName); @@ -73,26 +73,26 @@ namespace InstantiationsWriter /*! * Write the language. * - * @param [in] writer The used XML writer. - * @param [in] language The language to be written. - * @param [in] languageStrictness Strictness of the language. + * @param [in] writer The used XML writer. + * @param [in] language The language to be written. + * @param [in] languageStrictness Strictness of the language. */ void writeLanguage(QXmlStreamWriter& writer, QString const& language, bool languageStrictness); /*! * Writes the name references of an instantiation. * - * @param [in] writer The used XML writer. - * @param [in] instantiation The containing instantiation. + * @param [in] writer The used XML writer. + * @param [in] instantiation The containing instantiation. */ void writeNameReferences(QXmlStreamWriter& writer, QSharedPointer instantiation); /*! * Writes the module parameters of an instantiation. * - * @param [in] writer The used XML writer. - * @param [in] moduleParameters The module parameters to be written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] moduleParameters The module parameters to be written. + * @param [in] docRevision The IP-XACT standard revision in use. */ void writeModuleParameters(QXmlStreamWriter& writer, QSharedPointer > > moduleParameters, @@ -101,8 +101,8 @@ namespace InstantiationsWriter /*! * Writes the default file builders. * - * @param [in] writer The used XML writer. - * @param [in] defautlFileBuilders The file builders to be written. + * @param [in] writer The used XML writer. + * @param [in] defautlFileBuilders The file builders to be written. */ void writeDefaultFileBuilders(QXmlStreamWriter& writer, QSharedPointer > > defautlFileBuilders, @@ -111,9 +111,9 @@ namespace InstantiationsWriter /*! * Writes the file set references. * - * @param [in] writer The used XML writer. - * @param [in] instantiation The instantiation whose file set refs are written. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] instantiation The instantiation whose file set refs are written. + * @param [in] docRevision The IP-XACT standard revision in use. */ void writeFileSetReferences(QXmlStreamWriter& writer, QSharedPointer instantiation, Document::Revision docRevision); } diff --git a/IPXACTmodels/Component/LanguageTools.h b/IPXACTmodels/Component/LanguageTools.h index 681d1bab7..3da517b07 100644 --- a/IPXACTmodels/Component/LanguageTools.h +++ b/IPXACTmodels/Component/LanguageTools.h @@ -60,56 +60,56 @@ class IPXACTMODELS_EXPORT LanguageTools : public NameGroup, public Extendable /*! * Create a copy of the language tools. * - * @return A copy of the language tools object. + * @return A copy of the language tools object. */ QSharedPointer clone() const; /*! * Get the file builders. * - * @return A pointer to a list containing the file builders. + * @return A pointer to a list containing the file builders. */ QSharedPointer > > getFileBuilders() const; /*! * Set the file builders. * - * @param [in] newFileBuilders The new file builders. + * @param [in] newFileBuilders The new file builders. */ void setFileBuilders(QSharedPointer > > newDefaultFileBuilders); /*! * Get the linker defined in the language tools. * - * @return The linker in the language tools. + * @return The linker in the language tools. */ QString getLinker() const; /*! * Set the linker in the language tools. * - * @param [in] linker The linker to set. + * @param [in] linker The linker to set. */ void setLinker(QString const& linker); /*! * Get the linker flags defined in the language tools. * - * @return The linker glags in the language tools. + * @return The linker glags in the language tools. */ QString getLinkerFlags() const; /*! * Set the linker flags in the language tools. * - * @param [in] linker The linker flags to set. + * @param [in] linker The linker flags to set. */ void setLinkerFlags(QString const& flags); /*! * Get the linker command file defined in the language tools. * - * @return The linker command file. + * @return The linker command file. */ QSharedPointer getLinkerCommandFile() const; diff --git a/IPXACTmodels/Component/MemoryArray.h b/IPXACTmodels/Component/MemoryArray.h index 48522c895..01d8335ec 100644 --- a/IPXACTmodels/Component/MemoryArray.h +++ b/IPXACTmodels/Component/MemoryArray.h @@ -54,7 +54,7 @@ class IPXACTMODELS_EXPORT MemoryArray /*! * Set the dimensions of the array. * - * @param [in] dimensions The dimensions to set. + * @param [in] dimensions The dimensions to set. * */ void setDimensions(QSharedPointer > > dimensions); @@ -69,7 +69,7 @@ class IPXACTMODELS_EXPORT MemoryArray /*! * Set the array stride or bitStride, if in a field element. * - * @param [in] stride Description + * @param [in] stride Description */ void setStride(QString const& stride); diff --git a/IPXACTmodels/Component/MemoryArrayReader.h b/IPXACTmodels/Component/MemoryArrayReader.h index e7d97ad48..3b8fbb49c 100644 --- a/IPXACTmodels/Component/MemoryArrayReader.h +++ b/IPXACTmodels/Component/MemoryArrayReader.h @@ -29,9 +29,9 @@ namespace MemoryArrayReader /*! * Creates a new memory array from a given memory array node. * - * @param [in] arrayNode XML description of the memory array. - * @param [in] docRevision The IP-XACT standard revision to comply to. - * @param [in] isField Flag indicating if array is within a field element. + * @param [in] arrayNode XML description of the memory array. + * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] isField Flag indicating if array is within a field element. * * @return The created memory array. */ @@ -43,18 +43,18 @@ namespace MemoryArrayReader /*! * Parse the array dimensions. * - * @param [in] arrayNode XML description of the memory array. - * @param [in] newArray The new memory array. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] arrayNode XML description of the memory array. + * @param [in] newArray The new memory array. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseDimensions(QDomNode const& arrayNode, QSharedPointer newArray, Document::Revision docRevision); /*! * Parse the array stride. * - * @param [in] arrayNode XML description of the memory array. - * @param [in] newArray The new memory array. - * @param [in] isField Flag indicating if array is within a field element. + * @param [in] arrayNode XML description of the memory array. + * @param [in] newArray The new memory array. + * @param [in] isField Flag indicating if array is within a field element. */ void parseStride(QDomNode const& arrayNode, QSharedPointer newArray, bool isField); } diff --git a/IPXACTmodels/Component/MemoryArrayWriter.h b/IPXACTmodels/Component/MemoryArrayWriter.h index 581c3bc1c..258eda7e1 100644 --- a/IPXACTmodels/Component/MemoryArrayWriter.h +++ b/IPXACTmodels/Component/MemoryArrayWriter.h @@ -29,10 +29,10 @@ namespace MemoryArrayWriter /*! * Write a memory array to XML. * - * @param [in] writer The XML writer to use. - * @param [in] memoryArray The memory array to write. - * @param [in] docRevision The IP-XACT standard revision to comply to. - * @param [in] isField Flag indicating if the array is within a field. + * @param [in] writer The XML writer to use. + * @param [in] memoryArray The memory array to write. + * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] isField Flag indicating if the array is within a field. */ IPXACTMODELS_EXPORT void writeMemoryArray(QXmlStreamWriter& writer, QSharedPointer memoryArray, Document::Revision docRevision, bool isField); @@ -42,18 +42,18 @@ namespace MemoryArrayWriter /*! * Write the array dimensions. * - * @param [in] writer The XML writer to use. - * @param [in] memoryArray The memory array whose dimensions are written. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] writer The XML writer to use. + * @param [in] memoryArray The memory array whose dimensions are written. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void writeDimensions(QXmlStreamWriter& writer, QSharedPointer memoryArray, Document::Revision docRevision); /*! * Write the stride or bitStride of the memory array. * - * @param [in] writer The XML writer to use. - * @param [in] memoryArray The memory array to write. - * @param [in] isField Indicates whether the memory array is within a field or not. + * @param [in] writer The XML writer to use. + * @param [in] memoryArray The memory array to write. + * @param [in] isField Indicates whether the memory array is within a field or not. * Write bitStride to XML if true, otherwise write stride. */ void writeStride(QXmlStreamWriter& writer, QSharedPointer memoryArray, bool isField); diff --git a/IPXACTmodels/Component/MemoryBlockBase.h b/IPXACTmodels/Component/MemoryBlockBase.h index cfd1964bc..0508766c4 100644 --- a/IPXACTmodels/Component/MemoryBlockBase.h +++ b/IPXACTmodels/Component/MemoryBlockBase.h @@ -36,8 +36,8 @@ class IPXACTMODELS_EXPORT MemoryBlockBase : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the memory block. - * @param [in] baseAddress Base address of the memory block. + * @param [in] name Name of the memory block. + * @param [in] baseAddress Base address of the memory block. */ MemoryBlockBase(QString const& name = QString(), QString const& baseAddress = QString()); @@ -53,49 +53,49 @@ class IPXACTMODELS_EXPORT MemoryBlockBase : public NameGroup, public Extendable /*! * Clone this memory map item and return pointer to the copy. * - * @return Pointer to the cloned memory map item. + * @return Pointer to the cloned memory map item. */ virtual QSharedPointer clone() const = 0; /*! * Get the presence of the memory block. * - * @return The isPresent value. + * @return The isPresent value. */ QString getIsPresent() const; /*! * Set the presence of the memory block. * - * @param [in] newIsPresent The new isPresent value. + * @param [in] newIsPresent The new isPresent value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the base address of the block. * - * @return The base address + * @return The base address */ QString getBaseAddress() const; /*! * Set base address for the block. * - * @param [in} baseAddress The new base address + * @param [in} baseAddress The new base address */ virtual void setBaseAddress(QString const& baseAddress); /*! * Get the contained parameters. * - * @return Pointer to a list containing the parameters. + * @return Pointer to a list containing the parameters. */ QSharedPointer > > getParameters() const; /*! * Set the parameters. * - * @param [in] newParameters Pointer to a list containing the new parameters. + * @param [in] newParameters Pointer to a list containing the new parameters. */ void setParameters(QSharedPointer > > newParameters); @@ -104,7 +104,7 @@ class IPXACTMODELS_EXPORT MemoryBlockBase : public NameGroup, public Extendable /*! * Copy the parameters. * - * @param [in] other The memory block being copied. + * @param [in] other The memory block being copied. */ void copyParameters(const MemoryBlockBase& other); diff --git a/IPXACTmodels/Component/MemoryBlockBaseReader.h b/IPXACTmodels/Component/MemoryBlockBaseReader.h index bce4aca87..9b9496c10 100644 --- a/IPXACTmodels/Component/MemoryBlockBaseReader.h +++ b/IPXACTmodels/Component/MemoryBlockBaseReader.h @@ -29,32 +29,32 @@ namespace MemoryBlockBaseReader /*! * Reads the name group. * - * @param [in] memoryBlockNode XML description of the memory block. - * @param [in] newMemoryBlock The new memory block. + * @param [in] memoryBlockNode XML description of the memory block. + * @param [in] newMemoryBlock The new memory block. */ IPXACTMODELS_EXPORT void parseNameGroup(QDomNode const& memoryBlockNode, QSharedPointer newMemoryBlock); /*! * Reads the presence. * - * @param [in] memoryBlockNode XML description of the memory block. - * @param [in] newMemoryBlock The new memory block. + * @param [in] memoryBlockNode XML description of the memory block. + * @param [in] newMemoryBlock The new memory block. */ IPXACTMODELS_EXPORT void parsePresence(QDomNode const& memoryBlockNode, QSharedPointer newMemoryBlock); /*! * Reads the base address. * - * @param [in] memoryBlockNode XML description of the memory block. - * @param [in] newMemoryBlock The new memory block. + * @param [in] memoryBlockNode XML description of the memory block. + * @param [in] newMemoryBlock The new memory block. */ IPXACTMODELS_EXPORT void parseBaseAddress(QDomNode const& memoryBlockNode, QSharedPointer newMemoryBlock); /*! * Reads the parameters. * - * @param [in] memoryBlockNode XML description of the memory block. - * @param [in] newMemoryBlock The new memory block. + * @param [in] memoryBlockNode XML description of the memory block. + * @param [in] newMemoryBlock The new memory block. */ IPXACTMODELS_EXPORT void parseParameters(QDomNode const& addressBlockNode, QSharedPointer newMemoryBlock, Document::Revision docRevision); } diff --git a/IPXACTmodels/Component/MemoryBlockBaseWriter.h b/IPXACTmodels/Component/MemoryBlockBaseWriter.h index 90731419f..667406baf 100644 --- a/IPXACTmodels/Component/MemoryBlockBaseWriter.h +++ b/IPXACTmodels/Component/MemoryBlockBaseWriter.h @@ -29,8 +29,8 @@ namespace MemoryBlockBaseWriter /*! * Write the name group. * - * @param [in] writer Used XML writer. - * @param [in] memoryBlock Selected memory block. + * @param [in] writer Used XML writer. + * @param [in] memoryBlock Selected memory block. */ IPXACTMODELS_EXPORT void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer memoryBlock, Document::Revision docRevision); @@ -38,8 +38,8 @@ namespace MemoryBlockBaseWriter /*! * Write the base address. * - * @param [in] writer Used XML writer. - * @param [in] memoryBlock Selected memory block. + * @param [in] writer Used XML writer. + * @param [in] memoryBlock Selected memory block. */ IPXACTMODELS_EXPORT void writeBaseAddress(QXmlStreamWriter& writer, QSharedPointer memoryBlock); }; diff --git a/IPXACTmodels/Component/MemoryMap.h b/IPXACTmodels/Component/MemoryMap.h index a9bb1f6dc..5e42fff96 100644 --- a/IPXACTmodels/Component/MemoryMap.h +++ b/IPXACTmodels/Component/MemoryMap.h @@ -40,14 +40,14 @@ class IPXACTMODELS_EXPORT MemoryMap : public MemoryMapBase /*! * Copy constructor. * - * @param [in] other The memory map to be copied. + * @param [in] other The memory map to be copied. */ MemoryMap(const MemoryMap& other); /*! * Assignment operator. * - * @param [in] other The memory map being assigned. + * @param [in] other The memory map being assigned. */ MemoryMap& operator=(const MemoryMap& other); @@ -59,44 +59,44 @@ class IPXACTMODELS_EXPORT MemoryMap : public MemoryMapBase /*! * Get a pointer to the list containing the memory remaps of this memory map. * - * @return Pointer to the list containing the memory remaps of this memory map. + * @return Pointer to the list containing the memory remaps of this memory map. */ QSharedPointer > > getMemoryRemaps() const; /*! * Set the memory remaps. * - * @param [in] newMemoryRemaps Pointer to a list containing the new memory remaps. + * @param [in] newMemoryRemaps Pointer to a list containing the new memory remaps. */ void setMemoryRemaps(QSharedPointer > > newMemoryRemaps); /*! * Get the address unit bits value. * - * @param [in] defaultIfEmpty Flag for returning the default AUB value (8 bits) if AUB is empty. + * @param [in] defaultIfEmpty Flag for returning the default AUB value (8 bits) if AUB is empty. * - * @return The address unit bit value. + * @return The address unit bit value. */ QString getAddressUnitBits(bool defaultIfEmpty = true) const; /*! * Set the address unit bits for this memory map. * - * @param [in] newAddressUnitBits Value to be set. + * @param [in] newAddressUnitBits Value to be set. */ void setAddressUnitBits(QString const& newAddressUnitBits); /*! * Get the shared value. * - * @return The shared value. + * @return The shared value. */ QString getShared() const; /*! * Set the shared value. * - * @param [in] newSharedStatus The new shared value. + * @param [in] newSharedStatus The new shared value. */ void setShared(bool newSharedStatus); @@ -115,7 +115,7 @@ class IPXACTMODELS_EXPORT MemoryMap : public MemoryMapBase /*! * Set the memory map definition reference. * - * @param [in] newDefinitionRef The new definition reference. + * @param [in] newDefinitionRef The new definition reference. */ void setMemoryMapDefinitionReference(QString const& newDefinitionRef); @@ -130,7 +130,7 @@ class IPXACTMODELS_EXPORT MemoryMap : public MemoryMapBase /*! * Set the type definitions reference for this memory remap * - * @param [in] newTypeDefinitionsRef The type definitions reference to set. + * @param [in] newTypeDefinitionsRef The type definitions reference to set. */ void setTypeDefinitionsReference(QString const& newTypeDefinitionsRef); @@ -139,7 +139,7 @@ class IPXACTMODELS_EXPORT MemoryMap : public MemoryMapBase /*! * Copy the memory remaps. * - * @param [in] other The memory map being copied. + * @param [in] other The memory map being copied. */ void copyMemoryRemaps(const MemoryMap& other); diff --git a/IPXACTmodels/Component/MemoryMapBase.h b/IPXACTmodels/Component/MemoryMapBase.h index 28359435a..a2fa9754a 100644 --- a/IPXACTmodels/Component/MemoryMapBase.h +++ b/IPXACTmodels/Component/MemoryMapBase.h @@ -33,21 +33,21 @@ class IPXACTMODELS_EXPORT MemoryMapBase : public NameGroup, public Extendable /*! * [Description]. * - * @param [in] name Name of the memory map base. + * @param [in] name Name of the memory map base. */ MemoryMapBase(QString const& name = QString()); /*! * Copy constructor. * - * @param [in] other The abstract memory map to be copied. + * @param [in] other The abstract memory map to be copied. */ MemoryMapBase(const MemoryMapBase& other); /*! * Assignment operator. * - * @param [in] other The abstract memory map to be assigned. + * @param [in] other The abstract memory map to be assigned. */ MemoryMapBase &operator=(const MemoryMapBase& other); @@ -59,49 +59,49 @@ class IPXACTMODELS_EXPORT MemoryMapBase : public NameGroup, public Extendable /*! * Get the element name of the memory map. * - * @return Memory map for default memory maps. + * @return Memory map for default memory maps. */ virtual QString elementName() const; /*! * Get the isPresent value. * - * @return The isPresent value. + * @return The isPresent value. */ QString getIsPresent() const; /*! * Set the value for the isPresent. * - * @param [in] newIsPresent The new IsPresent value. + * @param [in] newIsPresent The new IsPresent value. */ void setIsPresent(QString const& newIsPresent); /*! * Get a list of the contained memory map blocks. * - * @return Pointer to a list containing the memory blocks stored in this instance. + * @return Pointer to a list containing the memory blocks stored in this instance. */ QSharedPointer > > getMemoryBlocks() const; /*! * Set the memory map blocks for this memory map. * - * @param [in] newItems A Pointer to a list containing the blocks to be stored in this memory map. + * @param [in] newItems A Pointer to a list containing the blocks to be stored in this memory map. */ void setMemoryBlocks(QSharedPointer > > newMemoryBlocks); /*! * Check if the memory map contains any sub items. * - * @return True, if the memory map contains sub items, false otherwise. + * @return True, if the memory map contains sub items, false otherwise. */ bool hasMemoryBlocks() const; /*! * Check if the memory map contains any subspace maps. * - * @return True, if the memory map contains subspace items, false otherwise. + * @return True, if the memory map contains subspace items, false otherwise. */ bool hasSubSpaceMaps() const; @@ -110,7 +110,7 @@ class IPXACTMODELS_EXPORT MemoryMapBase : public NameGroup, public Extendable /*! * Copy the contained memory blocks. * - * @param [in] other The memory map base being copied. + * @param [in] other The memory map base being copied. */ void copyMemoryBlocks(const MemoryMapBase& other); diff --git a/IPXACTmodels/Component/MemoryMapBaseReader.h b/IPXACTmodels/Component/MemoryMapBaseReader.h index cfe310742..d56425a7f 100644 --- a/IPXACTmodels/Component/MemoryMapBaseReader.h +++ b/IPXACTmodels/Component/MemoryMapBaseReader.h @@ -31,9 +31,9 @@ namespace MemoryMapBaseReader /*! * Creates a new memory map from a given memory map node. * - * @param [in] MemoryMapBaseNode XML description of the memory map. + * @param [in] MemoryMapBaseNode XML description of the memory map. * - * @return The created memory map. + * @return The created memory map. */ IPXACTMODELS_EXPORT void readMemoryMapBase(QDomNode const& MemoryMapBaseNode, QSharedPointer newMemoryMapBase, Document::Revision docRevision); @@ -43,24 +43,24 @@ namespace MemoryMapBaseReader /*! * Reads the name group. * - * @param [in] MemoryMapBaseBaseNode XML description of the memory map base. - * @param [in] newMemoryMapBaseBase The new memory map base item. + * @param [in] MemoryMapBaseBaseNode XML description of the memory map base. + * @param [in] newMemoryMapBaseBase The new memory map base item. */ void parseNameGroup(QDomNode const& MemoryMapBaseBaseNode, QSharedPointer newMemoryMapBase); /*! * Reads the isPresent value. * - * @param [in] MemoryMapBaseBaseNode XML description of the memory map base. - * @param [in] newMemoryMapBaseBase The new memory map base item. + * @param [in] MemoryMapBaseBaseNode XML description of the memory map base. + * @param [in] newMemoryMapBaseBase The new memory map base item. */ void parsePresence(QDomNode const& MemoryMapBaseBaseNode, QSharedPointer newMemoryMapBase); /*! * Reads the contained memory blocks. * - * @param [in] memoryMapBaseBaseNode XML description of the memory map base. - * @param [in] newMemoryMapBaseBase The new memory map base item. + * @param [in] memoryMapBaseBaseNode XML description of the memory map base. + * @param [in] newMemoryMapBaseBase The new memory map base item. */ void parseMemoryBlocks(QDomNode const& memoryMapBaseNode, QSharedPointer newMemoryMapBase, Document::Revision docRevision); } diff --git a/IPXACTmodels/Component/MemoryMapBaseWriter.h b/IPXACTmodels/Component/MemoryMapBaseWriter.h index 7921667dc..8d1dc66e2 100644 --- a/IPXACTmodels/Component/MemoryMapBaseWriter.h +++ b/IPXACTmodels/Component/MemoryMapBaseWriter.h @@ -30,9 +30,9 @@ namespace MemoryMapBaseWriter /*! * Write a memory map to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] MemoryMapBase The memory map to be written. - * @param [in] docRevision The standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] MemoryMapBase The memory map to be written. + * @param [in] docRevision The standard revision in use. */ IPXACTMODELS_EXPORT void writeMemoryMapBase(QXmlStreamWriter& writer, QSharedPointer MemoryMapBase, Document::Revision docRevision); @@ -43,9 +43,9 @@ namespace MemoryMapBaseWriter /*! * Write the name group. * - * @param [in] writer Used XML writer. - * @param [in] MemoryMapBaseBase The selected memory map base. - * @param [in] docRevision The standard revision in use. + * @param [in] writer Used XML writer. + * @param [in] MemoryMapBaseBase The selected memory map base. + * @param [in] docRevision The standard revision in use. */ void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer MemoryMapBase, Document::Revision docRevision); @@ -53,8 +53,8 @@ namespace MemoryMapBaseWriter /*! * Write the memory blocks. * - * @param [in] writer Used XML writer. - * @param [in] MemoryMapBaseBase The selected memory map base. + * @param [in] writer Used XML writer. + * @param [in] MemoryMapBaseBase The selected memory map base. */ void writeMemoryBlocks(QXmlStreamWriter& writer, QSharedPointer MemoryMapBase, Document::Revision docRevision); } diff --git a/IPXACTmodels/Component/MemoryMapReader.h b/IPXACTmodels/Component/MemoryMapReader.h index 7f01e36c2..5794011fa 100644 --- a/IPXACTmodels/Component/MemoryMapReader.h +++ b/IPXACTmodels/Component/MemoryMapReader.h @@ -31,9 +31,9 @@ namespace MemoryMapReader /*! * Creates a new memory map from a given memory map node. * - * @param [in] memoryMapNode XML description of the memory map. + * @param [in] memoryMapNode XML description of the memory map. * - * @return The created memory map. + * @return The created memory map. */ IPXACTMODELS_EXPORT QSharedPointer createMemoryMapFrom(QDomNode const& memoryMapNode, Document::Revision docRevision); @@ -43,33 +43,33 @@ namespace MemoryMapReader /*! * Reads the memory remaps. * - * @param [in] memoryMapNode XML description of the memory map. - * @param [in] newMemoryMap The new memory map item. + * @param [in] memoryMapNode XML description of the memory map. + * @param [in] newMemoryMap The new memory map item. */ void parseMemoryRemaps(QDomNode const& memoryMapNode, QSharedPointer newMemoryMap, Document::Revision docRevision); /*! * Creates a new memory remap from a given memory remap element. * - * @param [in] memoryRemapElement XML description of the memory remap. + * @param [in] memoryRemapElement XML description of the memory remap. * - * @return Pointer to the created memory remap. + * @return Pointer to the created memory remap. */ QSharedPointer createSingleMemoryRemap(QDomElement const& memoryRemapElement, Document::Revision docRevision); /*! * Reads the address unit bits. * - * @param [in] memoryMapNode XML description of the memory map. - * @param [in] newMemoryMap The new memory map item. + * @param [in] memoryMapNode XML description of the memory map. + * @param [in] newMemoryMap The new memory map item. */ void parseAddressUnitBits(QDomNode const& memoryMapNode, QSharedPointer newMemoryMap); /*! * Reads the shared value. * - * @param [in] memoryMapNode XML description of the memory map. - * @param [in] newMemoryMap The new memory map item. + * @param [in] memoryMapNode XML description of the memory map. + * @param [in] newMemoryMap The new memory map item. */ void parseShared(QDomNode const& memoryMapNode, QSharedPointer newMemoryMap); diff --git a/IPXACTmodels/Component/MemoryMapWriter.h b/IPXACTmodels/Component/MemoryMapWriter.h index 17854869f..a1f5ed55b 100644 --- a/IPXACTmodels/Component/MemoryMapWriter.h +++ b/IPXACTmodels/Component/MemoryMapWriter.h @@ -32,9 +32,9 @@ namespace MemoryMapWriter /*! * Write a memory map to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] memoryMap The memory map to be written. - * @param [in] docRevision The standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] memoryMap The memory map to be written. + * @param [in] docRevision The standard revision in use. */ IPXACTMODELS_EXPORT void writeMemoryMap(QXmlStreamWriter& writer, QSharedPointer memoryMap, Document::Revision docRevision); @@ -44,17 +44,17 @@ namespace MemoryMapWriter /*! * Write the memory remaps. * - * @param [in] writer Used XML writer. - * @param [in] memoryMap The selected memory map. - * @param [in] docRevision The standard revision in use. + * @param [in] writer Used XML writer. + * @param [in] memoryMap The selected memory map. + * @param [in] docRevision The standard revision in use. */ void writeMemoryRemaps(QXmlStreamWriter& writer, QSharedPointer memoryMap, Document::Revision docRevision); /*! * Write the address unit bits. * - * @param [in] writer Used XML writer. - * @param [in] memoryMap The selected memory map. + * @param [in] writer Used XML writer. + * @param [in] memoryMap The selected memory map. */ @@ -63,24 +63,24 @@ namespace MemoryMapWriter /*! * Write the shared value. * - * @param [in] writer Used XML writer. - * @param [in] memoryMap The selected memory map. + * @param [in] writer Used XML writer. + * @param [in] memoryMap The selected memory map. */ void writeShared(QXmlStreamWriter& writer, QSharedPointer memoryMap); /*! * Write the definition reference of the memory map. * - * @param [in] writer Used XML writer. - * @param [in] memoryMap The selected memory map. + * @param [in] writer Used XML writer. + * @param [in] memoryMap The selected memory map. */ void writeMemoryMapDefinitionReference(QXmlStreamWriter& writer, QSharedPointer memoryMap); /*! * Write the definition reference of the memory remap. * - * @param [in] writer Used XML writer. - * @param [in] memoryRemap The selected memory remap. + * @param [in] writer Used XML writer. + * @param [in] memoryRemap The selected memory remap. */ void writeRemapDefinitionReference(QXmlStreamWriter& writer, QSharedPointer memoryRemap); } diff --git a/IPXACTmodels/Component/MemoryRemap.h b/IPXACTmodels/Component/MemoryRemap.h index 494e899cc..5c2428b50 100644 --- a/IPXACTmodels/Component/MemoryRemap.h +++ b/IPXACTmodels/Component/MemoryRemap.h @@ -34,22 +34,22 @@ class IPXACTMODELS_EXPORT MemoryRemap : public MemoryMapBase /*! * The constructor. * - * @param [in] name Name of the memory remap. - * @param [in] remapState The remap state refered by the memory remap. + * @param [in] name Name of the memory remap. + * @param [in] remapState The remap state refered by the memory remap. */ MemoryRemap(QString const& name = QString(), QString const& remapState = QString()); /*! * Copy constructor. * - * @param [in] other The memory remap being copied. + * @param [in] other The memory remap being copied. */ MemoryRemap(const MemoryRemap& other); /*! * Assignment operator. * - * @param [in] other The memory remap being assigned. + * @param [in] other The memory remap being assigned. */ MemoryRemap& operator=(const MemoryRemap& other); @@ -61,21 +61,21 @@ class IPXACTMODELS_EXPORT MemoryRemap : public MemoryMapBase /*! * Get the element name of the memory remap. * - * @return QString containing "Memory remap". + * @return QString containing "Memory remap". */ virtual QString elementName() const; /*! * Get the remap state of the memory remap. * - * @return The name of the remap state of the memory remap. + * @return The name of the remap state of the memory remap. */ QString getRemapState() const; /*! * Set the remap state of the memory remap. * - * @param [in] newRemapState The name of the new remap state of the memory remap. + * @param [in] newRemapState The name of the new remap state of the memory remap. */ void setRemapState(QString newRemapState); @@ -89,7 +89,7 @@ class IPXACTMODELS_EXPORT MemoryRemap : public MemoryMapBase /*! * Set the memory remap definition reference. * - * @param [in] newDefinitionRef The new definition reference. + * @param [in] newDefinitionRef The new definition reference. */ void setMemoryRemapDefinitionReference(QString const& newDefinitionRef); @@ -104,7 +104,7 @@ class IPXACTMODELS_EXPORT MemoryRemap : public MemoryMapBase /*! * Set the type definitions reference for this memory remap * - * @param [in] newTypeDefinitionsRef The type definitions reference to set. + * @param [in] newTypeDefinitionsRef The type definitions reference to set. */ void setTypeDefinitionsReference(QString const& newTypeDefinitionsRef); @@ -118,7 +118,7 @@ class IPXACTMODELS_EXPORT MemoryRemap : public MemoryMapBase /*! * Set the mode references of the remap. * - * @param [in] newModeRefs The mode references to set. + * @param [in] newModeRefs The mode references to set. */ void setModeReferences(QSharedPointer > > newModeRefs); diff --git a/IPXACTmodels/Component/MirroredTargetInterface.h b/IPXACTmodels/Component/MirroredTargetInterface.h index b39349e4c..f7b301ee8 100644 --- a/IPXACTmodels/Component/MirroredTargetInterface.h +++ b/IPXACTmodels/Component/MirroredTargetInterface.h @@ -46,7 +46,7 @@ class IPXACTMODELS_EXPORT MirroredTargetInterface /*! The constructor. * - * @param [in] remapAddress The remap address to set. + * @param [in] remapAddress The remap address to set. */ IPXACTMODELS_EXPORT explicit RemapAddress(QString const& remapAddress); }; @@ -67,27 +67,27 @@ class IPXACTMODELS_EXPORT MirroredTargetInterface /*! Get the range of the mirrored target interface. * - * @return The range. + * @return The range. */ QString getRange() const; /*! Set the range for this mirrored target interface. * - * @param [in] range The range of the mirrored target interface. + * @param [in] range The range of the mirrored target interface. */ void setRange(QString const& range); /*! * Get the remap addresses for the mirrored target interface. * - * @return The remap addresses. + * @return The remap addresses. */ QSharedPointer > > getRemapAddresses() const; /*! * Set the remap address. * - * @param [in] newRemapAddress The new remap address. + * @param [in] newRemapAddress The new remap address. */ void setRemapAddress(QString const& newRemapAddress); diff --git a/IPXACTmodels/Component/Mode.h b/IPXACTmodels/Component/Mode.h index 958ed452c..d8c4e8c31 100644 --- a/IPXACTmodels/Component/Mode.h +++ b/IPXACTmodels/Component/Mode.h @@ -38,7 +38,7 @@ class IPXACTMODELS_EXPORT Mode : public NameGroup, public Extendable /*! * The default constructor. * - * @param [in] name Name of the mode. + * @param [in] name Name of the mode. */ Mode(QString const& name = QString()); @@ -54,21 +54,21 @@ class IPXACTMODELS_EXPORT Mode : public NameGroup, public Extendable /*! * Get the condition expression. * - * @return The condition expression. + * @return The condition expression. */ QString getCondition() const; /*! * Sets the condition expression. * - * @param [in] conditionExpression The expression to set. + * @param [in] conditionExpression The expression to set. */ void setCondition(QString const& conditionExpression); /*! * Get the port slices. * - * @return The port slices. + * @return The port slices. */ PortSlice::List getPortSlices() const; diff --git a/IPXACTmodels/Component/ModeReader.h b/IPXACTmodels/Component/ModeReader.h index d61160e7f..83fc74740 100644 --- a/IPXACTmodels/Component/ModeReader.h +++ b/IPXACTmodels/Component/ModeReader.h @@ -32,9 +32,9 @@ namespace ModeReader /*! * Creates a new mode from a given view node. * - * @param [in] modeNode XML description of the mode. + * @param [in] modeNode XML description of the mode. * - * @return The created mode. + * @return The created mode. */ IPXACTMODELS_EXPORT QSharedPointer createModeFrom(QDomNode const& modeNode); @@ -44,8 +44,8 @@ namespace ModeReader /*! * Parses the mode condition. * - * @param [in] modeNode XML description of the nodet. - * @param [in] newMode The selected mode item. + * @param [in] modeNode XML description of the nodet. + * @param [in] newMode The selected mode item. * */ void parseCondition(QDomNode const& modeNode, QSharedPointer newMode); @@ -53,16 +53,16 @@ namespace ModeReader /*! * Read the remap ports. * - * @param [in] ModeNode XML description of the mode. - * @param [in] newMode The selected mode item. + * @param [in] ModeNode XML description of the mode. + * @param [in] newMode The selected mode item. */ void parsePortSlices(QDomNode const& modeNode, QSharedPointer newMode); /*! * Read the field slices. * - * @param [in] modeNode XML description of the mode. - * @param [in] newMode The selected mode item. + * @param [in] modeNode XML description of the mode. + * @param [in] newMode The selected mode item. */ void parseFieldSlices(QDomNode const& modeNode, QSharedPointer newMode); @@ -70,8 +70,8 @@ namespace ModeReader /*! * Parses range. * - * @param [in] element XML description of the IP-XACT element. - * @param [in] range The range to read to. + * @param [in] element XML description of the IP-XACT element. + * @param [in] range The range to read to. * */ void parseRange(QDomElement const& element, QSharedPointer range); diff --git a/IPXACTmodels/Component/ModeWriter.h b/IPXACTmodels/Component/ModeWriter.h index 8757cfbf5..e26c7ebfb 100644 --- a/IPXACTmodels/Component/ModeWriter.h +++ b/IPXACTmodels/Component/ModeWriter.h @@ -28,8 +28,8 @@ namespace ModeWriter /*! * Write a mode to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The mode to be written. + * @param [in] writer The used xml writer. + * @param [in] view The mode to be written. */ IPXACTMODELS_EXPORT void writeMode(QXmlStreamWriter& writer, QSharedPointer mode); @@ -38,24 +38,24 @@ namespace ModeWriter /*! * Write the mode condition to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The mode whose condition to write. + * @param [in] writer The used xml writer. + * @param [in] view The mode whose condition to write. */ void writeCondition(QXmlStreamWriter& writer, QSharedPointer mode); /*! * Write the mode port slices to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The mode whose port slices to write. + * @param [in] writer The used xml writer. + * @param [in] view The mode whose port slices to write. */ void writePortSlices(QXmlStreamWriter& writer, QSharedPointer mode); /*! * Write the mode field slices to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The mode whose field slices to write. + * @param [in] writer The used xml writer. + * @param [in] view The mode whose field slices to write. */ void writeFieldSlices(QXmlStreamWriter& writer, QSharedPointer mode); } diff --git a/IPXACTmodels/Component/Model.h b/IPXACTmodels/Component/Model.h index bbd2ddb92..d60dc28c4 100644 --- a/IPXACTmodels/Component/Model.h +++ b/IPXACTmodels/Component/Model.h @@ -53,70 +53,70 @@ class IPXACTMODELS_EXPORT Model /*! * Get the views of this model. * - * @return Pointer to a lis containing pointers to the views of this model. + * @return Pointer to a lis containing pointers to the views of this model. */ QSharedPointer > > getViews() const; /*! * Set the views for this model. * - * @param [in] newViews Pointer to a list containing pointers to the views. + * @param [in] newViews Pointer to a list containing pointers to the views. */ void setViews(QSharedPointer > > newViews); /* * Get a component instantiation by name. * - * @return The component instantiation if found, else null. + * @return The component instantiation if found, else null. */ QSharedPointer findComponentInstantiation(QString const& name) const; /*! * Get the component instantiations. * - * @return Pointer to a list containing the component instantiations. + * @return Pointer to a list containing the component instantiations. */ QSharedPointer > > getComponentInstantiations() const; /*! * Set the component instantiations. * - * @param [in] instantiations Pointer to a list containing the new component instantiations. + * @param [in] instantiations Pointer to a list containing the new component instantiations. */ void setComponentInstantiations(QSharedPointer > > instantiations); /* * Get a design instantiation by name. * - * @return The design instantiation if found, else null. + * @return The design instantiation if found, else null. */ QSharedPointer findDesignInstantiation(QString const& name) const; /*! * Get the design instantiations. * - * @return Pointer to a list containing the design instantiations. + * @return Pointer to a list containing the design instantiations. */ QSharedPointer > > getDesignInstantiations() const; /*! * Set the design instantiations. * - * @param [in] instantiations Pointer to a list containing the new design instantiations. + * @param [in] instantiations Pointer to a list containing the new design instantiations. */ void setDesignInstantiations(QSharedPointer > > newInstantiations); /* * Get a design configuration instantiation by name. * - * @return The design configuration instantiation if found, else null. + * @return The design configuration instantiation if found, else null. */ QSharedPointer findDesignConfigurationInstantiation(QString const& name) const; /*! * Get the design configuration instantiations. * - * @return Pointer to a list containing the design configuration instantiations. + * @return Pointer to a list containing the design configuration instantiations. */ QSharedPointer > > getDesignConfigurationInstantiations() const; @@ -124,7 +124,7 @@ class IPXACTMODELS_EXPORT Model /*! * Set the design conifguration instantiations. * - * @param [in] instantiations Pointer to a list containing the new design configuration instantiations. + * @param [in] instantiations Pointer to a list containing the new design configuration instantiations. */ void setDesignConfigurationInstantiations( QSharedPointer > > newInstantiations); @@ -132,130 +132,130 @@ class IPXACTMODELS_EXPORT Model /*! * Get the ports of this model. * - * @return Pointer to a list containing the ports. + * @return Pointer to a list containing the ports. */ QSharedPointer > > getPorts() const; /*! * Set the ports. * - * @param [in] newPorts Pointer to a list containing the new ports. + * @param [in] newPorts Pointer to a list containing the new ports. */ void setPorts(QSharedPointer > > newPorts); /*! * Checks if the model has views. * - * @return bool True if views exist. + * @return bool True if views exist. */ bool hasViews() const; /*! * Get list of the view names in this model. * - * @return QStringList containing the view names. + * @return QStringList containing the view names. */ QStringList getViewNames() const; /*! * Get the hierarchical views of the model. * - * @return QStringList containing the names of the hierarchical views. + * @return QStringList containing the names of the hierarchical views. */ QStringList getHierViews() const; /* * Get the non-hierarchical views of the model. * - * @return QStringList containing the names of the non-hierarchical views. + * @return QStringList containing the names of the non-hierarchical views. */ QStringList getFlatViews() const; /* * Get a view by name. * - * @return The view if found, else null. + * @return The view if found, else null. */ QSharedPointer findView(const QString name) const; /*! * Get the VLNV of a design in model's view. * - * @return A vlnv of a design that is used within this component. Null pointer if design is not found. + * @return A vlnv of a design that is used within this component. Null pointer if design is not found. */ VLNV getHierRef(QString const& viewName = QString()) const; /*! * Get list of the design VLNVs that are referenced within model. * - * @return QList containing pointers to the VLNVs + * @return QList containing pointers to the VLNVs */ QList getHierarchyRefs() const; /*! * Get the specific port of the model. * - * @param [in] name Name of the port. + * @param [in] name Name of the port. * - * @return Pointer to the specified port. + * @return Pointer to the specified port. */ QSharedPointer getPort(const QString& name) const; /*! * Check if the model has a specified port. * - * @param [in] name Name of the port being searched for. + * @param [in] name Name of the port being searched for. * - * @return True, if the port is found, false otherwise. + * @return True, if the port is found, false otherwise. */ bool hasPort(QString const& name) const; /*! * Check if the model has wire ports. * - * @return True, if wire ports are found, false otherwise. + * @return True, if wire ports are found, false otherwise. */ bool hasWires() const; /*! * Check if the model has transactional ports. * - * @return True, if transactional ports are found, false otherwise. + * @return True, if transactional ports are found, false otherwise. */ bool hasTransactionals() const; /*! * Get names of the ports in this model. * - * @return QStringList containing the port names. + * @return QStringList containing the port names. */ QStringList getPortNames() const; /*! * Checks if the model has ports. * - * @return bool True if ports exist. + * @return bool True if ports exist. */ bool hasPorts() const; /*! * Does this model contains a hierarchical view. * - * @return True if a hierarchyRef is found in one of the views, otherwise false. + * @return True if a hierarchyRef is found in one of the views, otherwise false. */ bool hasHierView() const; /*! * Get the references of the views. * - * @return A list of VLNVs referenced by the views. + * @return A list of VLNVs referenced by the views. */ QList getViewReferences() const; /*! * Check if the model has any contents. * - * @return True, if contents are found, false otherwise. + * @return True, if contents are found, false otherwise. */ bool hasContents() const; diff --git a/IPXACTmodels/Component/OtherClockDriver.h b/IPXACTmodels/Component/OtherClockDriver.h index 1b2e2f647..a574970a9 100644 --- a/IPXACTmodels/Component/OtherClockDriver.h +++ b/IPXACTmodels/Component/OtherClockDriver.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT OtherClockDriver /*! * The constructor. * - * @param [in] clockName The name of the clock driver. + * @param [in] clockName The name of the clock driver. */ OtherClockDriver(QString const& clockName = QString()); @@ -49,84 +49,84 @@ class IPXACTMODELS_EXPORT OtherClockDriver /*! * Get the name of the clock. * - * @return QString containing the name + * @return QString containing the name */ QString getClockName() const; /*! * Set the clock name. * - * @param [in] clockName The new name of the clock. + * @param [in] clockName The new name of the clock. */ void setClockName(QString const& clockName); /*! * Get the clock source. * - * @return QString containing the path and name of the clock generation cell. + * @return QString containing the path and name of the clock generation cell. */ QString getClockSource() const; /*! * Set the clock source. * - * @param [in] clockSource QString containing the name and path of the clock generation cell. + * @param [in] clockSource QString containing the name and path of the clock generation cell. */ void setClockSource(QString const& clockSource); /*! * Get the clock period. * - * @return A pointer to the clock period. + * @return A pointer to the clock period. */ QSharedPointer getClockPeriod() const; /*! * Set the clock period. * - * @param [in] clockPeriod A pointer to the new clock period. + * @param [in] clockPeriod A pointer to the new clock period. */ void setClockPeriod(QSharedPointer newClockPeriod); /*! * Get the clock pulse offset. * - * @return Pointer to the clock pulse offset. + * @return Pointer to the clock pulse offset. */ QSharedPointer getClockPulseOffset() const; /*! * Set the clock pulse offset. * - * @param [in] clockPulseOffset Pointer to the new clock pulse offset. + * @param [in] clockPulseOffset Pointer to the new clock pulse offset. */ void setClockPulseOffset(QSharedPointer newClockPulseOffset); /*! * Get the clock pulse value. * - * @return The clock pulse value. + * @return The clock pulse value. */ QString getClockPulseValue() const; /*! * Set the clock pulse value. * - * @param [in] The new clock pulse value. + * @param [in] The new clock pulse value. */ void setClockPulseValue(QString const& newClockPulseValue); /*! * Get the clock pulse duration. * - * @return A pointer to the new clock pulse duration. + * @return A pointer to the new clock pulse duration. */ QSharedPointer getClockPulseDuration() const; /*! * Set the clock pulse duration. * - * @param [in] clockPulseDuration A pointer to the new clock pulse duration. + * @param [in] clockPulseDuration A pointer to the new clock pulse duration. */ void setClockPulseDuration(QSharedPointer newClockPulseDuration); @@ -135,7 +135,7 @@ class IPXACTMODELS_EXPORT OtherClockDriver /*! * Copy the clock data. * - * @param [in] other The other clock driver being copied. + * @param [in] other The other clock driver being copied. */ void copyClockData(const OtherClockDriver &other); diff --git a/IPXACTmodels/Component/OtherClockDriverReader.h b/IPXACTmodels/Component/OtherClockDriverReader.h index c5b48fe2e..2c8923a6f 100644 --- a/IPXACTmodels/Component/OtherClockDriverReader.h +++ b/IPXACTmodels/Component/OtherClockDriverReader.h @@ -29,7 +29,7 @@ class IPXACTMODELS_EXPORT OtherClockDriverReader /*! * Creates a new OtherClockDriver from a given OtherClockDriver node. * - * @param [in] OtherClockDriverNode XML description of the OtherClockDriver. + * @param [in] OtherClockDriverNode XML description of the OtherClockDriver. */ QSharedPointer createOtherClockDriverFrom(QDomNode const& otherClockDriverNode) const; @@ -38,8 +38,8 @@ class IPXACTMODELS_EXPORT OtherClockDriverReader /*! * Parse the clock driver attributes. * - * @param [in] otherClockDriverNode XML description of the other clock driver. - * @param [in] newOtherClockDriver The new other clock driver. + * @param [in] otherClockDriverNode XML description of the other clock driver. + * @param [in] newOtherClockDriver The new other clock driver. */ void parseClockDriverAttributes(QDomNode const& otherClockDriverNode, QSharedPointer newOtherClockDriver) const; @@ -47,16 +47,16 @@ class IPXACTMODELS_EXPORT OtherClockDriverReader /*! * Parse a clock unit. * - * @param [in] otherClockDriverNode XML description of the other clock driver. - * @param [in] elementName The name of the clock unit element. + * @param [in] otherClockDriverNode XML description of the other clock driver. + * @param [in] elementName The name of the clock unit element. */ QSharedPointer parseClockUnit(QDomNode const& otherClockDriverNode, QString const& elementName) const; /*! * Parse the clock pulse value. * - * @param [in] otherClockDriverNode XML description of the other clock driver. - * @param [in] newOtherClockDriver The new other clock driver. + * @param [in] otherClockDriverNode XML description of the other clock driver. + * @param [in] newOtherClockDriver The new other clock driver. */ void parseClockPulseValue(QDomNode const& otherClockDriverNode, QSharedPointer newOtherClockDriver) const; diff --git a/IPXACTmodels/Component/OtherClockDriverWriter.h b/IPXACTmodels/Component/OtherClockDriverWriter.h index 4462abf66..d857e5c2f 100644 --- a/IPXACTmodels/Component/OtherClockDriverWriter.h +++ b/IPXACTmodels/Component/OtherClockDriverWriter.h @@ -31,8 +31,8 @@ class IPXACTMODELS_EXPORT OtherClockDriverWriter /*! * Write a OtherClockDriver to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] OtherClockDriver The OtherClockDriver to be written. + * @param [in] writer The used xml writer. + * @param [in] OtherClockDriver The OtherClockDriver to be written. */ void writeOtherClockDriver(QXmlStreamWriter& writer, QSharedPointer otherClockDriver) const; @@ -41,17 +41,17 @@ class IPXACTMODELS_EXPORT OtherClockDriverWriter /*! * Write the other clock driver attributes. * - * @param [in] writer The used XML writer. - * @param [in] otherClockDriver The new other clock driver. + * @param [in] writer The used XML writer. + * @param [in] otherClockDriver The new other clock driver. */ void writeClockDriverAttributes(QXmlStreamWriter& writer, QSharedPointer otherClockDriver) const; /*! * Write a clock unit. * - * @param [in] writer The used XML writer. - * @param [in] clockUnit The new other clock driver. - * @param [in] elementName The name of the element being written. + * @param [in] writer The used XML writer. + * @param [in] clockUnit The new other clock driver. + * @param [in] elementName The name of the element being written. */ void writeClockUnit(QXmlStreamWriter& writer, QSharedPointer clockUnit, QString const& elementName) const; diff --git a/IPXACTmodels/Component/Port.h b/IPXACTmodels/Component/Port.h index 98cf3ae9b..1b9c03cf7 100644 --- a/IPXACTmodels/Component/Port.h +++ b/IPXACTmodels/Component/Port.h @@ -42,7 +42,7 @@ class IPXACTMODELS_EXPORT Port : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] portName Name of the port. + * @param [in] portName Name of the port. */ explicit Port(QString const& portName = QString()); @@ -64,175 +64,175 @@ class IPXACTMODELS_EXPORT Port : public NameGroup, public Extendable /*! * Get a pointer to the wire element. * - * @return A pointer to the wire instance. + * @return A pointer to the wire instance. */ QSharedPointer getWire() const; /*! * Set the wire element for the port. * - * @param [in] newWire The new wire element. + * @param [in] newWire The new wire element. */ void setWire(QSharedPointer newWire); /*! * Get a pointer to the transactional element. * - * @return Pointer to the transactional element. + * @return Pointer to the transactional element. */ QSharedPointer getTransactional() const; /*! * Set the transactional element for the port. * - * @param [in] newTransactional The new transactional element. + * @param [in] newTransactional The new transactional element. */ void setTransactional(QSharedPointer newTransactional); /*! * Get the structured element. * - * @return The structured element. + * @return The structured element. */ QSharedPointer getStructured() const; /*! * Set the structured element for the port. * - * @param [in] newStructural The new structural element. + * @param [in] newStructural The new structural element. */ void setStructured(QSharedPointer newStructured); /*! * Get the left bound of a vectored port. * - * @return the left bound of the port. + * @return the left bound of the port. */ QString getLeftBound() const; /*! * Set the left bound of the port. * - * @param [in] newLeftBound The new left bound of the port. + * @param [in] newLeftBound The new left bound of the port. */ void setLeftBound(QString const& newLeftBound); /*! * Get the right bound of a vectored port. * - * @return The right bound of the port. + * @return The right bound of the port. */ QString getRightBound() const; /*! * Set the right bound of the port. * - * @param [in] newRightBound The new right bound of the port. + * @param [in] newRightBound The new right bound of the port. */ void setRightBound(QString const& newRightBound); /*! * Set the size of the port. * - * @param [in] size The new size. Port bounds are set to size-1 and 0; + * @param [in] size The new size. Port bounds are set to size-1 and 0; */ void setPortSize(int size); /*! * Get the default value of the port. * - * @return The contained default value. + * @return The contained default value. */ QString getDefaultValue() const; /*! * Set the default value for the port. * - * @param [in] defaultValue The new default value. + * @param [in] defaultValue The new default value. */ void setDefaultValue(const QString& defaultValue); /*! * Get the direction of the port. * - * @return Enum direction. + * @return Enum direction. */ DirectionTypes::Direction getDirection() const; /*! * Set the direction. * - * @param [in] direction The new direction. + * @param [in] direction The new direction. */ void setDirection(DirectionTypes::Direction direction); /*! * Get the value of the logical directions allowed for wires or logical initiatives allowed for transactionals. * - * @return True, if the given value is allowed, false otherwise. + * @return True, if the given value is allowed, false otherwise. */ bool allLogicalDirectionsAllowed() const; /*! * Set the port to allow/disallow logical directions / initiatives. * - * @param [in] allowed The setting. + * @param [in] allowed The setting. */ void setAllLogicalDirectionsAllowed(bool allowed); /*! * Get the type name of the port for a given view. * - * @param [in] viewName The name of the view. + * @param [in] viewName The name of the view. * - * @return The matching type name. + * @return The matching type name. */ QString getTypeName(const QString& viewName = QString()) const; /*! * Set the type name for the port in given view. * - * @param [in] typeName The name of the type. - * @param [in] viewName The name of the view used for this type. + * @param [in] typeName The name of the type. + * @param [in] viewName The name of the view used for this type. */ void setTypeName(const QString& typeName, const QString& viewName = QString()); /*! * Check if the port has a type name in given view. * - * @param [in] viewName The name of the view that's type name is searched for. + * @param [in] viewName The name of the view that's type name is searched for. * - * @return True if a type is found, false otherwise. + * @return True if a type is found, false otherwise. */ bool hasType(const QString& viewName = QString()) const; /*! * Get the type definition of the given type name. * - * @param [in] typeName The name of the type that's type definition is wanted. - * @return The found type definition. + * @param [in] typeName The name of the type that's type definition is wanted. + * @return The found type definition. */ QString getTypeDefinition(const QString& typeName) const; /*! * Get the type definitions of the wired port. * - * @return A list containing the type definitions. + * @return A list containing the type definitions. */ QStringList getTypeDefinitions() const; /*! * Set the type definition of the given type name. * - * @param [in] typeName Identifies the type definition. - * @param [in] typeDefinition The type definition to be set. + * @param [in] typeName Identifies the type definition. + * @param [in] typeDefinition The type definition to be set. */ void setTypeDefinition(const QString& typeName, const QString& typeDefinition); /*! * Check if the port has a type definition. * - * @return True if the type definition is defined. + * @return True if the type definition is defined. */ bool hasTypeDefinitions() const; @@ -244,7 +244,7 @@ class IPXACTMODELS_EXPORT Port : public NameGroup, public Extendable /*! * Sets default the ad-hoc visibility of the port. * - * @param [in] visible If true, the port is set visible for ad-hoc connections. + * @param [in] visible If true, the port is set visible for ad-hoc connections. */ void setAdHocVisible(bool visible); @@ -256,84 +256,84 @@ class IPXACTMODELS_EXPORT Port : public NameGroup, public Extendable /*! * Sets the default position in the parent component's graphical representation. * - * @param [in] pos The position to set. + * @param [in] pos The position to set. */ void setDefaultPos(QPointF const& pos); /*! * Gets the left value of the array. * - * @return The left value of the array. + * @return The left value of the array. */ QString getArrayLeft() const; /*! * Sets the left value for the array. * - * @param [in] newArrayLeft The value to be set as left. + * @param [in] newArrayLeft The value to be set as left. */ void setArrayLeft(QString const& newArrayLeft); /*! * Gets the right value of the array. * - * @return The right value of the array. + * @return The right value of the array. */ QString getArrayRight() const; /*! * Sets the right value for the array. * - * @param [in] newArrayRight The value to be set as right. + * @param [in] newArrayRight The value to be set as right. */ void setArrayRight(QString const& newArrayRight); /*! * Gets the tags associated with the port. * - * @return Tags associated with the port. + * @return Tags associated with the port. */ QString getPortTags() const; /*! * Set the port tags. * - * @param [in] portTags The tags separated by a comma. + * @param [in] portTags The tags separated by a comma. */ void setPortTags(const QString& portTags); /*! * Get the presence of the port. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence for the port. * - * @param [in] newIsPresent The new presence expression. + * @param [in] newIsPresent The new presence expression. */ void setIsPresent(QString const& newIsPresent); /*! * Get the arrays associated with the port. * - * @return Pointer to a list containing the arrays. + * @return Pointer to a list containing the arrays. */ QSharedPointer > getArrays() const; /*! * Get the wire type definitions. * - * @return The type definitions contained within the wire port. + * @return The type definitions contained within the wire port. */ QSharedPointer > > getWireTypes() const; /*! * Get the transactional type definitions. * - * @return The type definitions contained within the transactional port. + * @return The type definitions contained within the transactional port. */ QSharedPointer > > getTransactionalTypes() const; diff --git a/IPXACTmodels/Component/PortMap.h b/IPXACTmodels/Component/PortMap.h index 9f3c0958a..94b6b687a 100644 --- a/IPXACTmodels/Component/PortMap.h +++ b/IPXACTmodels/Component/PortMap.h @@ -66,23 +66,23 @@ class IPXACTMODELS_EXPORT PortMap : public Extendable /*! The assignment operator * - * @param [in] other The PortMap to assign. + * @param [in] other The PortMap to assign. * - * @return Reference to this PortMap. + * @return Reference to this PortMap. */ PortMap& operator=(PortMap const& other); /*! * Get the invert value. * - * @return The invert value as either true, false or empty. + * @return The invert value as either true, false or empty. */ BooleanValue getInvert() const; /*! * Set the invert value. * - * @param [in] newInvert The new invert value. + * @param [in] newInvert The new invert value. */ void setInvert(bool newInvert); @@ -94,28 +94,28 @@ class IPXACTMODELS_EXPORT PortMap : public Extendable /*! * Get the presence. * - * @return The value defining the presence. + * @return The value defining the presence. */ QString getIsPresent() const; /*! * Set the presence value. * - * @param [in] newIsPresent The new value for presence. + * @param [in] newIsPresent The new value for presence. */ void setIsPresent(QString const& newIsPresent); /*! * Get the is informative value. * - * @return The isInformative value. + * @return The isInformative value. */ BooleanValue getIsInformative() const; /*! * Set the is informative value. * - * @param [in] newInformative The new is informative value. + * @param [in] newInformative The new is informative value. */ void setIsInformative(bool newInformative); @@ -127,42 +127,42 @@ class IPXACTMODELS_EXPORT PortMap : public Extendable /*! * Gets the logical port in the port map. * - * @return The name of the logical port. + * @return The name of the logical port. */ QSharedPointer getLogicalPort() const; /*! * Sets the logical port in the port map. * - * @param [in] logicalPort The logical port to set. + * @param [in] logicalPort The logical port to set. */ void setLogicalPort(QSharedPointer logicalPort); /*! * Gets the physical port in the port map. * - * @return The name of the physical port. + * @return The name of the physical port. */ QSharedPointer getPhysicalPort() const; /*! * Sets the physical port in the port map. * - * @param [in] physical The physical port to set. + * @param [in] physical The physical port to set. */ void setPhysicalPort(QSharedPointer physicalPort); /*! * Gets the logical tie off. * - * @return The logical tie off value. + * @return The logical tie off value. */ QString getLogicalTieOff() const; /*! * Sets the logical tie off. * - * @param [in] logicalTieOff The new logical tie off. + * @param [in] logicalTieOff The new logical tie off. */ void setLogicalTieOff(QString const& logicalTieOff); diff --git a/IPXACTmodels/Component/PortReader.h b/IPXACTmodels/Component/PortReader.h index f3df2360f..3f6f52406 100644 --- a/IPXACTmodels/Component/PortReader.h +++ b/IPXACTmodels/Component/PortReader.h @@ -30,9 +30,9 @@ namespace PortReader /*! * Creates a new port from XML description. * - * @param [in] portNode XML description of the port. + * @param [in] portNode XML description of the port. * - * @return A new port created from the XML description. + * @return A new port created from the XML description. */ IPXACTMODELS_EXPORT QSharedPointer createPortFrom(QDomNode const& portNode, Document::Revision docRevision); @@ -43,8 +43,8 @@ namespace PortReader /*! * Parses a wire port. * - * @param [in] wireElement XML description of the wire. - * @param [in] docRevision The applied IP-XACT revision. + * @param [in] wireElement XML description of the wire. + * @param [in] docRevision The applied IP-XACT revision. */ QSharedPointer createWireFrom(QDomElement const& wireElement, Document::Revision docRevision); @@ -52,8 +52,8 @@ namespace PortReader /*! * Parse vectors. * - * @param [in] wireElement XML description of the wire. - * @param [in] newWire The containing wire item. + * @param [in] wireElement XML description of the wire. + * @param [in] newWire The containing wire item. */ void parseWireVectors(QDomElement const& wireElement, QSharedPointer newWire, Document::Revision docRevision); @@ -61,31 +61,31 @@ namespace PortReader /*! * Parse the vectors in the given element. * - * @param [in] parentElement The element containing vectors. - * @param [in] docRevision The applied IP-XACT revision. + * @param [in] parentElement The element containing vectors. + * @param [in] docRevision The applied IP-XACT revision. * - * @return The parsed vectors. + * @return The parsed vectors. */ QList parseVectors(QDomElement const& parentElement, Document::Revision docRevision); /*! * Parse a single vector. * - * @param [in] vectorNode The xml presentation of the vector. - * @param [in] docRevision The applied IP-XACT revision. + * @param [in] vectorNode The xml presentation of the vector. + * @param [in] docRevision The applied IP-XACT revision. * - * @return The parsed vector. + * @return The parsed vector. */ Vector parseVector(QDomNode const& vectorNode, Document::Revision docRevision); /*! * Parse the wire type definitions. * - * @param [in] typeDefinitionsElement XML description of the type definitions. - * @param [in] elementName Name of the type definition element. - * @param [in] attributeName Name of the attribute containing the constraint. + * @param [in] typeDefinitionsElement XML description of the type definitions. + * @param [in] elementName Name of the type definition element. + * @param [in] attributeName Name of the attribute containing the constraint. * - * @return Pointer to a list containing the created type definitions. + * @return Pointer to a list containing the created type definitions. */ QSharedPointer > >parseWireTypeDefinitions( QDomElement const& typeDefinitionsElement, QString const& elementName, QString const& attributeName); @@ -93,8 +93,8 @@ namespace PortReader /*! * Parse the type definitions. * - * @param [in] wireTypeDefinitionElement XML description of the wire type definition. - * @param [in] newWireTypeDefinition The containing wire type definition. + * @param [in] wireTypeDefinitionElement XML description of the wire type definition. + * @param [in] newWireTypeDefinition The containing wire type definition. */ void parseTypeDefinitions(QDomElement const& wireTypeDefinitionElement, QSharedPointer newWireTypeDefinition); @@ -102,8 +102,8 @@ namespace PortReader /*! * Parse the view references. * - * @param [in] wireTypeDefinitionElement XML description of the wire type definition. - * @param [in] newWireTypeDefinition The containing wire type definition. + * @param [in] wireTypeDefinitionElement XML description of the wire type definition. + * @param [in] newWireTypeDefinition The containing wire type definition. */ void parseViewReferences(QDomElement const& wireTypeDefinitionElement, QSharedPointer newWireTypeDefinition); @@ -111,32 +111,32 @@ namespace PortReader /*! * Parse the wire driver default value. * - * @param [in] wireElement XML description of the wire. - * @param [in] newWire The containing wire item. + * @param [in] wireElement XML description of the wire. + * @param [in] newWire The containing wire item. */ void parseWireDefaultValue(QDomElement const& wireElement, QSharedPointer newWire); /*! * Parse a transactional port. * - * @param [in] transactionalElement XML description of the transactional. - * @param [in] newPort The containing port. + * @param [in] transactionalElement XML description of the transactional. + * @param [in] newPort The containing port. */ void parseTransactional(QDomElement const& transactionalElement, QSharedPointer newPort); /*! * Parse the kind of the transactional port. * - * @param [in] kindElement XML description of the kind. - * @param [in] transactional The containing transactional port. + * @param [in] kindElement XML description of the kind. + * @param [in] transactional The containing transactional port. */ void parseTransactionalKind(QDomElement const& kindElement, QSharedPointer transactional); /*! * Parse the transactional protocol. * - * @param [in] transactionalNode XML description of the transactional. - * @param [in] transactional The containing transactional port. + * @param [in] transactionalNode XML description of the transactional. + * @param [in] transactional The containing transactional port. */ void parseTransactionalProtocol(QDomNode const& transactionalNode, QSharedPointer transactional); @@ -144,8 +144,8 @@ namespace PortReader /*! * Parse the maximum and minimum connections allowed to a transactional port. * - * @param [in] transactionalElement XML description of the transactional. - * @param [in] transactional The containing transactional port. + * @param [in] transactionalElement XML description of the transactional. + * @param [in] transactional The containing transactional port. */ void parseTransactionalConnectionsMinMax(QDomElement const& transactionalElement, QSharedPointer transactional); @@ -153,58 +153,58 @@ namespace PortReader /*! * Parse a structured port. * - * @param [in] structuredElement The XML description of the structured port. - * @param [in] newPort The containing port item. + * @param [in] structuredElement The XML description of the structured port. + * @param [in] newPort The containing port item. * - * @return + * @return */ QSharedPointer createStructuredFrom(QDomElement const& structuredElement); /*! * Parse the structured port type. * - * @param [in] structuredElementt The XML description of the structured port. - * @param [in] newStructured The containing structured port. + * @param [in] structuredElementt The XML description of the structured port. + * @param [in] newStructured The containing structured port. */ void parseStructuredType(QDomElement const& structuredElement, QSharedPointer newStructured); /*! * Parse the vectors in the structured port. * - * @param [in] structuredElementt The XML description of the structured port. - * @param [in] newStructured The containing structured port. + * @param [in] structuredElementt The XML description of the structured port. + * @param [in] newStructured The containing structured port. */ void parseStructuredVectors(QDomElement const& structuredElement, QSharedPointer newStructured); /*! * Parse the sub-ports in the structured port. * - * @param [in] structuredElementt The XML description of the structured port. - * @param [in] newStructured The containing structured port. + * @param [in] structuredElementt The XML description of the structured port. + * @param [in] newStructured The containing structured port. */ void parseSubPorts(QDomElement const& structuredElement, QSharedPointer newStructured); /*! * Parse the port arrays. * - * @param [in] parentNode XML node . - * @param [in] newPort The containing port item. + * @param [in] parentNode XML node . + * @param [in] newPort The containing port item. */ QList createArrays(QDomNode const& parentNode); /*! * Parse the port vendor extensions. * - * @param [in] portNode XML description of the port. - * @param [in] newPort The containing port item. + * @param [in] portNode XML description of the port. + * @param [in] newPort The containing port item. */ void parsePortExtensions(QDomNode const& portNode, QSharedPointer newPort); /*! * Parse the port position. * - * @param [in] positionElement XML description of the port position. - * @param [in] newPort The contianing port item. + * @param [in] positionElement XML description of the port position. + * @param [in] newPort The contianing port item. */ void parsePosition(QDomElement const& positionElement, QSharedPointer newPort) ; } diff --git a/IPXACTmodels/Component/PortSlice.h b/IPXACTmodels/Component/PortSlice.h index 20bef9583..794b4810c 100644 --- a/IPXACTmodels/Component/PortSlice.h +++ b/IPXACTmodels/Component/PortSlice.h @@ -49,14 +49,14 @@ class IPXACTMODELS_EXPORT PortSlice : public NameGroup /*! * Get the value of the port reference. * - * @return The port reference. + * @return The port reference. */ QString getPortRef() const; /*! * Set the portNameRef for this PortSlice. * - * @param [in] newPortNameRef The new port reference. + * @param [in] newPortNameRef The new port reference. */ void setPortRef(QString const& newPortNameRef); @@ -68,28 +68,28 @@ class IPXACTMODELS_EXPORT PortSlice : public NameGroup /*! * Get the left value of the range. * - * @return The left value of the range. + * @return The left value of the range. */ QString getLeftRange() const; /*! * Get the right value of the range. * - * @return The right value of the range. + * @return The right value of the range. */ QString getRightRange() const; /*! * Set the left value for the range. * - * @param [in] newLeftRange The new value for the left value of the range. + * @param [in] newLeftRange The new value for the left value of the range. */ void setLeftRange(QString const& newLeftRange); /*! * Set the right value for the range. * - * @param [in] newRightRange The new value for the right value of the range. + * @param [in] newRightRange The new value for the right value of the range. */ void setRightRange(QString const& newRightRange); diff --git a/IPXACTmodels/Component/PortWriter.h b/IPXACTmodels/Component/PortWriter.h index bb661e25f..18851292a 100644 --- a/IPXACTmodels/Component/PortWriter.h +++ b/IPXACTmodels/Component/PortWriter.h @@ -30,9 +30,9 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write a component port to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] port The port to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] port The port to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writePort(QXmlStreamWriter& writer, QSharedPointer port, Document::Revision docRevision) const; @@ -41,18 +41,18 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write a wire port. * - * @param [in] writer Used XML writer. - * @param [in] wire The wire to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] wire The wire to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeWire(QXmlStreamWriter& writer, QSharedPointer wire, Document::Revision docRevision) const; /*! * Write a transactional port. * - * @param [in] writer Used XML writer. - * @param [in] transactional The transactional to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] transactional The transactional to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeTransactional(QXmlStreamWriter& writer, QSharedPointer transactional, Document::Revision docRevision) const; @@ -60,9 +60,9 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write a vector. * - * @param [in] writer Used XML writer. - * @param [in] vector The vector to be written. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer Used XML writer. + * @param [in] vector The vector to be written. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeVectors(QXmlStreamWriter& writer, QSharedPointer > vectors, Document::Revision docRevision) const; @@ -70,8 +70,8 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write the wire type definitions. * - * @param [in] writer Used XML writer. - * @param [in] typeDefinitions A list of the wire type definitions to be written. + * @param [in] writer Used XML writer. + * @param [in] typeDefinitions A list of the wire type definitions to be written. */ void writeWireTypeDefinitions(QXmlStreamWriter& writer, QSharedPointer > > typeDefinitions) const; @@ -79,18 +79,18 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Check if the wire type definitions are not empty. * - * @param [in] typeDefinitions A list of the wire type definitions to be check. + * @param [in] typeDefinitions A list of the wire type definitions to be check. * - * @return True, if at least one type definition is not empty, false otherwise. + * @return True, if at least one type definition is not empty, false otherwise. */ bool hasNonEmptyTypeDefinitions(QSharedPointer > > typeDefinitions) const; /*! * Write a single type definition. * - * @param [in] writer Used XML writer. - * @param [in] typeDefinition The type definition to be written. - * @param [in] attributeName The type definition constraining attribute name. + * @param [in] writer Used XML writer. + * @param [in] typeDefinition The type definition to be written. + * @param [in] attributeName The type definition constraining attribute name. */ void writeSingleTypeDefinition(QXmlStreamWriter& writer, QSharedPointer typeDefinition, QString const& attributeName) const; @@ -98,32 +98,32 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write the wire driver. * - * @param [in] writer Used XML writer. - * @param [in] driver The driver to be written. + * @param [in] writer Used XML writer. + * @param [in] driver The driver to be written. */ void writeWireDriver(QXmlStreamWriter& writer, QSharedPointer driver) const; /*! * Write the transactional kind. * - * @param [in] writer Used XML writer. - * @param [in] kind The kind to be written. + * @param [in] writer Used XML writer. + * @param [in] kind The kind to be written. */ void writeTransactionalKind(QXmlStreamWriter& writer, QString const& kind) const; /*! * Write the transactional bus width. * - * @param [in] writer Used XML writer. - * @param [in] busWidth The bus width to be written. + * @param [in] writer Used XML writer. + * @param [in] busWidth The bus width to be written. */ void writeTransactionalBusWidth(QXmlStreamWriter& writer, QString const& busWidth) const; /*! * Write the transactional type definitions. * - * @param [in] writer Used XML writer. - * @param [in] transactional The transactional containing the type definitions. + * @param [in] writer Used XML writer. + * @param [in] transactional The transactional containing the type definitions. */ void writeTransactionalTypeDefinitions(QXmlStreamWriter& writer, QSharedPointer transactional) const; @@ -131,8 +131,8 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write the transactional minimum and maximum connections. * - * @param [in] writer Used XML writer. - * @param [in] transactional The transactional containing the minimum and maximum connections. + * @param [in] writer Used XML writer. + * @param [in] transactional The transactional containing the minimum and maximum connections. */ void writeTransactionalMinMaxConnections(QXmlStreamWriter& writer, QSharedPointer transactional) const; @@ -140,32 +140,32 @@ class IPXACTMODELS_EXPORT PortWriter /*! * Write the structural port. * - * @param [in] writer The used XML writer. - * @param [in] structured The structured port description to write. + * @param [in] writer The used XML writer. + * @param [in] structured The structured port description to write. */ void writeStructured(QXmlStreamWriter& writer, QSharedPointer structured) const; /*! * Write the type of the structural port. * - * @param [in] writer The used XML writer. - * @param [in] structured The structured port whose type to write. + * @param [in] writer The used XML writer. + * @param [in] structured The structured port whose type to write. */ void writeStructuredType(QXmlStreamWriter& writer, QSharedPointer structured) const; /*! * Write the sub-ports in a structural port. * - * @param [in] writer The used XML writer. - * @param [in] structured The structured port whose sub-ports to write. + * @param [in] writer The used XML writer. + * @param [in] structured The structured port whose sub-ports to write. */ void writeSubPorts(QXmlStreamWriter& writer, QSharedPointer structured) const; /*! * Write the port arrays. * - * @param [in] writer Used XML writer. - * @param [in] arrays The arrays to be written. + * @param [in] writer Used XML writer. + * @param [in] arrays The arrays to be written. */ void writeArrays(QXmlStreamWriter& writer, QSharedPointer > arrays) const; diff --git a/IPXACTmodels/Component/PowerDomainReader.h b/IPXACTmodels/Component/PowerDomainReader.h index 3b35777e9..cc8f465fd 100644 --- a/IPXACTmodels/Component/PowerDomainReader.h +++ b/IPXACTmodels/Component/PowerDomainReader.h @@ -28,8 +28,8 @@ namespace PowerDomainReader /*! * Creates a new PowerDomain from a given PowerDomain node. * - * @param [in] PowerDomainNode XML description of the PowerDomain. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] PowerDomainNode XML description of the PowerDomain. + * @param [in] docRevision The applied IP-XACT standard revision. */ IPXACTMODELS_EXPORT QSharedPointer createFrom(QDomNode const& PowerDomainNode); diff --git a/IPXACTmodels/Component/PowerDomainWriter.h b/IPXACTmodels/Component/PowerDomainWriter.h index bf73aa90b..1c7544371 100644 --- a/IPXACTmodels/Component/PowerDomainWriter.h +++ b/IPXACTmodels/Component/PowerDomainWriter.h @@ -27,8 +27,8 @@ namespace PowerDomainWriter /*! * Write a channel to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] domain The power domain to be written. + * @param [in] writer The used xml writer. + * @param [in] domain The power domain to be written. */ IPXACTMODELS_EXPORT void write(QXmlStreamWriter& writer, QSharedPointer domain); diff --git a/IPXACTmodels/Component/Region.h b/IPXACTmodels/Component/Region.h index 1dcaf8783..1fbff1e51 100644 --- a/IPXACTmodels/Component/Region.h +++ b/IPXACTmodels/Component/Region.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT Region : public NameGroup, public Extendable /*! * The default constructor. * - * @param [in] name Name of the region. + * @param [in] name Name of the region. */ Region(QString const& name = QString(), QString const& addressOffset = QString(), QString const& range = QString()); @@ -47,28 +47,28 @@ class IPXACTMODELS_EXPORT Region : public NameGroup, public Extendable /*! * Get the address offset of the region. * - * @return The address offset. + * @return The address offset. */ QString getAddressOffset() const; /*! * Set the address offset for the region. * - * @param [in] addressOffset The offset within the containing memory. + * @param [in] addressOffset The offset within the containing memory. */ void setOffset(QString const& addressOffset); /*! * Get the range of the region. * - * @return The number of addressable units the region has. + * @return The number of addressable units the region has. */ QString getRange() const; /*! * Set the range for the region. * - * @param [in] range The number of addressable units the region contains. + * @param [in] range The number of addressable units the region contains. */ void setRange(QString const& range); diff --git a/IPXACTmodels/Component/Register.h b/IPXACTmodels/Component/Register.h index f8fa737f9..e21628a7b 100644 --- a/IPXACTmodels/Component/Register.h +++ b/IPXACTmodels/Component/Register.h @@ -34,9 +34,9 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * The constructor. * - * @param [in] name Name of the register. - * @param [in] addressOffset Offset of the register. - * @param [in] size Size of the register. + * @param [in] name Name of the register. + * @param [in] addressOffset Offset of the register. + * @param [in] size Size of the register. */ Register(QString const& name = QString(), QString const& addressOffset = QString(), QString const& size = QString()); @@ -53,7 +53,7 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * Clone the register and return pointer to the copy. * - * @return Pointer to the cloned register. + * @return Pointer to the cloned register. */ virtual QSharedPointer clone(); @@ -61,28 +61,28 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * Get the alternate registers of this register. * - * @return Pointer to a list containing the alternate registers. + * @return Pointer to a list containing the alternate registers. */ QSharedPointer > > getAlternateRegisters() const; /*! * Set the alternate registers for this register. * - * @param [in] alternateRegisters Pointer to a list containing the new alternateRegisters. + * @param [in] alternateRegisters Pointer to a list containing the new alternateRegisters. */ void setAlternateRegisters(QSharedPointer > > newAlternateRegisters); /*! * Get the width of the register. * - * @return The width of the register in bits. + * @return The width of the register in bits. */ QString getSize() const; /*! * Set the width of the register. * - * @param [in] size The width of the register in bits. + * @param [in] size The width of the register in bits. */ void setSize(QString const& newSize); @@ -96,7 +96,7 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * Set the register definition reference. * - * @param [in] registerDefinitionRef The new register definition reference. + * @param [in] registerDefinitionRef The new register definition reference. */ void setRegisterDefinitionReference(QString const& registerDefinitionRef); @@ -110,7 +110,7 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * Set the type definitions reference. * - * @param [in] typeDefinitionsRef The new type definitions reference to set. + * @param [in] typeDefinitionsRef The new type definitions reference to set. */ void setTypeDefinitionsReference(QString const& typeDefinitionsRef); @@ -119,7 +119,7 @@ class IPXACTMODELS_EXPORT Register: public RegisterDefinition /*! * Copy the alternate registers. * - * @param [in] other The register being copied. + * @param [in] other The register being copied. */ void copyAlternateRegisters(const Register& other); diff --git a/IPXACTmodels/Component/RegisterBase.h b/IPXACTmodels/Component/RegisterBase.h index 59a1ef4ad..3220c3c36 100644 --- a/IPXACTmodels/Component/RegisterBase.h +++ b/IPXACTmodels/Component/RegisterBase.h @@ -35,7 +35,7 @@ class IPXACTMODELS_EXPORT RegisterBase : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name The register name. + * @param [in] name The register name. */ RegisterBase(QString const& name = QString()); RegisterBase(QString const& name, QString const& addressOffset); @@ -52,34 +52,34 @@ class IPXACTMODELS_EXPORT RegisterBase : public NameGroup, public Extendable /*! * Clone the register model and return pointer to the copy. * - * @return Pointer to the cloned register model. + * @return Pointer to the cloned register model. */ virtual QSharedPointer clone() = 0; /*! * Get the presence value. * - * @return The isPresent value. + * @return The isPresent value. */ QString getIsPresent() const; /*! * Set the is present value. * - * @param [in] newIsPresent The new value for is present. + * @param [in] newIsPresent The new value for is present. */ void setIsPresent(QString const& newIsPresent); /*! * Get the dimension of the register. * - * @return The first dimension defined for the register. + * @return The first dimension defined for the register. */ QString getDimension() const; /*! * Set the first dimension of the register base. * - * @param [in] newDimension The new value for the first dim-element. + * @param [in] newDimension The new value for the first dim-element. */ void setDimension(QString const& newDimension); @@ -93,49 +93,49 @@ class IPXACTMODELS_EXPORT RegisterBase : public NameGroup, public Extendable /*! * Set the memory array of the register. * - * @param [in] newMemArray Pointer to the memory array to set. + * @param [in] newMemArray Pointer to the memory array to set. */ void setMemoryArray(QSharedPointer newMemArray); /*! * Get the address offset of the registerFile. * - * @return The offset. + * @return The offset. */ QString getAddressOffset() const; /*! * Set the address offset. * - * @param [in] newAddressOffset The new offset. + * @param [in] newAddressOffset The new offset. */ void setAddressOffset(QString const& newAddressOffset); /*! * Get the register type identifier. * - * @return The type identifier of the register. + * @return The type identifier of the register. */ QString getTypeIdentifier() const; /*! * Set the register type identifier. * - * @param [in] newTypeIdentifier The new register type identifier. + * @param [in] newTypeIdentifier The new register type identifier. */ void setTypeIdentifier(QString const& newTypeIdentifier); /*! * Get the parameters of the register. * - * @return Pointer to a list containing the parameters. + * @return Pointer to a list containing the parameters. */ QSharedPointer > > getParameters() const; /*! * Set the parameters for the register. * - * @param [in] newParameters Pointer to a list containing the new parameters + * @param [in] newParameters Pointer to a list containing the new parameters */ void setParameters(QSharedPointer > > newParameters); @@ -149,7 +149,7 @@ class IPXACTMODELS_EXPORT RegisterBase : public NameGroup, public Extendable /*! * Set the access policies of the register. * - * @param [in] newAccessPolicies The new access policies to set. + * @param [in] newAccessPolicies The new access policies to set. */ void setAccessPolicies(QSharedPointer > > newAccessPolicies); @@ -163,14 +163,14 @@ class IPXACTMODELS_EXPORT RegisterBase : public NameGroup, public Extendable /*! * Copy the parameters. * - * @param [in] other The register base class being copied. + * @param [in] other The register base class being copied. */ void copyParameters(const RegisterBase& other); /*! * Copy the access policies. * - * @param [in] other The register base class being copied. + * @param [in] other The register base class being copied. */ void copyAccessPolicies(const RegisterBase& other); diff --git a/IPXACTmodels/Component/RegisterDefinition.h b/IPXACTmodels/Component/RegisterDefinition.h index db6230d65..814f4ddda 100644 --- a/IPXACTmodels/Component/RegisterDefinition.h +++ b/IPXACTmodels/Component/RegisterDefinition.h @@ -36,7 +36,7 @@ class IPXACTMODELS_EXPORT RegisterDefinition : public RegisterBase /*! * The constructor. * - * @param [in] name Name of the register definition. + * @param [in] name Name of the register definition. */ RegisterDefinition(QString const& name, QString const& addressOffset ); @@ -54,14 +54,14 @@ class IPXACTMODELS_EXPORT RegisterDefinition : public RegisterBase /*! * Get the volatile value. * - * @return The volatile value in string format. Empty string means an unspecified volatility. + * @return The volatile value in string format. Empty string means an unspecified volatility. */ QString getVolatile() const; /*! * Set the volatileValue. * - * @param [in] newVolatile The new volatile value. + * @param [in] newVolatile The new volatile value. */ void setVolatile(bool newVolatile); @@ -73,28 +73,28 @@ class IPXACTMODELS_EXPORT RegisterDefinition : public RegisterBase /*! * Get the access. * - * @return Access value. + * @return Access value. */ AccessTypes::Access getAccess() const; /*! * Set the access. * - * @param [in] access The new access value. + * @param [in] access The new access value. */ void setAccess(AccessTypes::Access newAccessValue); /*! * Get the list of contained fields. * - * @return Pointer to a list containing the fields. + * @return Pointer to a list containing the fields. */ QSharedPointer > > getFields() const; /*! * Set the new fields for the register. * - * @param [in] fields Pointer to a list containing the fields. + * @param [in] fields Pointer to a list containing the fields. */ void setFields(QSharedPointer > > newFields); @@ -103,7 +103,7 @@ class IPXACTMODELS_EXPORT RegisterDefinition : public RegisterBase /*! * Copy the fields. * - * @param [in] other The register definition being copied. + * @param [in] other The register definition being copied. */ void copyFields(const RegisterDefinition& other); diff --git a/IPXACTmodels/Component/RegisterFile.h b/IPXACTmodels/Component/RegisterFile.h index 12dce5a99..0775110f3 100644 --- a/IPXACTmodels/Component/RegisterFile.h +++ b/IPXACTmodels/Component/RegisterFile.h @@ -33,9 +33,9 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * The constructor. * - * @param [in] name The register file name. - * @param [in] addressOffset The address offset. - * @param [in] range The range of the register file. + * @param [in] name The register file name. + * @param [in] addressOffset The address offset. + * @param [in] range The range of the register file. */ RegisterFile(QString const& name = QString(), QString const& addressOffset = QString(), QString const& range = QString()); @@ -52,21 +52,21 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * Clone the register file and return pointer to the copy. * - * @return Pointer to the cloned register file. + * @return Pointer to the cloned register file. */ virtual QSharedPointer clone(); /*! * Get the range of the registerFile. * - * @return The range of the registerFile. + * @return The range of the registerFile. */ QString getRange() const; /*! * Set the range of the registerFile. * - * @param [in] newRange The new range. + * @param [in] newRange The new range. */ void setRange(QString const& newRange); @@ -74,14 +74,14 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * Get the registerData elements of the reigsterFile. * - * @return Pointer to a list containing the register data. + * @return Pointer to a list containing the register data. */ QSharedPointer > > getRegisterData() const; /*! * Set the registerData for the registerFile. * - * @param [in] newRegisterData Pointer to a list containing the register data. + * @param [in] newRegisterData Pointer to a list containing the register data. */ void setRegisterData(QSharedPointer > > newRegisterData); @@ -95,7 +95,7 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * Set the register file definition reference. * - * @param [in] registerFileDefinitionRef The new register file definition reference. + * @param [in] registerFileDefinitionRef The new register file definition reference. */ void setRegisterFileDefinitionReference(QString const& newRegisterFileDefinitionRef); @@ -109,7 +109,7 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * Set the type definitions reference. * - * @param [in] typeDefinitionsRef The new type definitions reference to set. + * @param [in] typeDefinitionsRef The new type definitions reference to set. */ void setTypeDefinitionsReference(QString const& newTypeDefinitionsRef); @@ -118,7 +118,7 @@ class IPXACTMODELS_EXPORT RegisterFile: public RegisterBase /*! * Copy the register data. * - * @param [in] other The register file being copied. + * @param [in] other The register file being copied. */ void copyRegisterData(const RegisterFile& other); diff --git a/IPXACTmodels/Component/RegisterReader.h b/IPXACTmodels/Component/RegisterReader.h index 256848170..04c952d4d 100644 --- a/IPXACTmodels/Component/RegisterReader.h +++ b/IPXACTmodels/Component/RegisterReader.h @@ -33,18 +33,18 @@ namespace RegisterReader /*! * Creates a new register from a given register node. * - * @param [in] registerNode XML description of the register. + * @param [in] registerNode XML description of the register. * - * @return The created register. + * @return The created register. */ IPXACTMODELS_EXPORT QSharedPointer createRegisterfrom(QDomNode const& registerNode, Document::Revision docRevision); /*! * Creates a new register file from a given register file node. * - * @param [in] registerFileNode XML description fo the register file. + * @param [in] registerFileNode XML description fo the register file. * - * @return The created register file. + * @return The created register file. */ IPXACTMODELS_EXPORT QSharedPointer createRegisterFileFrom(QDomNode const& registerFileNode, Document::Revision docRevision); @@ -54,49 +54,49 @@ namespace RegisterReader /*! * Create address offset from a given register base node. * - * @param [in] registerBaseNode XML description of the register base. + * @param [in] registerBaseNode XML description of the register base. * - * @return The parsed address offset. + * @return The parsed address offset. */ QString createAddressOffsetFrom(QDomNode const& registerBaseNode); /*! * Reads the register size. * - * @param [in] registerNode XML description of the register. - * @param [in] selectedRegister The selected register. + * @param [in] registerNode XML description of the register. + * @param [in] selectedRegister The selected register. */ void parseRegisterSize(QDomNode const& registerNode, QSharedPointer selectedRegister); /*! * Reads the is present value. * - * @param [in] registerBaseNode XML description of the register base. - * @param [in] registerBase Selected register base. + * @param [in] registerBaseNode XML description of the register base. + * @param [in] registerBase Selected register base. */ void parsePresence(QDomNode const& registerBaseNode, QSharedPointer registerBase); /*! * Reads the register dimension. * - * @param [in] registerNode XML description of the register. - * @param [in] selectedRegister Selected register. + * @param [in] registerNode XML description of the register. + * @param [in] selectedRegister Selected register. */ void parseRegisterDimension(QDomNode const& registerNode, QSharedPointer selectedRegister); /*! * Reads the type identifier. * - * @param [in] registerBaseNode XML description of the register base. - * @param [in] registerBase Selected register base. + * @param [in] registerBaseNode XML description of the register base. + * @param [in] registerBase Selected register base. */ void parseTypeIdentifier(QDomNode const& registerBaseNode, QSharedPointer registerBase); /*! * Reads the volatile value. * - * @param [in] registerDefinitionNode XML description of the register definition. - * @param [in] registerDefinition Selected register definition. + * @param [in] registerDefinitionNode XML description of the register definition. + * @param [in] registerDefinition Selected register definition. */ void parseVolatile(QDomNode const& registerDefinitionNode, QSharedPointer registerDefinition); @@ -104,16 +104,16 @@ namespace RegisterReader /*! * Reads the access value. * - * @param [in] registerDefinitionNode XML description of the register definition. - * @param [in] registerDefinition Selected register definition. + * @param [in] registerDefinitionNode XML description of the register definition. + * @param [in] registerDefinition Selected register definition. */ void parseAccess(QDomNode const& definitionNode, QSharedPointer registerDefinition); /*! * Reads the fields. * - * @param [in] registerDefinitionElement XML description of the register definition. - * @param [in] registerDefinition Selected register definition. + * @param [in] registerDefinitionElement XML description of the register definition. + * @param [in] registerDefinition Selected register definition. */ void parseFields(QDomElement const& registerDefinitionElement, QSharedPointer registerDefinition, @@ -122,16 +122,16 @@ namespace RegisterReader /*! * Reads the alternate registers. * - * @param [in] registerElement XML description of the register. - * @param [in] targetRegister Selected register. + * @param [in] registerElement XML description of the register. + * @param [in] targetRegister Selected register. */ void parseAlternateRegisters(QDomElement const& registerElement, QSharedPointer targetRegister, Document::Revision docRevision); /*! * Reads a single alternate register. * - * @param [in] alternateRegisterElement XML description of the alternate register. - * @param [in] newAlternateRegister Selected alternate register. + * @param [in] alternateRegisterElement XML description of the alternate register. + * @param [in] newAlternateRegister Selected alternate register. */ void parseSingleAlternateRegister(QDomElement const& alternateRegisterElement, QSharedPointer newAlternateRegister, @@ -140,8 +140,8 @@ namespace RegisterReader /*! * Reads alternate register alternate groups. * - * @param [in] alternateRegisterElement XML description of the alternate register. - * @param [in] newAlternateRegister Selected alternate register. + * @param [in] alternateRegisterElement XML description of the alternate register. + * @param [in] newAlternateRegister Selected alternate register. */ void parseAlternateGroups(QDomElement const& alternateRegisterElement, QSharedPointer newAlternateRegister); @@ -149,16 +149,16 @@ namespace RegisterReader /*! * Reads the parameters. * - * @param [in] registerBaseNode XML description of the register base. - * @param [in] newRegisterBase Selected register base. + * @param [in] registerBaseNode XML description of the register base. + * @param [in] newRegisterBase Selected register base. */ void parseParameters(QDomNode const& registerBaseNode, QSharedPointer newRegisterBase); /*! * Reads the register file range. * - * @param [in] registerFileNode XML description of the register file. - * @param [in] newRegisterFile Selected register file. + * @param [in] registerFileNode XML description of the register file. + * @param [in] newRegisterFile Selected register file. */ void parseRegisterFileRange(QDomNode const& registerFileNode, QSharedPointer newRegisterFile) ; @@ -166,8 +166,8 @@ namespace RegisterReader /*! * Reads the register file dimension. * - * @param [in] registerFileNode XML description of the register file. - * @param [in] newRegisterFile Selected register file. + * @param [in] registerFileNode XML description of the register file. + * @param [in] newRegisterFile Selected register file. */ void parseRegisterFileDimension(QDomNode const& registerFileNode, QSharedPointer newRegisterFile); @@ -175,8 +175,8 @@ namespace RegisterReader /*! * Reads the contained register data of a register file. * - * @param [in] registerFileNode XML description of the register file. - * @param [in] newRegisterFile Selected register file. + * @param [in] registerFileNode XML description of the register file. + * @param [in] newRegisterFile Selected register file. */ void parseRegisterFileRegisterData(QDomNode const& registerFileNode, QSharedPointer newRegisterFile, @@ -185,8 +185,8 @@ namespace RegisterReader /*! * Reads the register definition refernece of a register. * - * @param [in] registerNode XML description of the register. - * @param [in] newRegister The selected register. + * @param [in] registerNode XML description of the register. + * @param [in] newRegister The selected register. */ void parseRegisterDefinitionReference(QDomNode const& registerNode, QSharedPointer newRegister); @@ -194,24 +194,24 @@ namespace RegisterReader /*! * Reads the memory array of a register. * - * @param [in] registerNode XML description of the register. - * @param [in] newRegister The selected register. + * @param [in] registerNode XML description of the register. + * @param [in] newRegister The selected register. */ void parseRegisterMemoryArray(QDomNode const& registereNode, QSharedPointer newRegister); /*! * Reads the memory array of a register file. * - * @param [in] registerFileNode XML description of the register file. - * @param [in] newRegisterFile The selected register file. + * @param [in] registerFileNode XML description of the register file. + * @param [in] newRegisterFile The selected register file. */ void parseRegisterFileMemoryArray(QDomNode const& registerFileNode, QSharedPointer newRegisterFile); /*! * Reads the definition reference of a register file. * - * @param [in] registerFileNode XML description of the register file. - * @param [in] newRegisterFile The selected register file. + * @param [in] registerFileNode XML description of the register file. + * @param [in] newRegisterFile The selected register file. */ void parseRegisterFileDefinitionReference(QDomNode const& registerFileNode, QSharedPointer newRegisterFile); @@ -219,16 +219,16 @@ namespace RegisterReader /*! * Reads the access policies for a register, register file or alternate register. * - * @param [in] registerBaseNode XML description of the register base. - * @param [in] newRegisterBase Selected register base. + * @param [in] registerBaseNode XML description of the register base. + * @param [in] newRegisterBase Selected register base. */ void parseAccessPolicies(QDomNode const& registerBaseNode, QSharedPointer newRegisterBase); /*! * Reads the mode references of an alternate register. * - * @param [in] alternateRegisterNode XML description of the alternate register. - * @param [in] newAlternateRegister Selected alternate register. + * @param [in] alternateRegisterNode XML description of the alternate register. + * @param [in] newAlternateRegister Selected alternate register. */ void parseAlternateRegisterModeRefs(QDomNode const& alternateRegisterNode, QSharedPointer newAlternateRegister); } diff --git a/IPXACTmodels/Component/RegisterWriter.h b/IPXACTmodels/Component/RegisterWriter.h index abbd51a03..67d1c3566 100644 --- a/IPXACTmodels/Component/RegisterWriter.h +++ b/IPXACTmodels/Component/RegisterWriter.h @@ -33,8 +33,8 @@ namespace RegisterWriter /*! * Write a register or a register file to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] registerData The register data to be written. + * @param [in] writer The used XML writer. + * @param [in] registerData The register data to be written. */ IPXACTMODELS_EXPORT void writeRegisterData(QXmlStreamWriter& writer, QSharedPointer registerData, Document::Revision docRevision); @@ -43,64 +43,64 @@ namespace RegisterWriter /*! * Write a register. * - * @param [in] writer The used XML writer. - * @param [in] targetRegister The selected register. + * @param [in] writer The used XML writer. + * @param [in] targetRegister The selected register. */ void writeRegister(QXmlStreamWriter& writer, QSharedPointer targetRegister, Document::Revision docRevision); /*! * Write the address offset. * - * @param [in] writer Used XML writer. - * @param [in] addressOffset Address offset to be written. + * @param [in] writer Used XML writer. + * @param [in] addressOffset Address offset to be written. */ void writeAddressOffset(QXmlStreamWriter& writer, QString const& addressOffset); /*! * Write the type identifier. * - * @param [in] writer Used XML writer. - * @param [in] registerData Register data containing the type identifier. + * @param [in] writer Used XML writer. + * @param [in] registerData Register data containing the type identifier. */ void writeTypeIdentifier(QXmlStreamWriter& writer, QSharedPointer registerData); /*! * Write the volatile value. * - * @param [in] writer Used XML writer. - * @param [in] registerDefinition The selected register definition. + * @param [in] writer Used XML writer. + * @param [in] registerDefinition The selected register definition. */ void writeVolatile(QXmlStreamWriter& writer, QSharedPointer registerDefinition); /*! * Write the access value. * - * @param [in] writer Used XML writer. - * @param [in] registerDefinition The selected register definition. + * @param [in] writer Used XML writer. + * @param [in] registerDefinition The selected register definition. */ void writeAccess(QXmlStreamWriter& writer, QSharedPointer registerDefinition); /*! * Write the fields. * - * @param [in] writer Used XML writer. - * @param [in] registerDefinition The selected register definition. + * @param [in] writer Used XML writer. + * @param [in] registerDefinition The selected register definition. */ void writeFields(QXmlStreamWriter& writer, QSharedPointer registerDefinition, Document::Revision docRevision); /*! * Write the register alternate registers. * - * @param [in] writer Used XML writer. - * @param [in] targetRegister The selected register. + * @param [in] writer Used XML writer. + * @param [in] targetRegister The selected register. */ void writeAlternateRegisters(QXmlStreamWriter& writer, QSharedPointer targetRegister, Document::Revision docRevision); /*! * Write a single alternate register. * - * @param [in] writer Used XML writer. - * @param [in] alternateRegister The selected alternate register. + * @param [in] writer Used XML writer. + * @param [in] alternateRegister The selected alternate register. */ void writeSingleAlternateRegister(QXmlStreamWriter& writer, QSharedPointer alternateRegister, @@ -109,48 +109,48 @@ namespace RegisterWriter /*! * Write the alternate register alternate groups. * - * @param [in] writer Used XML writer. - * @param [in] alternateRegister The selected alternate register. + * @param [in] writer Used XML writer. + * @param [in] alternateRegister The selected alternate register. */ void writeAlternateGroups(QXmlStreamWriter& writer, QSharedPointer alternateRegister); /*! * Write a register file. * - * @param [in] writer Used XML writer. - * @param [in] registerFile The register file to be written. + * @param [in] writer Used XML writer. + * @param [in] registerFile The register file to be written. */ void writeRegisterFile(QXmlStreamWriter& writer, QSharedPointer registerFile, Document::Revision docRevision); /*! * Write register data contained within a register file. * - * @param [in] writer Used XML writer. - * @param [in] registerFile The register file to be written. + * @param [in] writer Used XML writer. + * @param [in] registerFile The register file to be written. */ void writeRegisterFileRegisterData(QXmlStreamWriter& writer, QSharedPointer registerFile, Document::Revision docRevision); /*! * Write the access policies of the selected register base. * - * @param [in] writer XML writer to use. - * @param [in] targetRegister The selected register base. + * @param [in] writer XML writer to use. + * @param [in] targetRegister The selected register base. */ void writeAccessPolicies(QXmlStreamWriter& writer, QSharedPointer targetRegisterBase); /*! * Write the register definition reference. * - * @param [in] writer XML writer to use. - * @param [in] targetRegister The selected register. + * @param [in] writer XML writer to use. + * @param [in] targetRegister The selected register. */ void writeRegisterDefinitionReference(QXmlStreamWriter& writer, QSharedPointer targetRegister); /*! * Write the register file definition reference. * - * @param [in] writer XML writer to use. - * @param [in] registerFile The register file to be written. + * @param [in] writer XML writer to use. + * @param [in] registerFile The register file to be written. */ void writeRegisterFileDefinitionReference(QXmlStreamWriter& writer, QSharedPointer registerFile); } diff --git a/IPXACTmodels/Component/RemapPort.h b/IPXACTmodels/Component/RemapPort.h index 6398cbb61..55dac7d8e 100644 --- a/IPXACTmodels/Component/RemapPort.h +++ b/IPXACTmodels/Component/RemapPort.h @@ -44,42 +44,42 @@ class IPXACTMODELS_EXPORT RemapPort /*! * Get the value of the port reference. * - * @return The port reference. + * @return The port reference. */ QString getPortNameRef() const; /*! * Set the portNameRef for this remapPort. * - * @param [in] newPortNameRef The new port reference. + * @param [in] newPortNameRef The new port reference. */ void setPortNameRef(QString const& newPortNameRef); /*! * Get index of a port. * - * @return The port index. + * @return The port index. */ QString getPortIndex() const; /*! * Set the port index. * - * @param [in] newPortIndex The new port index. + * @param [in] newPortIndex The new port index. */ void setPortIndex(QString const& newPortIndex); /*! * Get the value of the remapPort element. * - * @return The value of the remap port. + * @return The value of the remap port. */ QString getValue() const; /*! * Set the value for the remapPort element. * - * @param [in] value The new value. + * @param [in] value The new value. */ void setValue(QString const& newValue); diff --git a/IPXACTmodels/Component/RemapState.h b/IPXACTmodels/Component/RemapState.h index db52ad367..eda9974be 100644 --- a/IPXACTmodels/Component/RemapState.h +++ b/IPXACTmodels/Component/RemapState.h @@ -33,21 +33,21 @@ class IPXACTMODELS_EXPORT RemapState : public NameGroup /*! * The constructor. * - * @param [in] name The name of the remap state. + * @param [in] name The name of the remap state. */ RemapState(QString const& name = QString()); /*! * Copy constructor. * - * @param [in] other The remap state to be copied. + * @param [in] other The remap state to be copied. */ RemapState(const RemapState &other); /*! * Assignment operator. * - * @param [in] other The remap state being assigned. + * @param [in] other The remap state being assigned. */ RemapState &operator=(const RemapState &other); @@ -59,14 +59,14 @@ class IPXACTMODELS_EXPORT RemapState : public NameGroup /*! * Get the list of the remap ports for this remap state. * - * @return List containing pointer to the remap port instances. + * @return List containing pointer to the remap port instances. */ QSharedPointer > > getRemapPorts() const; /*! * Set the remap ports. * - * @param [in] newRemapPorts Pointer to a list containing the new remap ports. + * @param [in] newRemapPorts Pointer to a list containing the new remap ports. */ void setRemapPorts(QSharedPointer > > newRemapPorts); @@ -75,7 +75,7 @@ class IPXACTMODELS_EXPORT RemapState : public NameGroup /*! * Copy the remap ports. * - * @param [in] other The copied remap state. + * @param [in] other The copied remap state. */ void copyRemapPorts(const RemapState& other); diff --git a/IPXACTmodels/Component/RemapStateReader.h b/IPXACTmodels/Component/RemapStateReader.h index b85d051e1..73aa49a29 100644 --- a/IPXACTmodels/Component/RemapStateReader.h +++ b/IPXACTmodels/Component/RemapStateReader.h @@ -28,9 +28,9 @@ namespace RemapStateReader /*! * Creates a new remap state from a given view node. * - * @param [in] remapStateNode XML description of the remap state. + * @param [in] remapStateNode XML description of the remap state. * - * @return The created remap state. + * @return The created remap state. */ IPXACTMODELS_EXPORT QSharedPointer createRemapStateFrom(QDomNode const& remapStateNode); @@ -39,32 +39,32 @@ namespace RemapStateReader /*! * Read the remap state name group. * - * @param [in] remapStateNode XML description of the remap state. - * @param [in] newRemapState The selected remap state item. + * @param [in] remapStateNode XML description of the remap state. + * @param [in] newRemapState The selected remap state item. */ void parseNameGroup(QDomNode const& remapStateNode, QSharedPointer newRemapState); /*! * Read the remap ports. * - * @param [in] remapStateNode XML description of the remap state. - * @param [in] newRemapState The selected remap state item. + * @param [in] remapStateNode XML description of the remap state. + * @param [in] newRemapState The selected remap state item. */ void parseRemapPorts(QDomNode const& remapStateNode, QSharedPointer newRemapState); /*! * Read the remap port index. * - * @param [in] remapPortElement XML description of the remap port. - * @param [in] newRemapPort The selected remap port item. + * @param [in] remapPortElement XML description of the remap port. + * @param [in] newRemapPort The selected remap port item. */ void parseRemapPortIndex(QDomElement const& remapPortElement, QSharedPointer newRemapPort); /*! * Read the remap port value. * - * @param [in] remapPortElement XML description of the remap port. - * @param [in] newRemapPort The selected remap port item. + * @param [in] remapPortElement XML description of the remap port. + * @param [in] newRemapPort The selected remap port item. */ void parseRemapPortValue(QDomElement const& remapPortElement, QSharedPointer newRemapPort); }; diff --git a/IPXACTmodels/Component/RemapStateWriter.h b/IPXACTmodels/Component/RemapStateWriter.h index b43b7fac2..6588fd6a0 100644 --- a/IPXACTmodels/Component/RemapStateWriter.h +++ b/IPXACTmodels/Component/RemapStateWriter.h @@ -30,8 +30,8 @@ namespace RemapStateWriter /*! * Write a remap state to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The remap state to be written. + * @param [in] writer The used xml writer. + * @param [in] view The remap state to be written. */ IPXACTMODELS_EXPORT void writeRemapState(QXmlStreamWriter& writer, QSharedPointer remapState); @@ -40,24 +40,24 @@ namespace RemapStateWriter /*! * Write the name group. * - * @param [in] writer Used XML writer. - * @param [in] remapState The selected remap state. + * @param [in] writer Used XML writer. + * @param [in] remapState The selected remap state. */ void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer remapState); /*! * Write the remap ports. * - * @param [in] writer Used XML writer. - * @param [in] remapState The selected remap state. + * @param [in] writer Used XML writer. + * @param [in] remapState The selected remap state. */ void writeRemapPorts(QXmlStreamWriter& writer, QSharedPointer remapState); /*! * Write a single remap port. * - * @param [in] writer Used XML writer. - * @param [in] remapPort The selected remap port. + * @param [in] writer Used XML writer. + * @param [in] remapPort The selected remap port. */ void writeSingleRemapPort(QXmlStreamWriter& writer, QSharedPointer remapPort); }; diff --git a/IPXACTmodels/Component/Segment.h b/IPXACTmodels/Component/Segment.h index f3bb6f33d..3fb7bfaa7 100644 --- a/IPXACTmodels/Component/Segment.h +++ b/IPXACTmodels/Component/Segment.h @@ -33,9 +33,9 @@ class IPXACTMODELS_EXPORT Segment : public Region /*! * The default constructor. * - * @param [in] name Name of the segment. - * @param [in] addressOffset Address offset of the segment. - * @param [in] range Range of the segment. + * @param [in] name Name of the segment. + * @param [in] addressOffset Address offset of the segment. + * @param [in] range Range of the segment. */ Segment(QString const& name = QString(), QString const& addressOffset = QString(), QString const& range = QString()); @@ -52,42 +52,42 @@ class IPXACTMODELS_EXPORT Segment : public Region /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the attributes of the address offset. * - * @return Reference to the QMap containing the attributes as name-value pairs. + * @return Reference to the QMap containing the attributes as name-value pairs. */ QMap getOffsetAttributes() const; /*! * Set the attributes of the address offset. * - * @param [in] offsetAttributes QMap containing the attributes as name-value pairs. + * @param [in] offsetAttributes QMap containing the attributes as name-value pairs. */ void setOffsetAttributes( QMap offsetAttributes ); /*! * Get the attributes of the range. * - * @return Reference to the QMap containing the attributes as name-value pairs. + * @return Reference to the QMap containing the attributes as name-value pairs. */ QMap getRangeAttributes() const; /*! * Set the attributes of the range. * - * @param [in] rangeAttributes QMap containing the attributes as name-value pairs. + * @param [in] rangeAttributes QMap containing the attributes as name-value pairs. */ void setRangeAttributes( QMap rangeAttributes ); diff --git a/IPXACTmodels/Component/Structured.h b/IPXACTmodels/Component/Structured.h index f85e300be..995b25336 100644 --- a/IPXACTmodels/Component/Structured.h +++ b/IPXACTmodels/Component/Structured.h @@ -37,63 +37,63 @@ class IPXACTMODELS_EXPORT Structured /*! * Set the structured port as packed. * - * @param [in] packed Packed or not. + * @param [in] packed Packed or not. */ constexpr void setPacked(bool packed) noexcept { packed_ = packed; } /*! * Check if the structured port can be packed. * - * @return True, if the port can be packed, otherwise false. + * @return True, if the port can be packed, otherwise false. */ [[nodiscard]] bool isPacked() const noexcept { return packed_; } /*! * Set the port type. * - * @param [in] type The type to set. + * @param [in] type The type to set. */ constexpr void setType(Type type) noexcept { portType_ = type; } /*! * Get the port type. * - * @return The port type. + * @return The port type. */ [[nodiscard]] constexpr Type getType() const noexcept { return portType_; } /*! * Set the direction of this port. * - * @param [in] direction The new direction. + * @param [in] direction The new direction. */ constexpr void setDirection(DirectionTypes::Direction direction) noexcept { direction_ = direction; } /*! * Get the direction of the port. * - * @return Enum direction specifying the port direction. + * @return Enum direction specifying the port direction. */ [[nodiscard]] constexpr DirectionTypes::Direction getDirection() const noexcept { return direction_; } /*! * Get the vectors in the structured port. * - * @return The vectors in the port. + * @return The vectors in the port. */ [[nodiscard]] QSharedPointer > getVectors() const { return vectors_; } /*! * Get the sub-ports in the structured port. * - * @return The sub-ports in the port. + * @return The sub-ports in the port. */ [[nodiscard]] SubPort::List getSubPorts() const { return subPorts_; } /*! * Convert the structured type to string. * - * @return The string representation of the type. + * @return The string representation of the type. */ [[nodiscard]] static QString toString(Type type); diff --git a/IPXACTmodels/Component/SubPort.h b/IPXACTmodels/Component/SubPort.h index dfe258ef3..da654358c 100644 --- a/IPXACTmodels/Component/SubPort.h +++ b/IPXACTmodels/Component/SubPort.h @@ -32,56 +32,56 @@ class IPXACTMODELS_EXPORT SubPort : public NameGroup /*! * Set for input, inout or output ports in an interface. * - * @param [in] isIO Wheter the port is an input, inout or output. + * @param [in] isIO Wheter the port is an input, inout or output. */ void setIsIO(bool isIO) noexcept { isIO_ = isIO; } /*! * Check if the port is an input, output or inout. * - * @return True, if the port is input, output or inout, otherwise false. + * @return True, if the port is input, output or inout, otherwise false. */ [[nodiscard]] bool isIO() const noexcept { return isIO_; } /*! * Check if the sub-port has a wire definition. * - * @return True, if the sub-port has a wire, otherwise false. + * @return True, if the sub-port has a wire, otherwise false. */ [[nodiscard]] bool isWire() const noexcept { return wire_.isNull() == false; } /*! * Set the wire port in the sub-port. * - * @param [in] wire The wire to set. + * @param [in] wire The wire to set. */ void setWire(QSharedPointer wire); /*! * Get the wire port in the sub-port. * - * @return The wire port, if available, otherwise nullptr. + * @return The wire port, if available, otherwise nullptr. */ [[nodiscard]] QSharedPointer getWire() const { return wire_; } /*! * Check if the sub-port has a structured definition. * - * @return True, if the sub-port has a structured, otherwise false. + * @return True, if the sub-port has a structured, otherwise false. */ [[nodiscard]] bool isStructured() const noexcept { return structured_.isNull() == false; } /*! * Set the structured port in the sub-port. * - * @param [in] structured The structured port to set. + * @param [in] structured The structured port to set. */ void setStructured(QSharedPointer structured); /*! * Get the structured port in the sub-port. * - * @return The structured port, if available, otherwise nullptr. + * @return The structured port, if available, otherwise nullptr. */ [[nodiscard]] QSharedPointer getStructured() const { return structured_; } diff --git a/IPXACTmodels/Component/SubSpaceMap.h b/IPXACTmodels/Component/SubSpaceMap.h index 77e07bb16..94c01a32f 100644 --- a/IPXACTmodels/Component/SubSpaceMap.h +++ b/IPXACTmodels/Component/SubSpaceMap.h @@ -27,21 +27,21 @@ class IPXACTMODELS_EXPORT SubSpaceMap : public MemoryBlockBase /*! * Constructor for sub space maps. * - * @param [in] name Name of the memory map base. + * @param [in] name Name of the memory map base. */ SubSpaceMap(QString const& name = QString(), QString const& baseAddress = QString()); /*! * Copy constructor. * - * @param [in] other The subspace map to be copied. + * @param [in] other The subspace map to be copied. */ SubSpaceMap(const SubSpaceMap& other); /*! * Assignment operator. * - * @param [in] other The subspace map to be assigned. + * @param [in] other The subspace map to be assigned. */ SubSpaceMap &operator=(const SubSpaceMap& other); @@ -53,35 +53,35 @@ class IPXACTMODELS_EXPORT SubSpaceMap : public MemoryBlockBase /*! * Clone this subspace map item and return pointer to the copy. * - * @return Pointer to the cloned subspace map item. + * @return Pointer to the cloned subspace map item. */ virtual QSharedPointer clone() const; /*! * Get the master interface reference. * - * @return The master reference. + * @return The master reference. */ QString getInitiatorReference() const; /*! * Set the reference to the initiator interface. * - * @param [in] newInitiatorReference The new initiator interface reference. + * @param [in] newInitiatorReference The new initiator interface reference. */ void setInitiatorReference(QString const& newInitiatorReference); /*! * Get the segment reference. * - * @return The segment reference. + * @return The segment reference. */ QString getSegmentReference() const; /*! * Set the segment reference. * - * @param [in] newSegmentReference The new segment reference. + * @param [in] newSegmentReference The new segment reference. */ void setSegmentReference(QString const& newSegmentReference); diff --git a/IPXACTmodels/Component/SubSpaceMapWriter.h b/IPXACTmodels/Component/SubSpaceMapWriter.h index 903de036e..dbd3eba24 100644 --- a/IPXACTmodels/Component/SubSpaceMapWriter.h +++ b/IPXACTmodels/Component/SubSpaceMapWriter.h @@ -29,9 +29,9 @@ namespace SubSpaceMapWriter /*! * Write a subspace map to an XML file. * - * @param [in] writer The used XML writer. - * @param [in] subMap The subspace map to be written. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] writer The used XML writer. + * @param [in] subMap The subspace map to be written. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ IPXACTMODELS_EXPORT void writeSubSpaceMap(QXmlStreamWriter& writer, QSharedPointer subMap, Document::Revision docRevision); @@ -41,9 +41,9 @@ namespace SubSpaceMapWriter /*! * Writes the attributes of a given subspace map into xml. * - * @param [in] writer The xml writer to use. - * @param [in] subMap The subspace map whose attributes to write. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] writer The xml writer to use. + * @param [in] subMap The subspace map whose attributes to write. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void writeAttributes(QXmlStreamWriter& writer, QSharedPointer subMap, Document::Revision docRevision); } diff --git a/IPXACTmodels/Component/SubspaceMapReader.h b/IPXACTmodels/Component/SubspaceMapReader.h index 677551c16..1cf6b50f1 100644 --- a/IPXACTmodels/Component/SubspaceMapReader.h +++ b/IPXACTmodels/Component/SubspaceMapReader.h @@ -29,10 +29,10 @@ namespace SubspaceMapReader /*! * Creates a new subspace map from a given subspace map node. * - * @param [in] subspaceMapNode XML description of the subspace map. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] subspaceMapNode XML description of the subspace map. + * @param [in] docRevision The IP-XACT standard revision to comply to. * - * @return The created subspace map. + * @return The created subspace map. */ IPXACTMODELS_EXPORT QSharedPointer createSubspaceMapFrom(QDomNode const& subspaceMapNode, Document::Revision docRevision); @@ -42,9 +42,9 @@ namespace SubspaceMapReader /*! * Reads the attributes from XML to a subspace map. * - * @param [in] subspaceMapNode The XML description of the subspace map. - * @param [in/out] newSubspaceMap The subspace map to insert the attributes into. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] subspaceMapNode The XML description of the subspace map. + * @param [in/out] newSubspaceMap The subspace map to insert the attributes into. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ void parseAttributes(QDomNode const& subspaceMapNode, QSharedPointer newSubspaceMap, Document::Revision docRevision); diff --git a/IPXACTmodels/Component/TargetInterface.h b/IPXACTmodels/Component/TargetInterface.h index 1df9d5aa0..acccc271b 100644 --- a/IPXACTmodels/Component/TargetInterface.h +++ b/IPXACTmodels/Component/TargetInterface.h @@ -77,13 +77,13 @@ class IPXACTMODELS_EXPORT TargetInterface /*! Get the name of the referenced memory map if any. * - * @return The name of the memory map referenced in the slave interface. + * @return The name of the memory map referenced in the slave interface. */ QString getMemoryMapRef() const; /*! Set the memory map for this interface. * - * @param [in] memoryMapRef The name of the memory map to reference. + * @param [in] memoryMapRef The name of the memory map to reference. */ void setMemoryMapRef(QString const& memoryMapRef); @@ -93,25 +93,25 @@ class IPXACTMODELS_EXPORT TargetInterface /*! Get the bridges for this slave interface. * - * @return The bridges for this slave interface. + * @return The bridges for this slave interface. */ QSharedPointer > > getBridges() const; /*! Check if the slave is connected to a master interface through transparent bridge. * - * @return True if at least one bridge is found, otherwise false. + * @return True if at least one bridge is found, otherwise false. */ bool hasTransparentBridge() const; /*! Get list of the master interfaces referred to through the contained bridge-elements. * - * @return The names of the referred master interfaces. + * @return The names of the referred master interfaces. */ QStringList getMasterReferences() const; /*! Get the fileSetRefGroups for this slave interface. * - * @return The fileSetRefGroups for this slave interface. + * @return The fileSetRefGroups for this slave interface. */ QSharedPointer > > getFileSetRefGroup() const; diff --git a/IPXACTmodels/Component/Transactional.h b/IPXACTmodels/Component/Transactional.h index 5bc9633d3..cd3bb0d13 100644 --- a/IPXACTmodels/Component/Transactional.h +++ b/IPXACTmodels/Component/Transactional.h @@ -38,7 +38,7 @@ class IPXACTMODELS_EXPORT Transactional /*! * Create a copy of the Transactional. * - * @return A Transactional identical to this. + * @return A Transactional identical to this. */ Transactional* clone() const; @@ -60,176 +60,176 @@ class IPXACTMODELS_EXPORT Transactional /*! * Get the all logical initiatives allowed settings. * - * @return True if the logical initiatives are allowed, false otherwise. + * @return True if the logical initiatives are allowed, false otherwise. */ bool getAllLogicalInitiativesAllowed() const; /*! * Set the all logical initiatives to allowed or disallowed. * - * @param [in] allow The new value to be set. + * @param [in] allow The new value to be set. */ void setAllLogicalInitiativesAllowed(bool allow); /*! * Get the initiative. * - * @return The initiative. + * @return The initiative. */ QString getInitiative() const; /*! * Set the initiative. * - * @param [in] newInitiative The new initiative. + * @param [in] newInitiative The new initiative. */ void setInitiative(QString const& newInitiative); /*! * Get the kind. * - * @return The kind. + * @return The kind. */ QString getKind() const; /*! * Set the kind. * - * @param [in] newKind The kind. + * @param [in] newKind The kind. */ void setKind(QString const& newKind); /*! * Get the bus width. * - * @return The bus width. + * @return The bus width. */ QString getBusWidth() const; /*! * Set the bus width. * - * @param [in] newBusWidth The new bus width. + * @param [in] newBusWidth The new bus width. */ void setBusWidth(QString const& newBusWidth); /*! * Get the transactional qualifier. * - * @return The qualifier. + * @return The qualifier. */ QSharedPointer getQualifier() const; /*! * Get the protocol. * - * @return Pointer to a protocol used in this port. + * @return Pointer to a protocol used in this port. */ QSharedPointer getProtocol() const; /*! * Set a protocol for this port. * - * @param [in] newProtocol The new protocol. + * @param [in] newProtocol The new protocol. */ void setProtocol(QSharedPointer newProtocol); /*! * Get the transactional type definitions. * - * @return Pointer to a list containing transactional type definitions. + * @return Pointer to a list containing transactional type definitions. */ QSharedPointer > > getTransTypeDef() const; /*! * Set the transactional type definitions. * - * @param [in] newTransTypeDefs The new transactional type definitions. + * @param [in] newTransTypeDefs The new transactional type definitions. */ void setTransTypeDefs(QSharedPointer > > newTransTypeDefs); /*! * Get the maximum number of possible connections. * - * @return Expression containing the maximum number of connections. + * @return Expression containing the maximum number of connections. */ QString getMaxConnections() const; /*! * Set the maximum number of connections. * - * @param [in] newMaxConnectionsExpression Expression containing the maximum number of connections. + * @param [in] newMaxConnectionsExpression Expression containing the maximum number of connections. */ void setMaxConnections(QString const& newMaxConnectionsExpression); /*! * Get the minimum number of connections. * - * @return The minimum number of connections. + * @return The minimum number of connections. */ QString getMinConnections() const; /*! * Set the minimum number of connections. * - * @param [in] newMinConnectionsExpression The new expression for minimum connections. + * @param [in] newMinConnectionsExpression The new expression for minimum connections. */ void setMinConnections(QString const& newMinConnectionsExpression); /*! * Get a type name associated with a view name. * - * @param [in] viewName The associated view name. + * @param [in] viewName The associated view name. * - * @return The type name. + * @return The type name. */ QString getTypeName(QString const& viewName) const; /*! * Set a type name. * - * @param [in] typeName The new type name. - * @param [in] viewName The view name associated with the new type name. + * @param [in] typeName The new type name. + * @param [in] viewName The view name associated with the new type name. */ void setTypeName(QString const& typeName, QString const& viewName); /*! * Check if a type is contained. * - * @param [in] viewName View name associated with the type. + * @param [in] viewName View name associated with the type. * - * @return True, if a type is contained, false otherwise. + * @return True, if a type is contained, false otherwise. */ bool hasType(QString const& viewName) const; /*! * Get a type definition. * - * @param [in] typeName The name of the type. + * @param [in] typeName The name of the type. * - * @return Type definition associated with the given type name. + * @return Type definition associated with the given type name. */ QString getTypeDefinition(QString const& typeName) const; /*! * Get the type definitions. * - * @return A list of type definitions. + * @return A list of type definitions. */ QStringList getTypeDefinitions() const; /*! * Set a type definition. * - * @param [in] typeName The type name associated with the definition. - * @param [in] typeDefinition The new type definition. + * @param [in] typeName The type name associated with the definition. + * @param [in] typeDefinition The new type definition. */ void setTypeDefinition(const QString& typeName, const QString& typeDefinition); /*! * Check if a type definition exists. * - * @return True, if a type definition exists, false otherwise. + * @return True, if a type definition exists, false otherwise. */ bool hasTypeDefinitions() const; diff --git a/IPXACTmodels/Component/TransparentBridge.h b/IPXACTmodels/Component/TransparentBridge.h index bd841fe01..d9c358f62 100644 --- a/IPXACTmodels/Component/TransparentBridge.h +++ b/IPXACTmodels/Component/TransparentBridge.h @@ -28,7 +28,7 @@ class IPXACTMODELS_EXPORT TransparentBridge : public Extendable /*! * The constructor. * - * @param [in] masterInterfaceRef Name reference to the bridged master interface. + * @param [in] masterInterfaceRef Name reference to the bridged master interface. */ explicit TransparentBridge(QString const& masterInterfaceRef = QString()); @@ -38,42 +38,42 @@ class IPXACTMODELS_EXPORT TransparentBridge : public Extendable /*! * Set the master interface reference. * - * @param [in] interfaceName The master interface name to reference. + * @param [in] interfaceName The master interface name to reference. */ void setMasterRef(QString const& interfaceName); /*! * Get the referenced master interface name. * - * @return The name of the referenced master interface. + * @return The name of the referenced master interface. */ QString getMasterRef() const; /*! * Set the initiator interface reference. * - * @param [in] interfaceName The initiator interface name to reference. + * @param [in] interfaceName The initiator interface name to reference. */ void setInitiatorRef(QString const& interfaceName); /*! * Get the referenced initiator interface name. * - * @return The name of the referenced initiator interface. + * @return The name of the referenced initiator interface. */ QString getInitiatorRef() const; /*! * Sets the presence for the transparent bridge. * - * @param [in] presence The presence to set. + * @param [in] presence The presence to set. */ void setIsPresent(QString const& presence); /*! * Get the presence of the transparent bridge. * - * @return The presence of the transparent bridge. + * @return The presence of the transparent bridge. */ QString getIsPresent() const; diff --git a/IPXACTmodels/Component/View.h b/IPXACTmodels/Component/View.h index f9965bb09..b82df14e7 100644 --- a/IPXACTmodels/Component/View.h +++ b/IPXACTmodels/Component/View.h @@ -60,9 +60,9 @@ class IPXACTMODELS_EXPORT View : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the view. - * @param [in] displayName Display name of the view. - * @param [in] description Description of the view. + * @param [in] name Name of the view. + * @param [in] displayName Display name of the view. + * @param [in] description Description of the view. */ View(QString const& name = QString(), QString const& displayName = QString(), QString const& description = QString()); @@ -85,14 +85,14 @@ class IPXACTMODELS_EXPORT View : public NameGroup, public Extendable /*! * Get a list of envIdentifiers. * - * @return A list containing the envIdentifiers. + * @return A list containing the envIdentifiers. */ QSharedPointer > > getEnvIdentifiers() const; /*! * Add a new envIdentifier for this view. * - * @param [in] envIdentifier The envIdentifier to add. + * @param [in] envIdentifier The envIdentifier to add. */ void addEnvIdentifier(QSharedPointer envIdentifier); @@ -104,63 +104,63 @@ class IPXACTMODELS_EXPORT View : public NameGroup, public Extendable /*! * Gets the presence. * - * @return The presence value. + * @return The presence value. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence value. + * @param [in] newIsPresent The new presence value. */ void setIsPresent(QString const& newIsPresent); /*! * Get the name of the referenced component instantiation. * - * @return The name of the referenced component instantiation. + * @return The name of the referenced component instantiation. */ QString getComponentInstantiationRef() const; /*! * Set a component instantiation reference. * - * @param [in] newInstantiationRef Name of the referenced component instantiation. + * @param [in] newInstantiationRef Name of the referenced component instantiation. */ void setComponentInstantiationRef(QString const& newInstantiationRef); /*! * Get the name of the referenced design instantiation. * - * @return The name of the referenced design instantiation. + * @return The name of the referenced design instantiation. */ QString getDesignInstantiationRef() const; /*! * Set a design instantiation reference. * - * @param [in] newInstantiationRef Name of the referenced design instantiation. + * @param [in] newInstantiationRef Name of the referenced design instantiation. */ void setDesignInstantiationRef(QString const& newInstantiationRef); /*! * Get the name of the referenced design configuration instantiation. * - * @return The name of the referenced design configuration instantiation. + * @return The name of the referenced design configuration instantiation. */ QString getDesignConfigurationInstantiationRef() const; /*! * Set a design configuration instantiation reference. * - * @param [in] newInstantiationRef Name of the referenced design configuration instantiation. + * @param [in] newInstantiationRef Name of the referenced design configuration instantiation. */ void setDesignConfigurationInstantiationRef(QString const& newInstantiationRef); /*! * Check if the view is hierarchical. * - * @return True, if the view is hierarchical, false otherwise. + * @return True, if the view is hierarchical, false otherwise. */ bool isHierarchical() const; diff --git a/IPXACTmodels/Component/ViewReader.h b/IPXACTmodels/Component/ViewReader.h index 3ffe410fe..cfeb225fa 100644 --- a/IPXACTmodels/Component/ViewReader.h +++ b/IPXACTmodels/Component/ViewReader.h @@ -30,10 +30,10 @@ namespace ViewReader /*! * Creates a new view from a given view node. * - * @param [in] viewNode XML description of the view. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] viewNode XML description of the view. + * @param [in] docRevision The IP-XACT standard revision to comply to. * - * @return The created view. + * @return The created view. */ IPXACTMODELS_EXPORT QSharedPointer createViewFrom(QDomNode const& viewNode, Document::Revision docRevision); @@ -43,24 +43,24 @@ namespace ViewReader /*! * Reads the presence. * - * @param [in] viewNode XML description of the view. - * @param [in] newView The new view item. + * @param [in] viewNode XML description of the view. + * @param [in] newView The new view item. */ void parseIsPresent(QDomNode const& viewNode, QSharedPointer newView); /*! * Reads the envIdentifiers. * - * @param [in] viewNode XML description of the view. - * @param [in] newView The new view item. + * @param [in] viewNode XML description of the view. + * @param [in] newView The new view item. */ void parseEnvIdentifiers(QDomNode const& viewNode, QSharedPointer newView); /*! * Reads the instantiation references. * - * @param [in] viewNode XML description of the view. - * @param [in] newView The new view item. + * @param [in] viewNode XML description of the view. + * @param [in] newView The new view item. */ void parseInstantiationRefs(QDomNode const& viewNode, QSharedPointer newView); } diff --git a/IPXACTmodels/Component/ViewWriter.h b/IPXACTmodels/Component/ViewWriter.h index 1d83fc9af..1892ff9d2 100644 --- a/IPXACTmodels/Component/ViewWriter.h +++ b/IPXACTmodels/Component/ViewWriter.h @@ -30,9 +30,9 @@ namespace ViewWriter /*! * Write a view to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The view to be written. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] writer The used xml writer. + * @param [in] view The view to be written. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ IPXACTMODELS_EXPORT void writeView(QXmlStreamWriter& writer, QSharedPointer view, Document::Revision docRevision); @@ -43,24 +43,24 @@ namespace ViewWriter /*! * Writes the presence to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The view to be written. + * @param [in] writer The used xml writer. + * @param [in] view The view to be written. */ void writeIsPresent(QXmlStreamWriter& writer, QSharedPointer view); /*! * Writes the envIdentifiers to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The view to be written. + * @param [in] writer The used xml writer. + * @param [in] view The view to be written. */ void writeEnvIdentifiers(QXmlStreamWriter& writer, QSharedPointer view); /*! * Writes the instantiation references to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] view The view to be written. + * @param [in] writer The used xml writer. + * @param [in] view The view to be written. */ void writeInstantiationReferences(QXmlStreamWriter& writer, QSharedPointer view); } diff --git a/IPXACTmodels/Component/Wire.h b/IPXACTmodels/Component/Wire.h index 6ca698d73..fee79804f 100644 --- a/IPXACTmodels/Component/Wire.h +++ b/IPXACTmodels/Component/Wire.h @@ -52,7 +52,7 @@ class IPXACTMODELS_EXPORT Wire /*! * Create a copy of the Wire. * - * @return A Wire identical to this. + * @return A Wire identical to this. */ Wire* clone() const; @@ -63,98 +63,98 @@ class IPXACTMODELS_EXPORT Wire /*! * Get the value of all logical directions allowed element. * - * @return True if all the logical directions are allowed, false otherwise. + * @return True if all the logical directions are allowed, false otherwise. */ bool getAllLogicalDirectionsAllowed() const; /*! * Get the direction of the port. * - * @return Enum direction specifying the port direction. + * @return Enum direction specifying the port direction. */ DirectionTypes::Direction getDirection() const; /*! * Get the qualifier of the port. * - * @return The wire port qualifier. + * @return The wire port qualifier. */ QSharedPointer getQualifier() const; /*! * Get the vectors element of this port. * - * @return The vectors of the wire. + * @return The vectors of the wire. */ QSharedPointer > getVectors() const; /*! * Get the list of this port's wire type definitions. * - * @return Pointer to a list containing wire type definitions. + * @return Pointer to a list containing wire type definitions. */ QSharedPointer > > getWireTypeDefs() const; /*! * Allow / disallow all logical directions allowed value for this port. * - * @param [in] allow The allowed status. + * @param [in] allow The allowed status. */ void setAllLogicalDirectionsAllowed(bool allow); /*! * Set the direction of this port. * - * @param [in] direction The new direction. + * @param [in] direction The new direction. */ void setDirection(DirectionTypes::Direction direction); /*! * Set the wire type definitions. * - * @param [in] newWireTypeDefs The new wire type definitions. + * @param [in] newWireTypeDefs The new wire type definitions. */ void setWireTypeDefs(QSharedPointer > > newWireTypeDefs); /*! * Get the default driver value for the wire. * - * @return The default value. + * @return The default value. */ QString getDefaultDriverValue() const; /*! * Set the default driver value. * - * @param [in] defaultDriverValue The new default value. + * @param [in] defaultDriverValue The new default value. */ void setDefaultDriverValue(const QString& defaultDriverValue); /*! * Set the left bound expression. * - * @param [in] expression The expression. + * @param [in] expression The expression. */ void setVectorLeftBound(QString const& expression); /*! * Set the right bound expression. * - * @param [in] expression The expression. + * @param [in] expression The expression. */ void setVectorRightBound(QString const& expression); /*! * Get the left bound expression. * - * @return The expression. + * @return The expression. */ QString getVectorLeftBound() const; /*! * Get the right bound expression. * - * @return The expression. + * @return The expression. */ QString getVectorRightBound() const; @@ -165,57 +165,57 @@ class IPXACTMODELS_EXPORT Wire /*! * Get the type name of the port for a given view. * - * @param [in] viewName The name of the used view. + * @param [in] viewName The name of the used view. * - * @return The required type name. + * @return The required type name. */ QString getTypeName(const QString& viewName = QString()) const; /*! * Check if the wire has a type name in given view. * - * @param [in] viewName The name of the view that's type is searched for. + * @param [in] viewName The name of the view that's type is searched for. * - * @return True, if a type is found, false otherwise. + * @return True, if a type is found, false otherwise. */ bool hasType(const QString& viewName = QString()) const; /*! * Check if the port has a type or type definition. * - * @return True, if either the port type name or type definition are defined. + * @return True, if either the port type name or type definition are defined. */ bool hasTypeDefinition() const; /*! * Set the type name for the port in a given view. * - * @param [in] typeName The name of the type. - * @param [in] viewName The name of the view used for this type. + * @param [in] typeName The name of the type. + * @param [in] viewName The name of the view used for this type. */ void setTypeName(const QString& typeName, const QString& viewName = QString()); /*! * Get the type definition of the given type name. * - * @param [in] typeName The name of the type that's type definition is searched for. + * @param [in] typeName The name of the type that's type definition is searched for. * - * @return The required type definition. + * @return The required type definition. */ QString getTypeDefinition(const QString& typeName) const; /*! * Get the type definition. * - * @return A list containing the type definition. + * @return A list containing the type definition. */ QStringList getTypeDefinitions() const; /*! * Set the type definition of the given type name. * - * @param [in] typeName Identifies the type definition. - * @param [in] typeDefinition The new type definition. + * @param [in] typeName Identifies the type definition. + * @param [in] typeDefinition The new type definition. */ void setTypeDefinition(const QString& typeName, const QString& typeDefinition); diff --git a/IPXACTmodels/Component/WireTypeDef.h b/IPXACTmodels/Component/WireTypeDef.h index fba20f80d..475acbc95 100644 --- a/IPXACTmodels/Component/WireTypeDef.h +++ b/IPXACTmodels/Component/WireTypeDef.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT WireTypeDef /*! * The constructor. * - * @param [in] typeName The type name for the wire type definition. + * @param [in] typeName The type name for the wire type definition. */ explicit WireTypeDef(const QString& typeName = QString()); @@ -63,72 +63,72 @@ class IPXACTMODELS_EXPORT WireTypeDef /*! * Check if a wire type definition has been determined for a given view. * - * @param [in] viewName The name of the view to search. + * @param [in] viewName The name of the view to search. * - * @return True, if the view is found within a view name reference. + * @return True, if the view is found within a view name reference. */ bool hasView(QString const& viewName) const; /*! * Get the type name. * - * @return The type name. + * @return The type name. */ QString getTypeName() const; /*! * Set the type name. * - * @param [in] newTypeName The new type name. + * @param [in] newTypeName The new type name. */ void setTypeName(QString const& newTypeName); /*! * Check if the number of bits in the type declaration is fixed. * - * @return True, if the number of bits is fixed, false otherwise. + * @return True, if the number of bits is fixed, false otherwise. */ bool isConstrained() const; /*! * Set the number of bits in the type declaration to be fixed / not fixed. * - * @param [in] constrainedStatus The new status. + * @param [in] constrainedStatus The new status. */ void setConstrained(bool constrainedStatus); /*! * Get the type definitions. * - * @return A list of type definitions. + * @return A list of type definitions. */ QSharedPointer getTypeDefinitions() const; /*! * Set the type definitions. * - * @param [in] newTypeDefinitions A list of new type definitions. + * @param [in] newTypeDefinitions A list of new type definitions. */ void setTypeDefinitions(QSharedPointer newTypeDefinitions); /*! * Get the view references. * - * @return A list of view references. + * @return A list of view references. */ QSharedPointer getViewRefs() const; /*! * Set the view references. * - * @param [in] newViewRefs A new list of view references. + * @param [in] newViewRefs A new list of view references. */ void setViewRefs(QSharedPointer newViewRefs); /*! * Checks if all the fields are empty. * - * @return True, if all the type definition fields are empty, otherwise false. + * @return True, if all the type definition fields are empty, otherwise false. */ bool isEmpty() const; @@ -137,14 +137,14 @@ class IPXACTMODELS_EXPORT WireTypeDef /*! * Copy the type definitions. * - * @param [in] newTypeDefinitions List of new type definitions. + * @param [in] newTypeDefinitions List of new type definitions. */ void copyTypeDefinitions(QStringList const& newTypeDefinitions); /*! * Copy the view references. * - * @param [in] newViewReferences List of new view references. + * @param [in] newViewReferences List of new view references. */ void copyViewNameReferences(QStringList const& newViewReferences); diff --git a/IPXACTmodels/Component/WriteValueConstraint.h b/IPXACTmodels/Component/WriteValueConstraint.h index 9c78d8b94..f8324f36b 100644 --- a/IPXACTmodels/Component/WriteValueConstraint.h +++ b/IPXACTmodels/Component/WriteValueConstraint.h @@ -49,42 +49,42 @@ class IPXACTMODELS_EXPORT WriteValueConstraint /*! * Get the type of the constraint. * - * @return The constraint type. + * @return The constraint type. */ Type getType() const; /*! * Set the type for the constraint. * - * @param [in] newType The new type. + * @param [in] newType The new type. */ void setType(Type newType); /*! * Get the minimum value of the constraint. * - * @return The minimum value. + * @return The minimum value. */ QString getMinimum() const; /*! * Set the minimum value for the constraint. * - * @param [in] newMinimum The minimum value to set. + * @param [in] newMinimum The minimum value to set. */ void setMinimum(QString const& newMinimum); /*! * Get the maximum value of the constraint. * - * @return The maximum value. + * @return The maximum value. */ QString getMaximum() const; /*! * Set the maximum value for the constraint. * - * @param [in] newMaximum The maximum value to set. + * @param [in] newMaximum The maximum value to set. */ void setMaximum(QString const& newMaximum); @@ -112,25 +112,25 @@ namespace WriteValueConversions /*! * Convert a string to write value constraint type. * - * @param [in] typeText The selected string. + * @param [in] typeText The selected string. * - * @return Write value constraint type matching the selected string. + * @return Write value constraint type matching the selected string. */ IPXACTMODELS_EXPORT WriteValueConstraint::Type stringToType(QString const& typeText); /*! * Convert a write value constraint type to string. * - * @param [in] constraintType The selected write value constraint type. + * @param [in] constraintType The selected write value constraint type. * - * @return String matching the selected write value constraint type. + * @return String matching the selected write value constraint type. */ IPXACTMODELS_EXPORT QString typeToString(WriteValueConstraint::Type const& constraintType); /*! * Get a list of all the write value constraint types in string format. * - * @return String list of all the write value constraint types. + * @return String list of all the write value constraint types. */ IPXACTMODELS_EXPORT QStringList getConstraintTypes(); }; diff --git a/IPXACTmodels/Component/validators/AbstractionTypeValidator.h b/IPXACTmodels/Component/validators/AbstractionTypeValidator.h index 141874d18..7dad1c62c 100644 --- a/IPXACTmodels/Component/validators/AbstractionTypeValidator.h +++ b/IPXACTmodels/Component/validators/AbstractionTypeValidator.h @@ -42,10 +42,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * The constructor. * - * @param [in] expressionParser Expression parser. - * @param [in] views Views contained within the component. - * @param [in] portMapValidator Validator for port maps. - * @param [in] library Interface for the VLNV library. + * @param [in] expressionParser Expression parser. + * @param [in] views Views contained within the component. + * @param [in] portMapValidator Validator for port maps. + * @param [in] library Interface for the VLNV library. */ AbstractionTypeValidator(QSharedPointer expressionParser, QSharedPointer > > views, QSharedPointer portMapValidator, @@ -59,8 +59,8 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Change the currently selected component. * - * @param [in] newViews Views contained within the new component. - * @param [in] newPorts Ports contained within the new component. + * @param [in] newViews Views contained within the new component. + * @param [in] newPorts Ports contained within the new component. */ void changeComponent(QSharedPointer > > newViews, QSharedPointer > > newPorts); @@ -68,18 +68,18 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Get the validator for port maps. * - * @return The port map validator. + * @return The port map validator. */ QSharedPointer getPortMapValidator() const; /*! * Validates the given abstraction type. * - * @param [in] abstraction The selected abstraction type. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. - * @param [in] containingBus Bus interface containing the selected abstraction type. + * @param [in] abstraction The selected abstraction type. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] containingBus Bus interface containing the selected abstraction type. * - * @return True, if the selected abstraction type is valid, false otherwise. + * @return True, if the selected abstraction type is valid, false otherwise. */ virtual bool validate(QSharedPointer abstraction, QSharedPointer > > abstractionList, @@ -88,19 +88,19 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the reference to the abstraction definition of the selected abstraction type is valid. * - * @param [in] abstraction The selected abstraction type. + * @param [in] abstraction The selected abstraction type. * - * @return True, if the abstraction reference is valid, false otherwise. + * @return True, if the abstraction reference is valid, false otherwise. */ bool hasValidAbstractionReference(QSharedPointer abstraction) const; /*! * Check if the view references contained within the selected abstraction type are valid. * - * @param [in] abstraction The selected abstraction type. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] abstraction The selected abstraction type. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. * - * @return True, if the view references are valid, false otherwise. + * @return True, if the view references are valid, false otherwise. */ bool hasValidViewReferences(QSharedPointer abstraction, QSharedPointer > > abstractionList) const; @@ -108,10 +108,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the selected view reference is valid. * - * @param [in] viewReference The selected view reference. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] viewReference The selected view reference. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. * - * @return True, if the selected view reference is valid, false otherwise. + * @return True, if the selected view reference is valid, false otherwise. */ bool referencedViewIsValid(QString const& viewReference, QSharedPointer > > abstractionList) const; @@ -119,10 +119,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the port maps contained within the selected abstraction type are valid. * - * @param [in] abstraction The selected abstraction type. - * @param [in] containingBus Bus interface containing the selected abstraction type. + * @param [in] abstraction The selected abstraction type. + * @param [in] containingBus Bus interface containing the selected abstraction type. * - * @return True, if the port maps are valid, false otherwise. + * @return True, if the port maps are valid, false otherwise. */ bool hasValidPortMaps(QSharedPointer abstraction, QSharedPointer containingBus) const; @@ -130,11 +130,11 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Find errors within the selected abstraction type. * - * @param [in/out] errors List of the found errors. - * @param [in] abstraction The selected abstraction type. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. - * @param [in] containingBus Bus interface containing the selected abstraction type. - * @param [in] context Context of the errors. + * @param [in/out] errors List of the found errors. + * @param [in] abstraction The selected abstraction type. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] containingBus Bus interface containing the selected abstraction type. + * @param [in] context Context of the errors. */ virtual void findErrorsIn(QVector& errors, QSharedPointer abstraction, QSharedPointer > > abstractionList, @@ -149,19 +149,19 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the selected view reference exists. * - * @param [in] viewReference The selected view reference. + * @param [in] viewReference The selected view reference. * - * @return True, if the view reference exists, false otherwise. + * @return True, if the view reference exists, false otherwise. */ bool referencedViewExists(QString const& viewReference) const; /*! * Check if the selected view reference is used only once in the containing bus interface. * - * @param [in] viewReference The selected view reference. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] viewReference The selected view reference. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. * - * @return True, if the selected view is referenced once, false otherwise. + * @return True, if the selected view is referenced once, false otherwise. */ bool viewIsReferencedOnce(QString const& viewReference, QSharedPointer > > abstractionList) const; @@ -169,9 +169,9 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Get the abstraction definition referenced by the abstraction type. * - * @param [in] abstractionReference The VLNV reference of the selected abstraction type. + * @param [in] abstractionReference The VLNV reference of the selected abstraction type. * - * @return Abstraction definition matching the selected VLNV reference. + * @return Abstraction definition matching the selected VLNV reference. */ QSharedPointer getAbstractionDefinition( QSharedPointer abstractionReference) const; @@ -179,11 +179,11 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the required logical ports have been mapped. * - * @param [in] containingBus Bus interface containing the abstraction type. - * @param [in] abstractionDefinition Abstraction definition referenced by the abstraction type. - * @param [in] portMaps List of the port maps contained within the abstraction type. + * @param [in] containingBus Bus interface containing the abstraction type. + * @param [in] abstractionDefinition Abstraction definition referenced by the abstraction type. + * @param [in] portMaps List of the port maps contained within the abstraction type. * - * @return True, if the required port abstractions have been mapped, false otherwise. + * @return True, if the required port abstractions have been mapped, false otherwise. */ bool requiredPortAbstractionsAreMapped(QSharedPointer containingBus, QSharedPointer abstractionDefinition, @@ -192,10 +192,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the selected logical port has been referenced in any port maps. * - * @param [in] portName Name of the selected logical port. - * @param [in] portMaps List of the contained port maps. + * @param [in] portName Name of the selected logical port. + * @param [in] portMaps List of the contained port maps. * - * @return True, if the logical port has been mapped, false otherwise. + * @return True, if the logical port has been mapped, false otherwise. */ bool logicalPortHasReferencingPortMaps(QString const& portName, QSharedPointer > > portMaps) const; @@ -203,12 +203,12 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Check if the logical port has valid presence. * - * @param [in] abstractionDefinition Abstraction definition of the abstraction type. - * @param [in] logicalPortName Name of the selected logical port. - * @param [in] mode Interface mode of the containing bus interface. - * @param [in] systemGroup System group used in the containing bus interface. + * @param [in] abstractionDefinition Abstraction definition of the abstraction type. + * @param [in] logicalPortName Name of the selected logical port. + * @param [in] mode Interface mode of the containing bus interface. + * @param [in] systemGroup System group used in the containing bus interface. * - * @return True, if the logical port has valid presence, false otherwise. + * @return True, if the logical port has valid presence, false otherwise. */ bool logicalPortHasValidPresence(QSharedPointer abstractionDefinition, QString const& logicalPortName, General::InterfaceMode mode, QString const& systemGroup) const; @@ -216,10 +216,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Get the selected logical port from the selected abstraction definition. * - * @param [in] portName Name of the selected logical port. - * @param [in] abstractionDefinition The selected abstraction definition. + * @param [in] portName Name of the selected logical port. + * @param [in] abstractionDefinition The selected abstraction definition. * - * @return The logical port with the selected name. + * @return The logical port with the selected name. */ QSharedPointer getLogicalPort(QString const& portName, QSharedPointer abstractionDefinition) const; @@ -227,10 +227,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Find errors within the view references of the selected abstraction type. * - * @param [in/out] errors List of found errors. - * @param [in] abstraction The selected Abstraction type. - * @param [in] abstractionList List of the abstraction types contained within the bus interface. - * @param [in] context Context of the errors. + * @param [in/out] errors List of found errors. + * @param [in] abstraction The selected Abstraction type. + * @param [in] abstractionList List of the abstraction types contained within the bus interface. + * @param [in] context Context of the errors. */ void findErrorsInReferencedViews(QVector& errors, QSharedPointer abstraction, QSharedPointer > > abstractionList, QString const& context) const; @@ -238,9 +238,9 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Find errors within the abstraction definition reference of the selected abstraction type. * - * @param [in/out] errors List of found errors. - * @param [in] abstraction The selected abstraction type. - * @param [in] context Context of the errors. + * @param [in/out] errors List of found errors. + * @param [in] abstraction The selected abstraction type. + * @param [in] context Context of the errors. */ void findErrorsInAbstractionReference(QVector& errors, QSharedPointer abstraction, QString const& context) const; @@ -248,10 +248,10 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Find errors within the port maps of the selected abstraction type. * - * @param [in/out] errors List of found errors. - * @param [in] abstraction The selected abstraction type. - * @param [in] containingBus Bus interface containing the selected abstraction type. - * @param [in] context Context of the errors. + * @param [in/out] errors List of found errors. + * @param [in] abstraction The selected abstraction type. + * @param [in] containingBus Bus interface containing the selected abstraction type. + * @param [in] context Context of the errors. */ void findErrorsInPortMaps(QVector& errors, QSharedPointer abstraction, QSharedPointer containingBus, QString const& context) const; @@ -259,11 +259,11 @@ class IPXACTMODELS_EXPORT AbstractionTypeValidator /*! * Find errors within the required port map logical ports. * - * @param [in/out] errors List of found errors. - * @param [in] context Context of the errors. - * @param [in] busInterface Bus interface containing the abstraction definition reference. - * @param [in] abstractionDefinition The selected abstraction definition. - * @param [in] portMaps List of the port maps. + * @param [in/out] errors List of found errors. + * @param [in] context Context of the errors. + * @param [in] busInterface Bus interface containing the abstraction definition reference. + * @param [in] abstractionDefinition The selected abstraction definition. + * @param [in] portMaps List of the port maps. */ void findErrorsInRequiredPortAbstractions(QVector& errors, QString const& context, QSharedPointer busInterface, diff --git a/IPXACTmodels/Component/validators/AddressBlockValidator.h b/IPXACTmodels/Component/validators/AddressBlockValidator.h index bce56fcd5..1ada11044 100644 --- a/IPXACTmodels/Component/validators/AddressBlockValidator.h +++ b/IPXACTmodels/Component/validators/AddressBlockValidator.h @@ -42,10 +42,10 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] registerValidator Validator used for registers. - * @param [in] parameterValidator Validator used for parameters. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] registerValidator Validator used for registers. + * @param [in] parameterValidator Validator used for parameters. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ AddressBlockValidator(QSharedPointer expressionParser, QSharedPointer registerValidator, @@ -62,69 +62,69 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Change the containing component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void componentChange(QSharedPointer newComponent); /*! * Get the used register validator. * - * @return The used register validator. + * @return The used register validator. */ QSharedPointer getRegisterValidator() const; /*! * Get the used register file validator. * - * @return The used register validator. + * @return The used register validator. */ QSharedPointer getRegisterFileValidator() const; /*! * Validates the given address block. * - * @param [in] addressBlock The address block to validate. - * @param [in] addressUnitBits The address unit bits of a memory map. + * @param [in] addressBlock The address block to validate. + * @param [in] addressUnitBits The address unit bits of a memory map. * - * @return True, if the address block is valid IP-XACT, otherwise false. + * @return True, if the address block is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer addressBlock, QString const& addressUnitBits); /*! * Check if the address block contains a valid range. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool hasValidRange(QSharedPointer addressBlock) const; /*! * Check if the address block contains a valid width. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * - * @return True, if the width is valid, otherwise false. + * @return True, if the width is valid, otherwise false. */ bool hasValidWidth(QSharedPointer addressBlock) const; /*! * Check if the address block contains valid register data. * - * @param [in] addressBlock The selected address block. - * @param [in] addressUnitBits The address unit bits of a memory map. + * @param [in] addressBlock The selected address block. + * @param [in] addressUnitBits The address unit bits of a memory map. * - * @return True, if the register data is valid, otherwise false. + * @return True, if the register data is valid, otherwise false. */ bool hasValidRegisterData(QSharedPointer addressBlock, QString const& addressUnitBits); /*! * Check if the register size is not within address block width. * - * @param [in] targetRegister The selected register. - * @param [in] addressBlock The selected address block. + * @param [in] targetRegister The selected register. + * @param [in] addressBlock The selected address block. * - * @return True, if the register size within address block width, otherwise false. + * @return True, if the register size within address block width, otherwise false. */ bool registerSizeIsNotWithinBlockWidth(QSharedPointer targetRegister, QSharedPointer addressBlock) const; @@ -132,10 +132,10 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if the address block contains a valid volatile value compared to registers. * - * @param [in] addressBlock The selected address block. - * @param [in] targetRegister The selected register. + * @param [in] addressBlock The selected address block. + * @param [in] targetRegister The selected register. * - * @return True, if the volatile is valid, otherwise false. + * @return True, if the volatile is valid, otherwise false. */ bool hasValidVolatileForRegister(QSharedPointer addressBlock, QSharedPointer targetRegister) const; @@ -143,16 +143,16 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if the address block contains a valid usage. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * - * @return True, if the usage is valid, otherwise false. + * @return True, if the usage is valid, otherwise false. */ bool hasValidUsage(QSharedPointer addressBlock) const; /*! * Check if the registers contained within the address block are aligned correctly according to the misalignment allowed attribute. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return Bool, if the registers are aligned correctly, otherwise false. */ @@ -161,7 +161,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if the memory array of the address block is valid. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return True, if the memory array is valid, otherwise false. */ @@ -170,7 +170,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if the address block has valid access policies. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return True, if the access policies are valid, otherwise false. */ @@ -179,7 +179,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if the combination of defined sub-elements of the address block is valid. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return True, if the combination of sub-elements is valid, otherwise false. */ @@ -188,10 +188,10 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Locate errors within an address block. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected address block. - * @param [in] addressUnitBits The address unit bits of a memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected address block. + * @param [in] addressUnitBits The address unit bits of a memory map. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer addressBlock, QString const& addressUnitBits, QString const& context) const; @@ -201,12 +201,12 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Mark overlapping registers as invalid. * - * @param [in] regIter Iterator pointing to current register(file). - * @param [in] lastEndAddress Currently biggest register end address found. - * @param [in] addressBlockRange The address block range. - * @param [in] addressUnitBits The memory map address unit bits. - * @param [in] targetIsRegister Flag indicating if regIter points to register or register file. - * @param [in] lastWasRegister Flag indicating if the previous item was a register or register file. + * @param [in] regIter Iterator pointing to current register(file). + * @param [in] lastEndAddress Currently biggest register end address found. + * @param [in] addressBlockRange The address block range. + * @param [in] addressUnitBits The memory map address unit bits. + * @param [in] targetIsRegister Flag indicating if regIter points to register or register file. + * @param [in] lastWasRegister Flag indicating if the previous item was a register or register file. * * @return True, if overlapping registers and/or register files were found, otherwise false. */ @@ -215,7 +215,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Mark registers with duplicate names as invalid. * - * @param [in] foundNames The registers and register files to check. + * @param [in] foundNames The registers and register files to check. * * @return True, if duplicate names were found, otherwise false. */ @@ -224,18 +224,18 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Get the type of the memory block. * - * @return Identification type of the memory block. + * @return Identification type of the memory block. */ virtual QString getBlockType() const override final; /*! * Check if the contained registers have similar register definitions. * - * @param [in] targetRegister The selected register. - * @param [in] addressBlock The selected address block. - * @param [in] indexOfSimilarDefinition The index of the register with similar register definition. + * @param [in] targetRegister The selected register. + * @param [in] addressBlock The selected address block. + * @param [in] indexOfSimilarDefinition The index of the register with similar register definition. * - * @return True, if the register definitions are similar, otherwise false. + * @return True, if the register definitions are similar, otherwise false. */ bool registersHaveSimilarDefinitionGroups(QSharedPointer targetRegister, QSharedPointer addressBlock, int indexOfSimilarDefinition) const; @@ -243,10 +243,10 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Check if a register contain a valid access. * - * @param [in] addressBlock The selected address block. - * @param [in] targetRegister The selected register. + * @param [in] addressBlock The selected address block. + * @param [in] targetRegister The selected register. * - * @return True, if the register has a valid access, otherwise false. + * @return True, if the register has a valid access, otherwise false. */ bool hasValidAccessWithRegister(QSharedPointer addressBlock, QSharedPointer targetRegister) const; @@ -254,7 +254,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Checks if the address block has any address block definition group elements defined. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return True, if any elements in the address block definition group are defined, otherwise false. */ @@ -263,7 +263,7 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Checks if the address block has any memory block data group elements defined. * - * @param [in] addressBlock The selected address block. + * @param [in] addressBlock The selected address block. * * @return True, if any elements in the memory block data group are defined, otherwise false. */ @@ -272,17 +272,17 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Gets the register size in LAU (least addressable unit). * - * @param [in] targetRegister The selected register. - * @param [in] addressUnitBits The address unit bits of a memory map. + * @param [in] targetRegister The selected register. + * @param [in] addressUnitBits The address unit bits of a memory map. * - * @return The register size in LAU. + * @return The register size in LAU. */ qint64 getRegisterSizeInLAU(QSharedPointer targetRegister, qint64 addressUnitBits) const; /*! * Get register file range (size in AUB) taking dimensions into account. * - * @param [in] targetRegisterFile The register file to get range of. + * @param [in] targetRegisterFile The register file to get range of. * * @return The true register file range. */ @@ -291,9 +291,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within the address block range. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInRange(QVector& errors, QSharedPointer addressBlock, QString const& context) const; @@ -301,9 +301,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within address block width. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInWidth(QVector& errors, QSharedPointer addressBlock, QString const& context) const; @@ -311,9 +311,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within address block usage. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInUsage(QVector& errors, QSharedPointer addressBlock, QString const& context) const; @@ -321,10 +321,10 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within register data. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] addressUnitBits The address unit bits of a memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] addressUnitBits The address unit bits of a memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInRegisterData(QVector& errors, QSharedPointer addressBlock, QString const& addressUnitBits, QString const& context) const; @@ -332,9 +332,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within the address block memory array. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInMemoryArray(QStringList& errors, QSharedPointer addressBlock, QString const& context) const; @@ -342,9 +342,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors within the address block access policies. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInAccessPolicies(QStringList& errors, QSharedPointer addressBlock, QString const& context) const; @@ -352,9 +352,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors regarding the register alignment of the address block registers. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInRegisterAlignment(QStringList& errors, QSharedPointer addressBlock, QString const& context) const; @@ -362,9 +362,9 @@ class IPXACTMODELS_EXPORT AddressBlockValidator : public MemoryBlockValidator /*! * Find errors in the address block structure, the combination of sub-elements. * - * @param [in] errors List of found errors. - * @param [in] addressBlock The selected addressBlock. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressBlock The selected addressBlock. + * @param [in] context Context to help locate the error. */ void findErrorsInStructure(QStringList& errors, QSharedPointer addressBlock, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/AddressSpaceValidator.h b/IPXACTmodels/Component/validators/AddressSpaceValidator.h index 749235370..3e7b6e048 100644 --- a/IPXACTmodels/Component/validators/AddressSpaceValidator.h +++ b/IPXACTmodels/Component/validators/AddressSpaceValidator.h @@ -39,9 +39,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] memoryMapBaseValidator Validator used for local memory map. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] memoryMapBaseValidator Validator used for local memory map. + * @param [in] parameterValidator Validator used for parameters. */ AddressSpaceValidator(QSharedPointer expressionParser, QSharedPointer memoryMapBaseValidator, @@ -53,104 +53,104 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Get the validator used for local memory map. * - * @return The validator used for local memory map. + * @return The validator used for local memory map. */ QSharedPointer getLocalMemoryMapValidator(); /*! * Validates the given address space. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the address space is valid IP-XACT, otherwise false. + * @return True, if the address space is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer addressSpace) const; /*! * Change the containing component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void componentChange(QSharedPointer newComponent); /*! * Check if the name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the is present value is valid. * - * @param [in] isPresent The selected is present value. + * @param [in] isPresent The selected is present value. * - * @return True, if the is present is valid, otherwise false. + * @return True, if the is present is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent) const; /*! * Check if the address space contains a valid range. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool hasValidRange(QSharedPointer addressSpace) const; /*! * Check if the address space contains a valid width. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the width is valid, otherwise false. + * @return True, if the width is valid, otherwise false. */ bool hasValidWidth(QSharedPointer addressSpace) const; /*! * Check if the address space contains valid segments. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the segments are valid, otherwise false. + * @return True, if the segments are valid, otherwise false. */ bool hasValidSegments(QSharedPointer addressSpace) const; /*! * Check if the address space contains a valid address unit bits value. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the address unit bits value is valid, otherwise false. + * @return True, if the address unit bits value is valid, otherwise false. */ bool hasValidAddressUnitBits(QSharedPointer addressSpace) const; /*! * Check if the address space contains a valid local memory map. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the local memory map is valid, otherwise false. + * @return True, if the local memory map is valid, otherwise false. */ bool hasValidLocalMemoryMap(QSharedPointer addressSpace) const; /*! * Check if the address space contains valid parameters. * - * @param [in] addressSpace The selected address space. + * @param [in] addressSpace The selected address space. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer addressSpace) const; /*! * Locate errors within an address space. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -164,25 +164,25 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Check if the segment contains a valid address offset. * - * @param [in] segment The selected segment. + * @param [in] segment The selected segment. * - * @return True, if the address offset is valid, otherwise false. + * @return True, if the address offset is valid, otherwise false. */ bool segmentHasValidAddressOffset(QSharedPointer segment) const; /*! * Check if the segment contains a valid range. * - * @param [in] segment The selected segment. + * @param [in] segment The selected segment. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool segmentHasValidRange(QSharedPointer segment) const; /*! * Check if the address blocks of the local memory map are contained within the address space. * - * @param [in] addressSpace The address space whose local memory map address blocks are checked. + * @param [in] addressSpace The address space whose local memory map address blocks are checked. * * @return True, if address blocks are in the range of the address space, otherwise false. */ @@ -191,8 +191,8 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Check if a single address block in the local memory map of the address space is contained within the address space. * - * @param [in] addressSpace Address space where the address block is contained. - * @param [in] addressBlock The address block to check. + * @param [in] addressSpace Address space where the address block is contained. + * @param [in] addressBlock The address block to check. * * @return True, if the address block is within the address space range. */ @@ -202,9 +202,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator * Find errors in local memory map address block ranges. Issues an error if one or more address blocks * are out of the address space range. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressBlockRanges(QStringList& errors, QSharedPointer addressSpace, QString const& context) const; @@ -212,9 +212,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space name. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -222,9 +222,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space isPresent. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -232,9 +232,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space range. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInRange(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -242,9 +242,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space width. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInWidth(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -252,9 +252,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space segments. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInSegments(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -262,9 +262,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space address unit bits. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressUnitBits(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -272,9 +272,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space local memory map. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInLocalMemoryMap(QVector& errors, QSharedPointer addressSpace, QString const& context) const; @@ -282,9 +282,9 @@ class IPXACTMODELS_EXPORT AddressSpaceValidator : public HierarchicalValidator /*! * Find errors within address space parameters. * - * @param [in] errors List of found errors. - * @param [in] addressSpace The selected address space. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] addressSpace The selected address space. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector& errors, QSharedPointer addressSpace, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/BusInterfaceValidator.h b/IPXACTmodels/Component/validators/BusInterfaceValidator.h index 9e5235dfc..6f1396b1f 100644 --- a/IPXACTmodels/Component/validators/BusInterfaceValidator.h +++ b/IPXACTmodels/Component/validators/BusInterfaceValidator.h @@ -54,19 +54,19 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parse to use for solving expressions. - * @param [in] choices List of available choices. - * @param [in] views List of available views. - * @param [in] ports List of available ports. - * @param [in] addressSpaces List of available address spaces. - * @param [in] memoryMaps List of available memory maps. - * @param [in] busInterfaces List of available bus interfaces. - * @param [in] fileSets List of available file sets. - * @param [in] remapStates List of available remap states. - * @param [in] modes List of available modes. - * @param [in] portMapValidator Validator used for port maps. - * @param [in] parameterValidator Validator used for parameters. - * @param [in] libraryHandler The library interface. + * @param [in] expressionParser The parse to use for solving expressions. + * @param [in] choices List of available choices. + * @param [in] views List of available views. + * @param [in] ports List of available ports. + * @param [in] addressSpaces List of available address spaces. + * @param [in] memoryMaps List of available memory maps. + * @param [in] busInterfaces List of available bus interfaces. + * @param [in] fileSets List of available file sets. + * @param [in] remapStates List of available remap states. + * @param [in] modes List of available modes. + * @param [in] portMapValidator Validator used for port maps. + * @param [in] parameterValidator Validator used for parameters. + * @param [in] libraryHandler The library interface. */ BusInterfaceValidator(QSharedPointer expressionParser, QSharedPointer > > choices, @@ -93,15 +93,15 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Change the available component elements. * - * @param [in] newChoices The new choices. - * @param [in] newViews The new views. - * @param [in] newPorts The new ports. - * @param [in] newAddressSpaces The new address spaces. - * @param [in] newMemoryMaps The new memory maps. - * @param [in] newBusInterfaces The new bus interfaces. - * @param [in] newFileSets The new file sets. - * @param [in] newRemapStates The new remap states. - * @param [in] newRemapStates The new modes. + * @param [in] newChoices The new choices. + * @param [in] newViews The new views. + * @param [in] newPorts The new ports. + * @param [in] newAddressSpaces The new address spaces. + * @param [in] newMemoryMaps The new memory maps. + * @param [in] newBusInterfaces The new bus interfaces. + * @param [in] newFileSets The new file sets. + * @param [in] newRemapStates The new remap states. + * @param [in] newRemapStates The new modes. */ void componentChange(QSharedPointer > > newChoices, QSharedPointer > > newViews, @@ -116,16 +116,16 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Get the used abstraction type validator. * - * @return The used abstraction type validator. + * @return The used abstraction type validator. */ QSharedPointer getAbstractionValidator() const; /*! * Validates the given bus interface. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the bus interface is valid IP-XACT, otherwise false. + * @return True, if the bus interface is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer busInterface, Document::Revision docRevision) const; @@ -133,63 +133,63 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the name is valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer busInterface) const; /*! * Check if the is present value is valid. * - * @param [in] isPresent The selected is present value. + * @param [in] isPresent The selected is present value. * - * @return True, if the is present is valid, otherwise false. + * @return True, if the is present is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent) const; /*! * Check if the bus type is valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the bus type is valid, otherwise false. + * @return True, if the bus type is valid, otherwise false. */ bool hasValidBusType(QSharedPointer busInterface) const; /*! * Check if the abstraction types are valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the abstraction types are valid, otherwise false. + * @return True, if the abstraction types are valid, otherwise false. */ bool hasValidAbstractionTypes(QSharedPointer busInterface) const; /*! * Check if the bus interface mode is valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the bus interface mode is valid, otherwise false. + * @return True, if the bus interface mode is valid, otherwise false. */ bool hasValidInterfaceMode(QSharedPointer busInterface) const; /*! * Check if the bits in LAU value is valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the bits in LAU value is valid, otherwise false. + * @return True, if the bits in LAU value is valid, otherwise false. */ bool hasValidBitsInLAU(QSharedPointer busInterface) const; /*! * Check if the bit steering is valid. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the bit steering is valid, otherwise false. + * @return True, if the bit steering is valid, otherwise false. */ bool hasValidBitSteering(QSharedPointer busInterface, Document::Revision docRevision) const; @@ -199,18 +199,18 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the bus interface contains valid parameters. * - * @param [in] busInterface The selected bus interface. + * @param [in] busInterface The selected bus interface. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer busInterface) const; /*! * Locate errors within a bus interface. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected busInterface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected busInterface. + * @param [in] context Context to help locate the error. */ virtual void findErrorsIn(QVector& errors, QSharedPointer busInterface, QString const& context, Document::Revision docRevision) const; @@ -218,9 +218,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the selected transparent bridges are valid. * - * @param [in] bridges The selected transparent bridges. + * @param [in] bridges The selected transparent bridges. * - * @return True, if the bridges are valid, otherwise false. + * @return True, if the bridges are valid, otherwise false. */ bool hasValidBridges(QSharedPointer > > bridges) const; @@ -229,37 +229,37 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the master interface is valid. * - * @param [in] master The selected master interface. + * @param [in] master The selected master interface. * - * @return True, if the master interface is valid, otherwise false. + * @return True, if the master interface is valid, otherwise false. */ bool hasValidMasterInterface(QSharedPointer master) const; /*! * Check if the initiator interface is valid. * - * @param [in] initiator The selected initiator interface. + * @param [in] initiator The selected initiator interface. * - * @return True, if the initiator interface is valid, otherwise false. + * @return True, if the initiator interface is valid, otherwise false. */ bool hasValidInitiatorInterface(QSharedPointer initiator) const; /*! * Check if the given mode references are valid. * - * @param [in] modeRefs The mode references to check. + * @param [in] modeRefs The mode references to check. * - * @return True, if all the references are valid, otherwise false. + * @return True, if all the references are valid, otherwise false. */ bool hasValidModeRefs(QStringList const& modeRefs) const; /*! * Check if the slave interface is valid. * - * @param [in] busInterface The containing bus interface. - * @param [in] slave The selected slave interface. + * @param [in] busInterface The containing bus interface. + * @param [in] slave The selected slave interface. * - * @return True, if the slave interface is valid, otherwise false. + * @return True, if the slave interface is valid, otherwise false. */ bool hasValidSlaveInterface(QSharedPointer busInterface, QSharedPointer slave) const; @@ -267,10 +267,10 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the target interface is valid. * - * @param [in] busInterface The containing bus interface. - * @param [in] target The selected target interface. + * @param [in] busInterface The containing bus interface. + * @param [in] target The selected target interface. * - * @return True, if the target interface is valid, otherwise false. + * @return True, if the target interface is valid, otherwise false. */ bool hasValidTargetInterface(QSharedPointer busInterface, QSharedPointer target) const; @@ -278,10 +278,10 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the slave interface has a valid memory map reference. * - * @param [in] busInterface The containing bus interface - * @param [in] slave The selected slave interface. + * @param [in] busInterface The containing bus interface + * @param [in] slave The selected slave interface. * - * @return True, if the memory map reference is valid, otherwise false. + * @return True, if the memory map reference is valid, otherwise false. */ bool slaveInterfaceHasValidMemoryMapRef(QSharedPointer busInterface, QSharedPointer slave) const; @@ -289,92 +289,92 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if a slave interface bridge have a valid master interface reference. * - * @param [in] bridge The selected bridge. + * @param [in] bridge The selected bridge. * - * @return True, if the master interface reference is valid, otherwise false. + * @return True, if the master interface reference is valid, otherwise false. */ bool slaveBridgeReferencesValidMaster(QSharedPointer bridge) const; /*! * Check if the slave interface file set reference group is valid. * - * @param [in] slave The selected slave interface. + * @param [in] slave The selected slave interface. * - * @return True, if the slave interface file set reference group is valid, otherwise false. + * @return True, if the slave interface file set reference group is valid, otherwise false. */ bool slaveInterfaceFileSetRefGroupsAreValid(QSharedPointer slave) const; /*! * Check if a file set reference is valid. * - * @param [in] fileSet reference The selected file set reference. + * @param [in] fileSet reference The selected file set reference. * - * @return True, if the file set reference is valid, otherwise false. + * @return True, if the file set reference is valid, otherwise false. */ bool slaveFileSetReferenceIsValid(QSharedPointer fileSetReference) const; /*! * Check if the system interface is valid. * - * @param [in] busInterface The containing bus interface. - * @param [in] systemGroup The selected system group + * @param [in] busInterface The containing bus interface. + * @param [in] systemGroup The selected system group * - * @return True, if the system interface is valid, otherwise false. + * @return True, if the system interface is valid, otherwise false. */ bool hasValidSystemInterface(QSharedPointer busInterface, QString const& systemGroup) const; /*! * Check if the mirrored slave interface is valid. * - * @param [in] mirroredSlave The selected mirrored slave interface. + * @param [in] mirroredSlave The selected mirrored slave interface. * - * @return True, if the mirrored slave interface is valid, otherwise false. + * @return True, if the mirrored slave interface is valid, otherwise false. */ bool hasValidMirroredSlaveInterface(QSharedPointer mirroredSlave) const; /*! * Check if the mirrored target interface is valid. * - * @param [in] mirroredTarget The selected mirrored target interface. + * @param [in] mirroredTarget The selected mirrored target interface. * - * @return True, if the mirrored target interface is valid, otherwise false. + * @return True, if the mirrored target interface is valid, otherwise false. */ bool hasValidMirroredTargetInterface(QSharedPointer mirroredTarget) const; /*! * Check if the mirrored slave interface range is valid. * - * @param [in] mirroredSlave The selected mirrored slave interface. + * @param [in] mirroredSlave The selected mirrored slave interface. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool mirroredSlaveRangeIsValid(QSharedPointer mirroredSlave) const; /*! * Check if the mirrored slave interface remap address is valid. * - * @param [in] remapAddress The selected remap address. + * @param [in] remapAddress The selected remap address. * - * @return True, if the remap address is valid, otherwise false. + * @return True, if the remap address is valid, otherwise false. */ bool mirroredSlaveRemapAddressIsValid(QSharedPointer remapAddress) const; /*! * Check if the mirrored slave interface remap address remap state is valid. * - * @param [in] remapAddress The selected mirrored slave interface remap address. + * @param [in] remapAddress The selected mirrored slave interface remap address. * - * @return True, if the mirrored slave interface remap address is valid, otherwise false. + * @return True, if the mirrored slave interface remap address is valid, otherwise false. */ bool mirroredSlaveStateIsValid(QSharedPointer remapAddress) const; /*! * Check if the monitor interface is valid. * - * @param [in] busInterface The containing bus interface. - * @param [in] monitorInterface The selected monitor interface. + * @param [in] busInterface The containing bus interface. + * @param [in] monitorInterface The selected monitor interface. * - * @return True, if the monitor interface is valid, otherwise false. + * @return True, if the monitor interface is valid, otherwise false. */ bool hasValidMonitorInterface(QSharedPointer busInterface, QSharedPointer monitorInterface) const; @@ -382,19 +382,19 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Check if the interface reference has a valid presence. * - * @param [in] interfacePresence The presence of the original interface. - * @param [in] targetPresence The presence of the target interface. + * @param [in] interfacePresence The presence of the original interface. + * @param [in] targetPresence The presence of the target interface. * - * @return True, if the interface reference has a valid presence, otherwise false. + * @return True, if the interface reference has a valid presence, otherwise false. */ bool interfaceReferenceHasValidPresence(QString const& interfacePresence, QString const& targetPresence) const; /*! * Find errors within name. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -402,9 +402,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within isPresent. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -412,9 +412,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within bus type. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInBusType(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -422,9 +422,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within parameters. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -432,9 +432,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within abstraction types. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInAbstractionTypes(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -442,10 +442,10 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within interface mode. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] busInterfaceContext Context information of the bus interface - * @param [in] containingContext Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] busInterfaceContext Context information of the bus interface + * @param [in] containingContext Context to help locate the error. */ void findErrorsInInterfaceMode(QVector& errors, QSharedPointer busInterface, QString const& busInterfaceContext, QString const& containingContext) const; @@ -453,9 +453,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within master interface. * - * @param [in] errors List of found errors. - * @param [in] master The selected master interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] master The selected master interface. + * @param [in] context Context to help locate the error. */ void findErrorsInMasterInterface(QVector& errors, QSharedPointer master, QString const& context) const; @@ -463,9 +463,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within initiator interface. * - * @param [in] errors List of found errors. - * @param [in] master The selected initiator interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] master The selected initiator interface. + * @param [in] context Context to help locate the error. */ void findErrorsInInitiatorInterface(QVector& errors, QSharedPointer initiator, QString const& context) const; @@ -473,9 +473,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within mode references. * - * @param [in] modeRefs The references to check. - * @param [in] errors List of found errors. - * @param [in] context Context to help locate the error. + * @param [in] modeRefs The references to check. + * @param [in] errors List of found errors. + * @param [in] context Context to help locate the error. */ void findErrorsInModeReferences(QStringList const& modeRefs, QVector& errors, QString const& context) const; @@ -483,20 +483,20 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within slave interface. * - * @param [in] errors List of found errors. - * @param [in] busInterface The containing bus interface. - * @param [in] slave The selected slave interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The containing bus interface. + * @param [in] slave The selected slave interface. + * @param [in] context Context to help locate the error. */ void findErrorsInSlaveInterface(QVector& errors, QSharedPointer busInterface, QSharedPointer slave, QString const& context) const; /*! * Find errors within target interface. * - * @param [in] errors List of found errors. - * @param [in] busInterface The containing bus interface. - * @param [in] target The selected target interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The containing bus interface. + * @param [in] target The selected target interface. + * @param [in] context Context to help locate the error. */ void findErrorsInTargetInterface(QVector& errors, QSharedPointer busInterface, QSharedPointer target, QString const& context) const; @@ -504,10 +504,10 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within system mode. * - * @param [in] errors List of found errors. - * @param [in] systemGroup The selected system group. - * @param [in] busInterface The containing bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] systemGroup The selected system group. + * @param [in] busInterface The containing bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInSystemInterface(QVector& errors, QString const& systemGroup, QSharedPointer busInterface, QString const& context) const; @@ -515,9 +515,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within mirrored slave interface. * - * @param [in] errors List of found errors. - * @param [in] mirroredSlave The selected mirrored slave interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] mirroredSlave The selected mirrored slave interface. + * @param [in] context Context to help locate the error. */ void findErrorsInMirroredSlaveInterface(QVector& errors, QSharedPointer mirroredSlave, QString const& context) const; @@ -525,9 +525,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within mirrored target interface. * - * @param [in] errors List of found errors. - * @param [in] mirroredTarget The selected mirrored target interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] mirroredTarget The selected mirrored target interface. + * @param [in] context Context to help locate the error. */ void findErrorsInMirroredTargetInterface(QVector& errors, QSharedPointer mirroredTarget, QString const& context) const; @@ -535,9 +535,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within monitor interface. * - * @param [in] errors List of found errors. - * @param [in] monitor The selected monitor interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] monitor The selected monitor interface. + * @param [in] context Context to help locate the error. */ void findErrorsInMonitorInterface(QVector& errors, QSharedPointer busInterface, QSharedPointer monitor, QString const& context) const; @@ -545,9 +545,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within bis in LAU. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInBitsInLAU(QVector& errors, QSharedPointer busInterface, QString const& context) const; @@ -555,9 +555,9 @@ class IPXACTMODELS_EXPORT BusInterfaceValidator : public HierarchicalValidator /*! * Find errors within bit steering. * - * @param [in] errors List of found errors. - * @param [in] busInterface The selected bus interface. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] busInterface The selected bus interface. + * @param [in] context Context to help locate the error. */ void findErrorsInBitSteering(QVector& errors, QSharedPointer busInterface, QString const& context, Document::Revision docRevision) const; diff --git a/IPXACTmodels/Component/validators/CPUValidator.h b/IPXACTmodels/Component/validators/CPUValidator.h index f03df0b1a..cd0b853a0 100644 --- a/IPXACTmodels/Component/validators/CPUValidator.h +++ b/IPXACTmodels/Component/validators/CPUValidator.h @@ -41,11 +41,11 @@ class IPXACTMODELS_EXPORT CPUValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] parameterValidator Validator for cpu parameters. - * @param [in] expressionParser Parser for expressions in cpu. - * @param [in] addressSpaces The available address spaces that may be referenced. - * @param [in] addressSpaces The available memory maps that may be referenced. - * @param [in] revision The applied IP-XACT standard revision. + * @param [in] parameterValidator Validator for cpu parameters. + * @param [in] expressionParser Parser for expressions in cpu. + * @param [in] addressSpaces The available address spaces that may be referenced. + * @param [in] addressSpaces The available memory maps that may be referenced. + * @param [in] revision The applied IP-XACT standard revision. */ CPUValidator(QSharedPointer parameterValidator, QSharedPointer expressionParser, @@ -63,9 +63,9 @@ class IPXACTMODELS_EXPORT CPUValidator : public HierarchicalValidator /*! * Change the available address spaces. * - * @param [in] newAddressSpaces The new address spaces. - * @param [in] addressSpaces The available memory maps that may be referenced. - * @param [in] revision The applied IP-XACT standard revision. + * @param [in] newAddressSpaces The new address spaces. + * @param [in] addressSpaces The available memory maps that may be referenced. + * @param [in] revision The applied IP-XACT standard revision. */ void componentChange(QSharedPointer > > newAddressSpaces, QSharedPointer > > memoryMaps, @@ -74,88 +74,88 @@ class IPXACTMODELS_EXPORT CPUValidator : public HierarchicalValidator /*! * Validates the given CPU. * - * @param [in] cpu The CPU to validate. + * @param [in] cpu The CPU to validate. * - * @return True, if the CPU is valid IP-XACT, otherwise false. + * @return True, if the CPU is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer cpu) const; /*! * Checks if the address space references of a CPU are valid. * - * @param [in] cpu The CPU whose address space references to check. + * @param [in] cpu The CPU whose address space references to check. * - * @return True, if the references are valid, otherwise false. + * @return True, if the references are valid, otherwise false. */ bool hasValidAddressSpaceReferences(QSharedPointer cpu) const; /*! * Checks if the memory map reference of a CPU is valid (1865-2022). * - * @param [in] cpu The CPU whose memory map references to check. + * @param [in] cpu The CPU whose memory map references to check. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool hasValidMemoryMapReference(QSharedPointer cpu) const; /*! * Checks if the range of a CPU are valid (1865-2022). * - * @param [in] cpu The CPU whose range to check. + * @param [in] cpu The CPU whose range to check. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool hasValidRange(QSharedPointer cpu) const; /*! * Checks if the width of a CPU are valid (1865-2022). * - * @param [in] cpu The CPU whose width to check. + * @param [in] cpu The CPU whose width to check. * - * @return True, if the width is valid, otherwise false. + * @return True, if the width is valid, otherwise false. */ bool hasValidWidth(QSharedPointer cpu) const; /*! * Checks if the address unit bits of a CPU are valid (1865-2022). * - * @param [in] cpu The CPU whose address unit bits to check. + * @param [in] cpu The CPU whose address unit bits to check. * - * @return True, if the address unit bits are valid, otherwise false. + * @return True, if the address unit bits are valid, otherwise false. */ bool hasValidAddressUnitBits(QSharedPointer cpu) const; /*! * Checks if the regions of a CPU are valid (1865-2022). * - * @param [in] cpu The CPU whose regions to check. + * @param [in] cpu The CPU whose regions to check. * - * @return True, if the regions are valid, otherwise false. + * @return True, if the regions are valid, otherwise false. */ bool hasValidRegions(QSharedPointer testCpu) const; /*! * Finds possible errors in a CPU and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] cpu The CPU whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] cpu The CPU whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer cpu, QString const& context) const; /*! * Finds possible errors in the CPU regions and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] cpu The CPU whose region errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] cpu The CPU whose region errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInRegions(QVector& errors, QSharedPointer cpu, QString const& context) const; /*! * Get the validator used for checking regions. * - * @return The validator for regions. + * @return The validator for regions. */ QSharedPointer getRegionValidator() const; @@ -164,27 +164,27 @@ class IPXACTMODELS_EXPORT CPUValidator : public HierarchicalValidator /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Checks if the given reference to address space is valid. * - * @param [in] reference The name reference for the address space. + * @param [in] reference The name reference for the address space. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool isValidAddressSpaceReference(QString const& reference) const; /*! * Checks if the given reference to a memory map is valid. * - * @param [in] reference The name reference for the memory map. + * @param [in] reference The name reference for the memory map. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool isValidMemoryMapReference(QString const& reference) const; diff --git a/IPXACTmodels/Component/validators/ChannelValidator.h b/IPXACTmodels/Component/validators/ChannelValidator.h index 0e6f88960..106f42e16 100644 --- a/IPXACTmodels/Component/validators/ChannelValidator.h +++ b/IPXACTmodels/Component/validators/ChannelValidator.h @@ -47,16 +47,16 @@ class IPXACTMODELS_EXPORT ChannelValidator /*! * Change the available bus interfaces. * - * @param [in] newBusInterfaces The new bus interfaces. + * @param [in] newBusInterfaces The new bus interfaces. */ void componentChange(QSharedPointer > > newBusInterfaces); /*! * Validates the given Channel. * - * @param [in] Channel The Channel to validate. + * @param [in] Channel The Channel to validate. * - * @return True, if the Channel is valid IP-XACT, otherwise false. + * @return True, if the Channel is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer channel) const; @@ -65,9 +65,9 @@ class IPXACTMODELS_EXPORT ChannelValidator /*! * Finds possible errors in a Channel and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] Channel The Channel whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] Channel The Channel whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer channel, QString const& context) const; @@ -77,27 +77,27 @@ class IPXACTMODELS_EXPORT ChannelValidator /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Checks if the given name for referencing a bus interface is valid. * - * @param [in] interfaceName The name of the bus interface to check. + * @param [in] interfaceName The name of the bus interface to check. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool isValidBusIntefaceReference(QString const& interfaceName) const; /*! * Checks if the given name for referencing a bus interface is for a mirrored interface. * - * @param [in] interfaceName The name of the bus interface to check. + * @param [in] interfaceName The name of the bus interface to check. * - * @return True, if the reference is for a mirrored interface, otherwise false. + * @return True, if the reference is for a mirrored interface, otherwise false. */ bool isReferenceToMirroredInterface(QString const& interfaceName) const; diff --git a/IPXACTmodels/Component/validators/ComponentGeneratorValidator.h b/IPXACTmodels/Component/validators/ComponentGeneratorValidator.h index 10084497b..a04b5fcdb 100644 --- a/IPXACTmodels/Component/validators/ComponentGeneratorValidator.h +++ b/IPXACTmodels/Component/validators/ComponentGeneratorValidator.h @@ -31,8 +31,8 @@ class IPXACTMODELS_EXPORT ComponentGeneratorValidator /*! * The constructor. * - * @param [in] expressionParser The parser used for solving expressions. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser used for solving expressions. + * @param [in] parameterValidator Validator used for parameters. */ ComponentGeneratorValidator(QSharedPointer expressionParser, QSharedPointer parameterValidator); @@ -47,45 +47,45 @@ class IPXACTMODELS_EXPORT ComponentGeneratorValidator /*! * Validates the given component generator. * - * @param [in] generator The component generator to validate. + * @param [in] generator The component generator to validate. * - * @return True, if the component generator is valid IP-XACT, otherwise false. + * @return True, if the component generator is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer generator) const; /*! * Check if the component generator contains a valid name. * - * @param [in] generator The selected component generator. + * @param [in] generator The selected component generator. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer generator) const; /*! * Check if the component generator contains a phase. * - * @param [in] generator The selected component generator. + * @param [in] generator The selected component generator. * - * @return True, if the phase is valid, otherwise false. + * @return True, if the phase is valid, otherwise false. */ bool hasValidPhase(QSharedPointer generator) const; /*! * Check if the component generator contains a valid generator exe. * - * @param [in] generator The selected component generator. + * @param [in] generator The selected component generator. * - * @return True, if the generator exe is valid, otherwise false. + * @return True, if the generator exe is valid, otherwise false. */ bool hasValidGeneratorExe(QSharedPointer generator) const; /*! * Locate errors within a component generator. * - * @param [in] errors List of found errors. - * @param [in] generator The selected component generator. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] generator The selected component generator. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QStringList& errors, QSharedPointer generator, QString const& context) const; @@ -95,9 +95,9 @@ class IPXACTMODELS_EXPORT ComponentGeneratorValidator /*! * Find errors in name. * - * @param [in] errors List of found errors. - * @param [in] generator The selected component generator. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] generator The selected component generator. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QStringList& errors, QSharedPointer generator, QString const& context) const; @@ -105,9 +105,9 @@ class IPXACTMODELS_EXPORT ComponentGeneratorValidator /*! * Find errors in phase. * - * @param [in] errors List of found errors. - * @param [in] generator The selected component generator. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] generator The selected component generator. + * @param [in] context Context to help locate the error. */ void findErrorsInPhase(QStringList& errors, QSharedPointer generator, QString const& context) const; @@ -115,9 +115,9 @@ class IPXACTMODELS_EXPORT ComponentGeneratorValidator /*! * Find errors in generator exe. * - * @param [in] errors List of found errors. - * @param [in] generator The selected component generator. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] generator The selected component generator. + * @param [in] context Context to help locate the error. */ void findErrorsInGeneratorExe(QStringList& errors, QSharedPointer generator, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/ComponentValidator.h b/IPXACTmodels/Component/validators/ComponentValidator.h index 7acc5cf39..2582be384 100644 --- a/IPXACTmodels/Component/validators/ComponentValidator.h +++ b/IPXACTmodels/Component/validators/ComponentValidator.h @@ -58,9 +58,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] modeConditionParserInterface The interface used to create and manage the mode condition parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] modeConditionParserInterface The interface used to create and manage the mode condition parser. + * @param [in] library The used library interface. */ ComponentValidator(QSharedPointer parser, QSharedPointer modeConditionParserInterface, @@ -76,181 +76,181 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Validates the given component. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the component is valid IP-XACT, otherwise false. + * @return True, if the component is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer component); /*! * Check if the component vlnv is valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the vlnv is valid, otherwise false. + * @return True, if the vlnv is valid, otherwise false. */ bool hasValidVLNV(QSharedPointer component) const; /*! * Check if the contained bus interfaces are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the bus interfaces are valid, otherwise false. + * @return True, if the bus interfaces are valid, otherwise false. */ bool hasValidBusInterfaces(QSharedPointer component); /*! * Check if the contained indirect interfaces are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the indirect interfaces are valid, otherwise false. + * @return True, if the indirect interfaces are valid, otherwise false. */ bool hasValidIndirectInterfaces(QSharedPointer component); /*! * Check if the contained channels are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the channels are valid, otherwise false. + * @return True, if the channels are valid, otherwise false. */ bool hasValidChannels(QSharedPointer component); /*! * Check if the contained remap states are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the remap states are valid, otherwise false. + * @return True, if the remap states are valid, otherwise false. */ bool hasValidRemapStates(QSharedPointer component); /*! * Check if the contained modes are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the modes are valid, otherwise false. + * @return True, if the modes are valid, otherwise false. */ bool hasValidModes(QSharedPointer component); /*! * Check if the contained address spaces are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the address spaces are valid, otherwise false. + * @return True, if the address spaces are valid, otherwise false. */ bool hasValidAddressSpaces(QSharedPointer component); /*! * Check if the contained memory maps are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the memory maps are valid, otherwise false. + * @return True, if the memory maps are valid, otherwise false. */ bool hasValidMemoryMaps(QSharedPointer component); /*! * Check if the contained views are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the views are valid, otherwise false. + * @return True, if the views are valid, otherwise false. */ bool hasValidViews(QSharedPointer component); /*! * Check if the contained instantiations are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the instantiations of the selected component are valid, otherwise false. + * @return True, if the instantiations of the selected component are valid, otherwise false. */ bool hasValidInstantiations(QSharedPointer component); /*! * Check if the contained ports are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the ports are valid, otherwise false. + * @return True, if the ports are valid, otherwise false. */ bool hasValidPorts(QSharedPointer component); /*! * Check if the contained component generators are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the component generators are valid, otherwise false. + * @return True, if the component generators are valid, otherwise false. */ bool hasValidComponentGenerators(QSharedPointer component); /*! * Check if the contained choices are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the choices are valid, otherwise false. + * @return True, if the choices are valid, otherwise false. */ bool hasValidChoices(QSharedPointer component); /*! * Check if the contained file sets are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the file sets are valid, otherwise false. + * @return True, if the file sets are valid, otherwise false. */ bool hasValidFileSets(QSharedPointer component); /*! * Check if the contained CPUs are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the CPUs are valid, otherwise false. + * @return True, if the CPUs are valid, otherwise false. */ bool hasValidCPUs(QSharedPointer component); /*! * Check if the contained other clock drivers are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the other clock drivers are valid, otherwise false. + * @return True, if the other clock drivers are valid, otherwise false. */ bool hasValidOtherClockDrivers(QSharedPointer component); /*! * Check if the contained power domains are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the power domains are valid, otherwise false. + * @return True, if the power domains are valid, otherwise false. */ bool hasValidPowerDomains(QSharedPointer component); /*! * Check if the reset types of the selected component are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the reset types are valid, otherwise false. + * @return True, if the reset types are valid, otherwise false. */ bool hasValidResetTypes(QSharedPointer component); /*! * Check if a single reset type is valid. * - * @param [in] resetType The selected reset type. - * @param [in] resetTypes The reset types of the containing component. + * @param [in] resetType The selected reset type. + * @param [in] resetTypes The reset types of the containing component. * - * @return True, if the reset type is valid, otherwise false. + * @return True, if the reset type is valid, otherwise false. */ bool singleResetTypeIsValid(QSharedPointer resetType, QSharedPointer > > resetTypes) const; @@ -258,26 +258,26 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Check if the contained parameters are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer component); /*! * Check if the contained assertions are valid. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the assertions are valid, otherwise false. + * @return True, if the assertions are valid, otherwise false. */ bool hasValidAssertions(QSharedPointer component); /*! * Locate errors within a component. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. + * @param [in] errors List of found errors. + * @param [in] component The selected component. */ void findErrorsIn(QVector& errors, QSharedPointer component); @@ -286,17 +286,17 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in component VLNV. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. + * @param [in] errors List of found errors. + * @param [in] component The selected component. */ void findErrorsInVLNV(QVector& errors, QSharedPointer component) const; /*! * Find errors in bus interfaces. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInBusInterface(QVector& errors, QSharedPointer component, QString const& context) const; @@ -304,18 +304,18 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in indirect interfaces. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInIndirectInterfaces(QVector& errors, QSharedPointer component, QString const& context); /*! * Find errors in channels. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInChannels(QVector& errors, QSharedPointer component, QString const& context) const; @@ -323,9 +323,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in remap states. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInRemapStates(QVector& errors, QSharedPointer component, QString const& context) const; @@ -333,9 +333,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in modes. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInModes(QVector& errors, QSharedPointer component, QString const& context) const; @@ -343,9 +343,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in address spaces. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressSpaces(QVector& errors, QSharedPointer component, QString const& context) const; @@ -353,9 +353,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in memory maps. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInMemoryMaps(QVector& errors, QSharedPointer component, QString const& context) const; @@ -363,9 +363,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in views. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInViews(QVector& errors, QSharedPointer component, QString const& context) const; @@ -373,9 +373,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in component instantiations. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInComponentInstantiations(QVector& errors, QSharedPointer component, QString const& context) const; @@ -383,9 +383,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in design instantiations. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInDesignInstantiations(QVector& errors, QSharedPointer component, QString const& context) const; @@ -393,9 +393,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in design configuration instantiations. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInDesignConfigurationInstantiations(QVector& errors, QSharedPointer component, QString const& context) const; @@ -403,9 +403,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in ports. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInPorts(QVector& errors, QSharedPointer component, QString const& context) const; @@ -413,9 +413,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in component generators. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInComponentGenerators(QVector& errors, QSharedPointer component, QString const& context) const; @@ -423,9 +423,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in choices. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInChoices(QVector& errors, QSharedPointer component, QString const& context) const; @@ -433,9 +433,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in file sets. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInFileSets(QVector& errors, QSharedPointer component, QString const& context) const; @@ -443,9 +443,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in CPUs. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInCPUs(QVector& errors, QSharedPointer component, QString const& context) const; @@ -453,9 +453,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in other clock drivers. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInOtherClockDrivers(QVector& errors, QSharedPointer component, QString const& context) const; @@ -463,18 +463,18 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in power domains. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInPowerDomains(QVector& errors, QSharedPointer component, QString const& context) const; /*! * Find errors in reset types. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInResetTypes(QVector& errors, QSharedPointer component, QString const& context) const; @@ -482,9 +482,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in parameters. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector& errors, QSharedPointer component, QString const& context) const; @@ -492,9 +492,9 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Find errors in assertions. * - * @param [in] errors List of found errors. - * @param [in] component The selected component. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] component The selected component. + * @param [in] context Context to help locate the error. */ void findErrorsInAssertions(QVector& errors, QSharedPointer component, QString const& context) const; @@ -502,7 +502,7 @@ class IPXACTMODELS_EXPORT ComponentValidator /*! * Change the used component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void changeComponent(QSharedPointer newComponent); diff --git a/IPXACTmodels/Component/validators/EnumeratedValueValidator.h b/IPXACTmodels/Component/validators/EnumeratedValueValidator.h index b1cb5abe5..90e2e1222 100644 --- a/IPXACTmodels/Component/validators/EnumeratedValueValidator.h +++ b/IPXACTmodels/Component/validators/EnumeratedValueValidator.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT EnumeratedValueValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] expressionParser The parser to use for solving expressions. */ EnumeratedValueValidator(QSharedPointer expressionParser); @@ -40,36 +40,36 @@ class IPXACTMODELS_EXPORT EnumeratedValueValidator /*! * Validates the given enumerated value. * - * @param [in] enumeratedValue The enumerated value to validate. + * @param [in] enumeratedValue The enumerated value to validate. * - * @return True, if the enumerated value is valid IP-XACT, otherwise false. + * @return True, if the enumerated value is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer enumeratedValue) const; /*! * Check if the enumerated value contains a valid name. * - * @param [in] enumeratedValue The selected enumerated value. + * @param [in] enumeratedValue The selected enumerated value. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer enumeratedValue) const; /*! * Check if the enumerated value contains a valid value. * - * @param [in] enumeratedValue The selected enumerated value. + * @param [in] enumeratedValue The selected enumerated value. * - * @return True, if the value is valid, otherwise false. + * @return True, if the value is valid, otherwise false. */ bool hasValidValue(QSharedPointer enumeratedValue) const; /*! * Locate errors within an enumerated value. * - * @param [in] errors List of found errors. - * @param [in] enumeratedValue The selected enumerated value. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] enumeratedValue The selected enumerated value. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer enumeratedValue, QString const& context) const; @@ -83,9 +83,9 @@ class IPXACTMODELS_EXPORT EnumeratedValueValidator /*! * Find errors within a name. * - * @param [in] errors List of found errors. - * @param [in] enumeratedValue The selected enumerated value. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] enumeratedValue The selected enumerated value. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer enumeratedValue, QString const& context) const; @@ -93,9 +93,9 @@ class IPXACTMODELS_EXPORT EnumeratedValueValidator /*! * Find errors within a value. * - * @param [in] errors List of found errors. - * @param [in] enumeratedValue The selected enumerated value. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] enumeratedValue The selected enumerated value. + * @param [in] context Context to help locate the error. */ void findErrorsInValue(QVector& errors, QSharedPointer enumeratedValue, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/FieldAccessPolicyValidator.h b/IPXACTmodels/Component/validators/FieldAccessPolicyValidator.h index 6f91959ce..3fb6b7171 100644 --- a/IPXACTmodels/Component/validators/FieldAccessPolicyValidator.h +++ b/IPXACTmodels/Component/validators/FieldAccessPolicyValidator.h @@ -33,7 +33,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Validates the given field access policy. * - * @param [in] fieldAccessPolicy The field access policy to validate + * @param [in] fieldAccessPolicy The field access policy to validate * * @return True, if the field access policy is valid, otherwise false. */ @@ -43,9 +43,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Locate errors within a field access policy. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context, QSharedPointer > > availableModes) const; @@ -53,45 +53,45 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Check if the field access policy has a valid access value. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the access is valid, otherwise false. + * @return True, if the access is valid, otherwise false. */ bool hasValidAccess(QSharedPointer fieldAccessPolicy) const; /*! * Check if the field access policy has a valid write value constraint. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the write value constraint is valid, otherwise false. + * @return True, if the write value constraint is valid, otherwise false. */ bool hasValidWriteValueConstraint(QSharedPointer fieldAccessPolicy) const; /*! * Check if the field access policy has a valid read response. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the write read response is valid, otherwise false. + * @return True, if the write read response is valid, otherwise false. */ bool hasValidReadResponse(QSharedPointer fieldAccessPolicy) const; /*! * Check if the field access policy has valid broadcasts. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the broadcasts are valid, otherwise false. + * @return True, if the broadcasts are valid, otherwise false. */ bool hasValidBroadcasts(QSharedPointer fieldAccessPolicy) const; /*! * Check if the field access policy has a valid reserved value. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the broadcasts are valid, otherwise false. + * @return True, if the broadcasts are valid, otherwise false. */ bool hasValidReserved(QSharedPointer fieldAccessPolicy) const; @@ -100,18 +100,18 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Check if the field access policy has a valid field access policy definition reference. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the field access policy definition reference is valid, otherwise false. + * @return True, if the field access policy definition reference is valid, otherwise false. */ bool hasValidDefinitionRef(QSharedPointer fieldAccessPolicy) const; /*! * Check if the access restrictions of the field access policy are valid. * - * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] fieldAccessPolicy The selected field access policy. * - * @return True, if the access restrictions are valid, otherwise false. + * @return True, if the access restrictions are valid, otherwise false. */ bool hasValidAccessRestrictions(QSharedPointer fieldAccessPolicy, QSharedPointer > > availableModes) const; @@ -119,9 +119,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors within the field access policy definition reference. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void finderrorsInDefinitionRef(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -129,9 +129,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors within the access value. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInAccess(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -139,9 +139,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors within the write value constraint. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInWriteValueConstraint(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -149,9 +149,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors in the read response value. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInReadResponse(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -159,9 +159,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors in the broadcasts of the field access policy. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInBroadcasts(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -169,9 +169,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors in the access restrictions of the field access policy. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInAccessRestrictions(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context, QSharedPointer > > availableModes) const; @@ -179,9 +179,9 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Find errors in the reserved value. * - * @param [in] errors List of found errors. - * @param [in] fieldAccessPolicy The selected field access policy. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldAccessPolicy The selected field access policy. + * @param [in] context Context to help locate the error. */ void findErrorsInReserved(QStringList& errors, QSharedPointer fieldAccessPolicy, QString const& context) const; @@ -189,7 +189,7 @@ class IPXACTMODELS_EXPORT FieldAccessPolicyValidator /*! * Check if a given bit expression is valid. * - * @param [in] expression The given bit expression. + * @param [in] expression The given bit expression. * * @return True, if the expression is valid, otherwise false. */ diff --git a/IPXACTmodels/Component/validators/FieldReferenceValidator.h b/IPXACTmodels/Component/validators/FieldReferenceValidator.h index 4cfcbcb8b..e901a86c1 100644 --- a/IPXACTmodels/Component/validators/FieldReferenceValidator.h +++ b/IPXACTmodels/Component/validators/FieldReferenceValidator.h @@ -23,18 +23,18 @@ namespace FieldReferenceValidator /*! * Validates the given field reference. * - * @param [in] fieldReference The field reference to validate. + * @param [in] fieldReference The field reference to validate. * - * @return True, if the field is valid IP-XACT, otherwise false. + * @return True, if the field is valid IP-XACT, otherwise false. */ IPXACTMODELS_EXPORT bool validate(QSharedPointer fieldReference); /*! * Locate errors within a field reference. * - * @param [in] errors List of found errors. - * @param [in] fieldReference The selected field reference. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldReference The selected field reference. + * @param [in] context Context to help locate the error. */ IPXACTMODELS_EXPORT void findErrorsIn(QStringList& errorList, QSharedPointer fieldReference, QString const& context); diff --git a/IPXACTmodels/Component/validators/FieldSliceValidator.h b/IPXACTmodels/Component/validators/FieldSliceValidator.h index 984a9251f..f23c5ec75 100644 --- a/IPXACTmodels/Component/validators/FieldSliceValidator.h +++ b/IPXACTmodels/Component/validators/FieldSliceValidator.h @@ -36,8 +36,8 @@ class IPXACTMODELS_EXPORT FieldSliceValidator /*! * The constructor. * - * @param [in] component The component containing the FieldSlices. - * @param [in] FieldSlice The expression parser for solving expressions in FieldSlices. + * @param [in] component The component containing the FieldSlices. + * @param [in] FieldSlice The expression parser for solving expressions in FieldSlices. * */ FieldSliceValidator(QSharedPointer component, QSharedPointer expressionParser); @@ -52,68 +52,68 @@ class IPXACTMODELS_EXPORT FieldSliceValidator /*! * Validates the given port slice. * - * @param [in] FieldSlice The port slice to validate. + * @param [in] FieldSlice The port slice to validate. * - * @return True, if the FieldSlice is valid IP-XACT, otherwise false. + * @return True, if the FieldSlice is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer portSlice) const; /*! * Validates the port reference in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid port reference, otherwise false. + * @return True, if the portSlice is has a valid port reference, otherwise false. */ bool hasValidFieldReference(QSharedPointer portSlice) const; /*! * Validates the left range in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid left range, otherwise false. + * @return True, if the portSlice is has a valid left range, otherwise false. */ bool hasValidLeftRange(QSharedPointer portSlice) const; /*! * Validates the right range in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid right range, otherwise false. + * @return True, if the portSlice is has a valid right range, otherwise false. */ bool hasValidRightRange(QSharedPointer portSlice) const; /*! * Check if the portSlice name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Finds possible errors in a FieldSlice and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] FieldSlice The FieldSlice whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] FieldSlice The FieldSlice whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer portSlice, QString const& context) const; /*! * Change the active component. * - * @param [in] newComponent List of found errors. + * @param [in] newComponent List of found errors. */ void componentChange(QSharedPointer newComponent); /*! * Set the expression parser to be used. * - * @param [in] expressionParser The expression parser to set. + * @param [in] expressionParser The expression parser to set. */ void setExpressionParser(QSharedPointer expressionParser); @@ -121,20 +121,20 @@ class IPXACTMODELS_EXPORT FieldSliceValidator /* Check if the given value is in the given range. * - * @param [in] value The value to be evaluated. - * @param [in] leftBound The left bound of the range. - * @param [in] rightBound The right bound of the range. + * @param [in] value The value to be evaluated. + * @param [in] leftBound The left bound of the range. + * @param [in] rightBound The right bound of the range. * - * @return True, if the value is in the range, otherwise false. + * @return True, if the value is in the range, otherwise false. */ bool isInValidRange(QString const& value, int leftBound, int rightBound) const; /*! * Find the field referenced in the field slice. * - * @param [in] fieldSlice The field slice whose referenced field to find. + * @param [in] fieldSlice The field slice whose referenced field to find. * - * @return The referenced field. + * @return The referenced field. */ QSharedPointer findField(QSharedPointer fieldSlice) const; @@ -142,10 +142,10 @@ class IPXACTMODELS_EXPORT FieldSliceValidator /*! * Find a referenced item. * - * @param [in] reference The reference to the item. - * @param [in] container The container to search in. + * @param [in] reference The reference to the item. + * @param [in] container The container to search in. * - * @return The referenced item, if found. + * @return The referenced item, if found. */ template QSharedPointer findItem(QSharedPointer reference, diff --git a/IPXACTmodels/Component/validators/FieldValidator.h b/IPXACTmodels/Component/validators/FieldValidator.h index 47f75ac24..9e85e3919 100644 --- a/IPXACTmodels/Component/validators/FieldValidator.h +++ b/IPXACTmodels/Component/validators/FieldValidator.h @@ -42,9 +42,9 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser used to solve expressions. - * @param [in] enumeratedValueValidator Validator used for enumerated values. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser used to solve expressions. + * @param [in] enumeratedValueValidator Validator used for enumerated values. + * @param [in] parameterValidator Validator used for parameters. */ FieldValidator(QSharedPointer expressionParser, QSharedPointer enumeratedValueValidator, @@ -63,48 +63,48 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Change the containing component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void componentChange(QSharedPointer newComponent); /*! * Get the validator used for enumerated values. * - * @return The validator used for enumerated values. + * @return The validator used for enumerated values. */ QSharedPointer getEnumeratedValueValidator() const; /*! * Validates the given field. * - * @param [in] field The field to validate. + * @param [in] field The field to validate. * - * @return True, if the field is valid IP-XACT, otherwise false. + * @return True, if the field is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer field) const; /*! * Check if the field contains a valid name. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer field) const; /*! * Check if the field has a valid presence value. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer field) const; /*! * Check if the field has a valid memory array. * - * @param [in] field The selected field. + * @param [in] field The selected field. * * @return True, if the memory array is valid, otherwise false. */ @@ -113,115 +113,115 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Check if the field has a valid bit offset. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the bit offset is valid, otherwise false. + * @return True, if the bit offset is valid, otherwise false. */ bool hasValidBitOffset(QSharedPointer field) const; /*! * Check if the resets within the field are valid. * - * @param [in] field The field whose resets to check + * @param [in] field The field whose resets to check * - * @return True, if all resets are valid, otherwise false. + * @return True, if all resets are valid, otherwise false. */ bool hasValidResets(QSharedPointer field) const; /*! * Check if the reset type references within a field are valid. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if all reset type references are valid, otherwise false. + * @return True, if all reset type references are valid, otherwise false. */ bool hasValidResetsTypeReferences(QSharedPointer field) const; /*! * Check if the selected reset type reference is valid. * - * @param [in] fieldReset Reset containing the selected reset type reference. + * @param [in] fieldReset Reset containing the selected reset type reference. * - * @return True, if the reset type reference is valid. + * @return True, if the reset type reference is valid. */ bool hasValidResetTypeReference(QSharedPointer fieldReset) const; /*! * Check if the field has a valid reset value. * - * @param [in] fieldReset The selected field reset. + * @param [in] fieldReset The selected field reset. * - * @return True, if the reset value is valid, otherwise false. + * @return True, if the reset value is valid, otherwise false. */ bool hasValidResetValue(QSharedPointer fieldReset) const; /*! * Check if the field has a valid reset mask. * - * @param [in] field The selected field reset. + * @param [in] field The selected field reset. * - * @return True, if the reset mask is valid, otherwise false. + * @return True, if the reset mask is valid, otherwise false. */ bool hasValidResetMask(QSharedPointer fieldReset) const; /*! * Check if the field has a valid write value constraint. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the write value constraint is valid, otherwise false. + * @return True, if the write value constraint is valid, otherwise false. */ bool hasValidWriteValueConstraint(QSharedPointer field) const; /*! * Check if the field has a valid reserved value. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the reserved is valid, otherwise false. + * @return True, if the reserved is valid, otherwise false. */ bool hasValidReserved(QSharedPointer field) const; /*! * Check if the field has a valid bit width. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the bit width is valid, otherwise false. + * @return True, if the bit width is valid, otherwise false. */ bool hasValidBitWidth(QSharedPointer field) const; /*! * Check if the field has valid enumerated values. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the enumerated values are valid, otherwise false. + * @return True, if the enumerated values are valid, otherwise false. */ bool hasValidEnumeratedValues(QSharedPointer field) const; /*! * Check if the field has valid parameters. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer field) const; /*! * Check if the field has a valid access value. * - * @param [in] field The selected field. + * @param [in] field The selected field. * - * @return True, if the access is valid, otherwise false. + * @return True, if the access is valid, otherwise false. */ bool hasValidAccess(QSharedPointer field) const; /*! * Check if the field has a valid field definition reference. * - * @param [in] field The field to check. + * @param [in] field The field to check. * * @return True, if the field definition reference is valid, otherwise false. */ @@ -230,7 +230,7 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Checks that the field has a valid combination of data for 2022 standard. * - * @param [in] field The field to check. + * @param [in] field The field to check. * * @return True, if the field structure is valid, otherwise false. */ @@ -239,7 +239,7 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Checks that the field has valid mode references in its field access policies. * - * @param [in] field The field to check. + * @param [in] field The field to check. * * @return True, if the field mode references valid, otherwise false. */ @@ -249,8 +249,8 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator * Validate the mode references of a single field access policy against mode references of other field access * policies. For validation in UI. * - * @param [in] field The field containing the field access policy. - * @param [in] fieldAccessPolicy The field access policy whose mode referneces are checked. + * @param [in] field The field containing the field access policy. + * @param [in] fieldAccessPolicy The field access policy whose mode referneces are checked. * * @return True, if the mode references are valid, otherwise false. */ @@ -259,9 +259,9 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Locate errors within a field. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer field, QString const& context) const; @@ -270,54 +270,54 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Find errors within field name. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within field is present. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within the memory array of the field. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInMemoryArray(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within field bit offset. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInBitOffset(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within resets. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the errors. */ void findErrorsInResets(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within reset type reference. * - * @param [in] errors List of found errors. - * @param [in] fieldReset The selected reset. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] fieldReset The selected reset. + * @param [in] context Context to help locate the errors. */ void findErrorsInResetTypeReference(QVector& errors, QSharedPointer fieldReset, QString const& context) const; @@ -325,9 +325,9 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Find errors within field reset value. * - * @param [in] errors List of found errors. - * @param [in] fieldReset The selected field reset. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldReset The selected field reset. + * @param [in] context Context to help locate the error. */ void findErrorsInResetValue(QVector& errors, QSharedPointer fieldReset, QString const& context) const; @@ -335,9 +335,9 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Find errors within field reset mask. * - * @param [in] errors List of found errors. - * @param [in] fieldReset The selected field reset. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] fieldReset The selected field reset. + * @param [in] context Context to help locate the error. */ void findErrorsInResetMask(QVector& errors, QSharedPointer fieldReset, QString const& context) const; @@ -345,9 +345,9 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Find errors within field write value constraint. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInWriteValueConstraint(QVector& errors, QSharedPointer field, QString const& context) const; @@ -355,88 +355,88 @@ class IPXACTMODELS_EXPORT FieldValidator : public HierarchicalValidator /*! * Find errors within field reserved value. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInReserved(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within field bit width. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInBitWidth(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within field enumerated values. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. + * @param [in] errors List of found errors. + * @param [in] field The selected field. */ void findErrorsInEnumeratedValues(QVector& errors, QSharedPointer field) const; /*! * Find errors within field parameters. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. + * @param [in] errors List of found errors. + * @param [in] field The selected field. */ void findErrorsInParameters(QVector& errors, QSharedPointer field) const; /*! * Find errors within field access. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInAccess(QVector& errors, QSharedPointer field, QString const& context) const; /*! * Find errors within field definition reference. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInFieldDefinitionRef(QStringList& errors, QSharedPointer field, QString const& context) const; /*! * Check if the field has a valid combination of bit width, volatility, resets and field reference. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ bool hasValidReferenceResetChoice(QSharedPointer field) const; /*! * Find errors in the combination of data set to the field (for standard revision 2022). * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInStructure(QStringList& errors, QSharedPointer field, QString const& context) const; /*! * Find errors in the mode references of the field's field access policies. * - * @param [in] errors List of found errors. - * @param [in] field The selected field. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] field The selected field. + * @param [in] context Context to help locate the error. */ void findErrorsInModeRefs(QStringList& errors, QSharedPointer field, QString const& context) const; /*! * Check if the contained bit expression is valid. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a valid bit expression, otherwise false. + * @return True, if the expression is a valid bit expression, otherwise false. */ bool isBitExpressionValid(QString const& expression) const; diff --git a/IPXACTmodels/Component/validators/FileSetValidator.h b/IPXACTmodels/Component/validators/FileSetValidator.h index 55975035f..bbd9c114c 100644 --- a/IPXACTmodels/Component/validators/FileSetValidator.h +++ b/IPXACTmodels/Component/validators/FileSetValidator.h @@ -48,36 +48,36 @@ class IPXACTMODELS_EXPORT FileSetValidator : public HierarchicalValidator /*! * Validates the given FileSet. * - * @param [in] FileSet The FileSet to validate. + * @param [in] FileSet The FileSet to validate. * - * @return True, if the FileSet is valid IP-XACT, otherwise false. + * @return True, if the FileSet is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer FileSet) const; /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if a file builder has a valid replace default flags value. * - * @param [in] builder The selected file builder. + * @param [in] builder The selected file builder. * - * @return True, if the replace default flags valie is valid, false otherwise. + * @return True, if the replace default flags valie is valid, false otherwise. */ bool fileBuilderHasValidReplaceDefaultFlags(QSharedPointer builder) const; /*! * Finds possible errors in a FileSet and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] FileSet The FileSet whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] FileSet The FileSet whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer FileSet, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/FileValidator.h b/IPXACTmodels/Component/validators/FileValidator.h index 677f7cc81..06bf9d07b 100644 --- a/IPXACTmodels/Component/validators/FileValidator.h +++ b/IPXACTmodels/Component/validators/FileValidator.h @@ -41,36 +41,36 @@ class IPXACTMODELS_EXPORT FileValidator /*! * Validates the given File. * - * @param [in] File The File to validate. + * @param [in] File The File to validate. * - * @return True, if the File is valid IP-XACT, otherwise false. + * @return True, if the File is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer file) const; /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if a build command has a valid replace default flags value. * - * @param [in] buildCommand The selected build command. + * @param [in] buildCommand The selected build command. * - * @return True, if the build command replace default flags is valid, false otherwise. + * @return True, if the build command replace default flags is valid, false otherwise. */ bool buildCommandHasValidReplaceDefaultFlags(QSharedPointer buildCommand) const; /*! * Finds possible errors in a File and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] File The File whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] File The File whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsIn(QVector& errors, QSharedPointer file, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/IndirectInterfaceValidator.h b/IPXACTmodels/Component/validators/IndirectInterfaceValidator.h index 7633ab914..df6e7054b 100644 --- a/IPXACTmodels/Component/validators/IndirectInterfaceValidator.h +++ b/IPXACTmodels/Component/validators/IndirectInterfaceValidator.h @@ -39,9 +39,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * The constructor. * - * @param [in] component The component containing the indirect interface to validate. - * @param [in] parser The expression parser to use in validation. - * @param [in] parameterValidator The validator to use for parameters. + * @param [in] component The component containing the indirect interface to validate. + * @param [in] parser The expression parser to use in validation. + * @param [in] parameterValidator The validator to use for parameters. */ IndirectInterfaceValidator(QSharedPointer component, QSharedPointer parser, @@ -59,90 +59,90 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Validates the given IndirectInterface. * - * @param [in] indirectInterface The indirectInterface to validate. + * @param [in] indirectInterface The indirectInterface to validate. * - * @return True, if the IndirectInterface is valid IP-XACT, otherwise false. + * @return True, if the IndirectInterface is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer indirectInterface) const; /*! * Check if the name is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer indirectInterface) const; /*! * Check if the address field reference is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool hasValidAddressReference(QSharedPointer indirectInterface) const; /*! * Check if the data field reference is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool hasValidDataReference(QSharedPointer indirectInterface) const; /*! * Check if the memory map reference is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool hasValidMemoryMapReference(QSharedPointer testInterface) const; /*! * Check if the selected transparent bridge references are valid. * - * @param [in] bridges The selected transparent bridges. + * @param [in] bridges The selected transparent bridges. * - * @return True, if the references are valid, otherwise false. + * @return True, if the references are valid, otherwise false. */ bool hasValidTransparentBridges(QSharedPointer > > bridges) const; /*! * Check if the bits in lau definition is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the bits in lau definition is valid, otherwise false. + * @return True, if the bits in lau definition is valid, otherwise false. */ bool hasValidBitsInLau(QSharedPointer indirectInterface) const; /*! * Check if the endianness is valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the endianness is valid, otherwise false. + * @return True, if the endianness is valid, otherwise false. */ bool hasValidEndianness(QSharedPointer indirectInterface) const; /*! * Check if the parameters are valid. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer indirectInterface) const; /*! * Finds possible errors in an indirectInterface and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -152,47 +152,47 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds the field with the given Id reference. * - * @param [in] fieldReference The Id of the field to find. + * @param [in] fieldReference The Id of the field to find. * - * @return The found field. + * @return The found field. */ QSharedPointer findField(QString const& fieldReference) const; /*! * Checks if the given field reference is valid. * - * @param [in] fieldReference The Id reference to check. - * @param [in] targetMemoryMap The name of the indirect memory map in the interface. + * @param [in] fieldReference The Id reference to check. + * @param [in] targetMemoryMap The name of the indirect memory map in the interface. * - * @returnTrue, if the reference is valid, otherwise false. + * @returnTrue, if the reference is valid, otherwise false. */ bool isValidFieldReference(QString const& fieldReference, QString const& targetMemoryMap) const; /*! * Checks if the given field is defined within the given memory map. * - * @param [in] memoryMapName The name of the memory map to check. - * @param [in] fieldReference The Id reference of the field to check. + * @param [in] memoryMapName The name of the memory map to check. + * @param [in] fieldReference The Id reference of the field to check. * - * @return True, if the field is defined within the memory map, otherwise false. + * @return True, if the field is defined within the memory map, otherwise false. */ bool memoryMapContainsField(QString const& memoryMapName, QString const& fieldReference) const; /*! * Checks if the given indirect map has either a memory map or transparent bridges but not both. * - * @param [in] indirectInterface The indirect interface to check. + * @param [in] indirectInterface The indirect interface to check. * - * @return True, if either memory map or bridges are defined, otherwise false. + * @return True, if either memory map or bridges are defined, otherwise false. */ bool hasEitherMemoryMapReferenceOrTransparentBridge(QSharedPointer indirectInterface) const; /*! * Finds possible errors in indirectInterface name. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -200,9 +200,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface address reference. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInAddressReference(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -210,9 +210,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface data reference. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInDataReference(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -220,9 +220,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in an indirectInterface defining either a memory map or transparent bridges. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInMemoryReference(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -230,9 +230,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface memory map reference. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInMemoryMap(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -240,9 +240,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface transparent bridges. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInTransparentBridges(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -250,9 +250,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface bits in lau definition. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInBitsInLau(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -260,9 +260,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface endianness. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInEndianness(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; @@ -270,9 +270,9 @@ class IPXACTMODELS_EXPORT IndirectInterfaceValidator : public HierarchicalValida /*! * Finds possible errors in indirectInterface parameters. * - * @param [in] errors List of found errors. - * @param [in] indirectInterface The indirectInterface whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] indirectInterface The indirectInterface whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInParameters(QVector& errors, QSharedPointer indirectInterface, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/InstantiationsValidator.h b/IPXACTmodels/Component/validators/InstantiationsValidator.h index dbb26e0d1..31e2cb287 100644 --- a/IPXACTmodels/Component/validators/InstantiationsValidator.h +++ b/IPXACTmodels/Component/validators/InstantiationsValidator.h @@ -44,10 +44,10 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The used expression parser. - * @param [in] fileSets The available file sets. - * @param [in] parameterValidator The used parameter validator. - * @param [in] libraryHandler The used library interface. + * @param [in] expressionParser The used expression parser. + * @param [in] fileSets The available file sets. + * @param [in] parameterValidator The used parameter validator. + * @param [in] libraryHandler The used library interface. */ InstantiationsValidator(QSharedPointer expressionParser, QSharedPointer > > fileSets, @@ -59,43 +59,43 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Change the available file sets. * - * @param [in] newFileSets The new file sets. + * @param [in] newFileSets The new file sets. */ void componentChange(QSharedPointer > > newFileSets); /*! * Validates the given design instantiation. * - * @param [in] designInstantiation The instantiation to validate. + * @param [in] designInstantiation The instantiation to validate. * - * @return True, if the design instantiation is valid IP-XACT, otherwise false. + * @return True, if the design instantiation is valid IP-XACT, otherwise false. */ bool validateDesignInstantiation(QSharedPointer designInstantiation) const; /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the design reference is valid. * - * @param [in] designInstantiation The selected design instantiation. + * @param [in] designInstantiation The selected design instantiation. * - * @return True, if the reference is valid, otherwise false. + * @return True, if the reference is valid, otherwise false. */ bool hasValidDesignReference(QSharedPointer designInstantiation) const; /*! * Finds possible errors in design instantiation and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] designInstantiation The design instantiation whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designInstantiation The design instantiation whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInDesignInstantiation(QVector& errors, QSharedPointer designInstantiation, QString const& context) const; @@ -103,18 +103,18 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Validates the given design configuration instantiation. * - * @param [in] instantiation The design configuration instantiation to validate. + * @param [in] instantiation The design configuration instantiation to validate. * - * @return True, if the design configuration instantiation is valid IP-XACT, otherwise false. + * @return True, if the design configuration instantiation is valid IP-XACT, otherwise false. */ bool validateDesignConfigurationInstantiation(QSharedPointer instantiation) const; /*! * Check if the design configuration reference is valid. * - * @param [in] instantiation The selected design configuration instantiation. + * @param [in] instantiation The selected design configuration instantiation. * - * @return True, if the design configuration reference is valid, otherwise false. + * @return True, if the design configuration reference is valid, otherwise false. */ bool hasValidDesignConfigurationReference(QSharedPointer instantiation) const; @@ -122,9 +122,9 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Finds possible errors in a design configuration instantiation and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] instantiation The design configuration instantiation whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instantiation The design configuration instantiation whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInDesignConfigurationInstantiation(QVector& errors, QSharedPointer instantiation, QString const& contex) const; @@ -132,9 +132,9 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Validates the given component instantiation. * - * @param [in] instantiation The component instantiation to validate. + * @param [in] instantiation The component instantiation to validate. * - * @return True, if the component instantiation is valid IP-XACT, otherwise false. + * @return True, if the component instantiation is valid IP-XACT, otherwise false. */ bool validateComponentInstantiation(QSharedPointer instantiation, Document::Revision docRevision = Document::Revision::Std14) const; @@ -142,27 +142,27 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Check if the file builders are valid. * - * @param [in] instantiation The selected component instantiation. + * @param [in] instantiation The selected component instantiation. * - * @return True, if the file builders are valid, otherwise false. + * @return True, if the file builders are valid, otherwise false. */ bool componentInstantiationFileBuildersAreValid(QSharedPointer instantiation) const; /*! * Check if the file builder replace default flags value is valid. * - * @param [in] fileBuilder The selected file builder. + * @param [in] fileBuilder The selected file builder. * - * @return True, if the replace default flags value is valid, otherwise false. + * @return True, if the replace default flags value is valid, otherwise false. */ bool fileBuilderReplaceDefaultFlagsIsValid(QSharedPointer fileBuilder) const; /*! * Check if the file set references are valid. * - * @param [in] instantiation The selected component instantiation. + * @param [in] instantiation The selected component instantiation. * - * @return True, if the file set references are valid, otherwise false. + * @return True, if the file set references are valid, otherwise false. */ bool componentInstantiationFileSetReferencesAreValid(QSharedPointer instantiation) const; @@ -170,18 +170,18 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Checks if file set referenced by parameter fileSetRef exist in file sets. * - * @param [in] fileSetRef The selected file set reference. + * @param [in] fileSetRef The selected file set reference. * - * @return True, if the file set reference is valid, otherwise false. + * @return True, if the file set reference is valid, otherwise false. */ bool fileSetReferenceIsValid(QSharedPointer fileSetRef) const; /*! * Finds possible errors in a instantiation and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] instantiation The instantiation whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instantiation The instantiation whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInComponentInstantiation(QVector& errors, QSharedPointer instantiation, QString const& context, @@ -190,7 +190,7 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Get the assigned parameter validator. * - * @return The assigned parameter validator. + * @return The assigned parameter validator. */ QSharedPointer getParameterValidator() const; @@ -203,18 +203,18 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Check if the contained parameters are valid. * - * @param [in] availableParameters The contained parameters. + * @param [in] availableParameters The contained parameters. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer > > availableParameters) const; /*! * Check if the contained module parameters are valid. * - * @param [in] instantiation The selected component instantiation. + * @param [in] instantiation The selected component instantiation. * - * @return True, if the module parameters are valid, otherwise false. + * @return True, if the module parameters are valid, otherwise false. */ bool hasValidModuleParameters(QSharedPointer instantiation, Document::Revision docRevision) const; @@ -222,9 +222,9 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Check if the usage type of a model parameter is valid. * - * @param [in] parameter The model parameter to be evaluated. + * @param [in] parameter The model parameter to be evaluated. * - * @return True, if the usage type is valid, otherwise false. + * @return True, if the usage type is valid, otherwise false. */ bool moduleParameterHasValidUsageType(QSharedPointer parameter, Document::Revision docRevision) const; @@ -232,9 +232,9 @@ class IPXACTMODELS_EXPORT InstantiationsValidator : public HierarchicalValidator /*! * Checks if isPresent element is valid. * - * @param [in] parameter The selected module parameter. + * @param [in] parameter The selected module parameter. * - * @return True, if the presence is a valid expression, otherwise false. + * @return True, if the presence is a valid expression, otherwise false. */ bool moduleParameterHasValidPresence(QSharedPointer parameter) const; diff --git a/IPXACTmodels/Component/validators/MemoryArrayValidator.h b/IPXACTmodels/Component/validators/MemoryArrayValidator.h index c8ddc249e..874c475d6 100644 --- a/IPXACTmodels/Component/validators/MemoryArrayValidator.h +++ b/IPXACTmodels/Component/validators/MemoryArrayValidator.h @@ -27,7 +27,7 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * The constructor. * - * @param [in] expressionParser The expression parser to use. + * @param [in] expressionParser The expression parser to use. */ MemoryArrayValidator(QSharedPointer expressionParser); @@ -39,7 +39,7 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * Validates the given memory array. * - * @param [in] memoryArray The memory array to validate. + * @param [in] memoryArray The memory array to validate. * * @return True, if memory array is valid, otherwise false. */ @@ -48,7 +48,7 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * Checks if a given memory array has dimensions defined. * - * @param [in] memoryArray The memory array to check. + * @param [in] memoryArray The memory array to check. * * @return True, if at least one dimension is defined for the array. */ @@ -57,9 +57,9 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * Finds errors within a memory array. * - * @param [in] errorList A list of found errors. - * @param [in] memoryArray The memory array to check. - * @param [in] context Context to help locate the error. + * @param [in] errorList A list of found errors. + * @param [in] memoryArray The memory array to check. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QStringList& errorList, QSharedPointer memoryArray, QString const& context) const; @@ -70,7 +70,7 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * Validate the (bit)stride of the array. * - * @param [in] memoryArray The memory array to check. + * @param [in] memoryArray The memory array to check. * * @return True, if the stride can be evaluated or is empty, false otherwise. */ @@ -79,8 +79,8 @@ class IPXACTMODELS_EXPORT MemoryArrayValidator /*! * Validates a given value as an unsigned, nonzero long int. * - * @param [in] value The value to check. - * @param [in] canBeEmpty Flag that indicates if the value given can be empty or not. + * @param [in] value The value to check. + * @param [in] canBeEmpty Flag that indicates if the value given can be empty or not. * * @return True, if the given value is valid, false otherwise. */ diff --git a/IPXACTmodels/Component/validators/MemoryBlockValidator.h b/IPXACTmodels/Component/validators/MemoryBlockValidator.h index 21a7e8c7d..5f81e3eda 100644 --- a/IPXACTmodels/Component/validators/MemoryBlockValidator.h +++ b/IPXACTmodels/Component/validators/MemoryBlockValidator.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] parameterValidator Validator used for parameters. */ MemoryBlockValidator(QSharedPointer expressionParser, QSharedPointer parameterValidator, @@ -49,45 +49,45 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Validates the given memory block. * - * @param [in] memoryBlock The memory block to validate. + * @param [in] memoryBlock The memory block to validate. * - * @return True, if the memory block is valid IP-XACT, otherwise false. + * @return True, if the memory block is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer memoryBlock) const; /*! * Check if the memory block contains a valid name. * - * @param [in] memoryBlock The selected memory block. + * @param [in] memoryBlock The selected memory block. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer memoryBlock) const; /*! * Check if the memory block contains a valid isPresent value. * - * @param [in] memoryBlock The selected memory block. + * @param [in] memoryBlock The selected memory block. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer memoryBlock) const; /*! * Check if the memory block contains a valid base address. * - * @param [in] memoryBlock The selected memory block. + * @param [in] memoryBlock The selected memory block. * - * @return True, if the base address is valid, otherwise false. + * @return True, if the base address is valid, otherwise false. */ bool hasValidBaseAddress(QSharedPointer memoryBlock) const; /*! * Check if the memory block contains valid parameters. * - * @param [in] memoryBlock The selected memory block. + * @param [in] memoryBlock The selected memory block. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer memoryBlock) const; @@ -96,16 +96,16 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Get the expression parser. * - * @return The parser for expressions. + * @return The parser for expressions. */ QSharedPointer getExpressionParser() const; /*! * Find errors within a name. * - * @param [in] errors List of found errors. - * @param [in] memoryBlock The selected memory block. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryBlock The selected memory block. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer memoryBlock, QString const& context) const; @@ -113,9 +113,9 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Find errors within isPresent. * - * @param [in] errors List of found errors. - * @param [in] memoryBlock The selected memory block. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryBlock The selected memory block. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer memoryBlock, QString const& context) const; @@ -123,9 +123,9 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Find errors within base address. * - * @param [in] errors List of found errors. - * @param [in] memoryBlock The selected memory block. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryBlock The selected memory block. + * @param [in] context Context to help locate the error. */ void findErrorsInBaseAddress(QVector& errors, QSharedPointer memoryBlock, QString const& context) const; @@ -133,9 +133,9 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Find errors within memory block parameters. * - * @param [in] errors List of found errors. - * @param [in] memoryBlock The selected memory block. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryBlock The selected memory block. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector& errors, QSharedPointer memoryBlock, QString const& context) const; @@ -152,7 +152,7 @@ class IPXACTMODELS_EXPORT MemoryBlockValidator : public HierarchicalValidator /*! * Get the type of the memory block. * - * @return Identification type of the memory block. + * @return Identification type of the memory block. */ virtual QString getBlockType() const = 0; diff --git a/IPXACTmodels/Component/validators/MemoryMapBaseValidator.h b/IPXACTmodels/Component/validators/MemoryMapBaseValidator.h index c717405c0..50af62116 100644 --- a/IPXACTmodels/Component/validators/MemoryMapBaseValidator.h +++ b/IPXACTmodels/Component/validators/MemoryMapBaseValidator.h @@ -44,8 +44,8 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] addressBlockValidator Validator used for address blocks. */ MemoryMapBaseValidator(QSharedPointer expressionParser, QSharedPointer addressBlockValidator, @@ -64,69 +64,69 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Change the containing component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void componentChange(QSharedPointer newComponent); /*! * Get the validator used for address blocks. * - * @return The validator used for address blocks. + * @return The validator used for address blocks. */ QSharedPointer getAddressBlockValidator() const; /*! * Get the validator used for subspace maps. * - * @return The validator used for subspace maps. + * @return The validator used for subspace maps. */ QSharedPointer getSubspaceValidator() const; /*! * Validates the given memory map base. * - * @param [in] memoryMapBase The memory map base to validate. - * @param [in] addressUnitBits The address unit bits used by the memory map. + * @param [in] memoryMapBase The memory map base to validate. + * @param [in] addressUnitBits The address unit bits used by the memory map. * - * @return True, if the memory map base is valid IP-XACT, otherwise false. + * @return True, if the memory map base is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer memoryMapBase, QString const& addressUnitBits); /*! * Check if the memory map base contains a valid name. * - * @param [in] memoryMapBase The selected memory map base. + * @param [in] memoryMapBase The selected memory map base. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer memoryMapBase) const; /*! * Check if the memory map base contains a valid isPresent value. * - * @param [in] memoryMapBase The selected memory map base. + * @param [in] memoryMapBase The selected memory map base. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer memoryMapBase) const; /*! * Check if the memory map base contains valid memory blocks. * - * @param [in] memoryMapBase The selected memory map base. - * @param [in] addressUnitBits The address unit bits used by the memory map. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] addressUnitBits The address unit bits used by the memory map. * - * @return True, if the memory blocks are valid, otherwise false. + * @return True, if the memory blocks are valid, otherwise false. */ bool hasValidMemoryBlocks(QSharedPointer memoryMapBase, QString const& addressUnitBits); /*! * Locate errors within a memory map base. * - * @param [in] errors List of found errors. - * @param [in] memoryMapBase The selected memory map base. - * @param [in] addressUnitBits The address unit bits used by the memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] addressUnitBits The address unit bits used by the memory map. + * @param [in] context Context to help locate the error. */ virtual void findErrorsIn(QVector& errors, QSharedPointer memoryMapBase, QString const& addressUnitBits, QString const& context); @@ -136,7 +136,7 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Get the expression parser. * - * @return The used expression parser. + * @return The used expression parser. */ QSharedPointer getExpressionParser() const; @@ -149,7 +149,7 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Mark address blocks and subspace maps as invalid if they have duplicate names. * - * @param [in] foundNames The found names and associated memory blocks. + * @param [in] foundNames The found names and associated memory blocks. * * @return True, if duplicate names were found, otherwise false. */ @@ -158,8 +158,8 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Check if two memory blocks overlap. * - * @param [in] memoryBlock The selected memory block. - * @param [in] comparedBlock The compared memory block. + * @param [in] memoryBlock The selected memory block. + * @param [in] comparedBlock The compared memory block. */ bool twoMemoryBlocksOverlap(QSharedPointer memoryBlock, QSharedPointer comparedBlock) const; @@ -167,28 +167,28 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Get the range of the selected memory block * - * @param [in] block The selected memory block. + * @param [in] block The selected memory block. * - * @return Range of the selected memory block. + * @return Range of the selected memory block. */ quint64 getBlockRange(QSharedPointer block) const; /*! * Get the address space referenced by the selected subspace map. * - * @param [in] subspace The selected subspace map. + * @param [in] subspace The selected subspace map. * - * @return The referenced address space. + * @return The referenced address space. */ QSharedPointer getReferencedAddressSpace(QSharedPointer subspace) const; /*! * Get the segment referenced by the selected subspace map. * - * @param [in] subspace The selected subspace map. - * @param [in] containingSpace Address space referenced by the subspace map. + * @param [in] subspace The selected subspace map. + * @param [in] containingSpace Address space referenced by the subspace map. * - * @return Segment referened by the selected subspace map. + * @return Segment referened by the selected subspace map. */ QSharedPointer getReferencedSegment(QSharedPointer subspace, QSharedPointer containingSpace) const; @@ -196,10 +196,10 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Check if the address block width is a multiple of address unit bits. * - * @param [in] addressUnitBits The address unit bits. - * @param [in] addressBlock The selected address block. + * @param [in] addressUnitBits The address unit bits. + * @param [in] addressBlock The selected address block. * - * @return True, if the address block width is a multiple of address unit bits, otherwise false. + * @return True, if the address block width is a multiple of address unit bits, otherwise false. */ bool addressBlockWidthIsMultipleOfAUB(QString const& addressUnitBits, QSharedPointer addressBlock) const; @@ -207,9 +207,9 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Find errors within a name. * - * @param [in] errors List of found errors. - * @param [in] memoryMapBase The selected memory map base. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer memoryMapBase, QString const& context) const; @@ -217,9 +217,9 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Find errors within a isPresent. * - * @param [in] errors List of found errors. - * @param [in] memoryMapBase The selected memory map base. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer memoryMapBase, QString const& context) const; @@ -227,10 +227,10 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Find errors within address blocks. * - * @param [in] errors List of found errors. - * @param [in] memoryMapBase The selected memory map base. - * @param [in] addressUnitBits The address unit bits used by the memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] addressUnitBits The address unit bits used by the memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressBlocks(QVector& errors, QSharedPointer memoryMapBase, QString const& addressUnitBits, QString const& context); @@ -238,11 +238,11 @@ class IPXACTMODELS_EXPORT MemoryMapBaseValidator : public HierarchicalValidator /*! * Find errors within overlapping memory blocks. * - * @param [in] errors List of found errors. - * @param [in] memoryMapBase The selected memory map base. - * @param [in] memoryBlock The selected memory block. - * @param [in] blockIndex The index of the address block. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMapBase The selected memory map base. + * @param [in] memoryBlock The selected memory block. + * @param [in] blockIndex The index of the address block. + * @param [in] context Context to help locate the error. */ void findErrorsInOverlappingBlocks(QVector& errors, QSharedPointer memoryMapBase, QSharedPointer memoryBlock, int blockIndex, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/MemoryMapValidator.h b/IPXACTmodels/Component/validators/MemoryMapValidator.h index 837e50cd7..e09796b75 100644 --- a/IPXACTmodels/Component/validators/MemoryMapValidator.h +++ b/IPXACTmodels/Component/validators/MemoryMapValidator.h @@ -37,10 +37,10 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] addressBlockValidator Validator used for address blocks. - * @param [in] subspaceValidator Validator used for subspace maps. - * @param [in] component The containing component. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] subspaceValidator Validator used for subspace maps. + * @param [in] component The containing component. */ MemoryMapValidator(QSharedPointer expressionParser, QSharedPointer addressBlockValidator, @@ -57,43 +57,43 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Change the containing component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void componentChange(QSharedPointer newComponent); /*! * Validates the given memory map. * - * @param [in] memoryMap The memory map to validate. + * @param [in] memoryMap The memory map to validate. * - * @return True, if the memory map is valid IP-XACT, otherwise false. + * @return True, if the memory map is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer memoryMap); /*! * Check if the memory map contains valid address unit bits. * - * @param [in] memoryMap The selected memory map. + * @param [in] memoryMap The selected memory map. * - * @return True, if the address unit bits is valid, otherwise false. + * @return True, if the address unit bits is valid, otherwise false. */ bool hasValidAddressUnitBits(QSharedPointer memoryMap) const; /*! * Check if the memory map contains valid memory remaps. * - * @param [in] memoryMap The selected memory map. + * @param [in] memoryMap The selected memory map. * - * @return True, if the memory remaps are valid, otherwise false. + * @return True, if the memory remaps are valid, otherwise false. */ bool hasValidMemoryRemaps(QSharedPointer memoryMap); /*! * Check if the memory remap remap state is valid. * - * @param [in] memoryRemap The selected memory remap. + * @param [in] memoryRemap The selected memory remap. * - * @return True, if the remap state is valid, otherwise false. + * @return True, if the remap state is valid, otherwise false. */ bool remapStateIsNotValid(QSharedPointer memoryRemap) const; @@ -103,7 +103,7 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator * Check if the memory remap has a valid structure. It cannot simultanously have a * definition reference and defined memory blocks (std 2022). * - * @param [in] memoryRemap The selected memory remap. + * @param [in] memoryRemap The selected memory remap. * * @return True, if the structure is valid, otherwise false. */ @@ -113,7 +113,7 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator * Check if the memory map has a valid structure. It cannot simultanously have a * definition reference and elements defined in the memoryMapGroup (std 2022). * - * @param [in] memoryMap The selected memory map. + * @param [in] memoryMap The selected memory map. * * @return True, if the structure is valid, otherwise false. */ @@ -122,9 +122,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Locate errors within a memory map. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory map. + * @param [in] context Context to help locate the error. */ virtual void findErrorsIn(QVector& errors, QSharedPointer memoryMap, QString const& context); @@ -134,7 +134,7 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Check if memory remaps contain valid mode references. * - * @param [in] memoryMap The memory map whose remaps are checked. + * @param [in] memoryMap The memory map whose remaps are checked. * * @return True, if the mode references of remaps are valid, otherwise false. */ @@ -143,9 +143,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Find errors within the mode references of memory remaps. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInRemapModeRefs(QStringList& errors, QSharedPointer memoryMap, QString const& context) const; @@ -153,9 +153,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Find errors in the structure of the memory map. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInStrucutre(QStringList& errors, QSharedPointer memoryMap, QString const& context) const; @@ -163,9 +163,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Locate errors within memory map address unit bits. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressUnitBits(QVector& errors, QSharedPointer memoryMap, QString const& context) const; @@ -173,9 +173,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Locate errors within memory map memory remaps. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory map. + * @param [in] context Context to help locate the error. */ void findErrorsInMemoryRemaps(QVector& errors, QSharedPointer memoryMap, QString const& context); @@ -183,9 +183,9 @@ class IPXACTMODELS_EXPORT MemoryMapValidator: public MemoryMapBaseValidator /*! * Find errors in the structure of a memory remap. * - * @param [in] errors List of found errors. - * @param [in] memoryMap The selected memory remap. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] memoryMap The selected memory remap. + * @param [in] context Context to help locate the error. */ void findErrorsInRemapStructure(QStringList& errors, QSharedPointer memoryRemap, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/MemoryReserve.h b/IPXACTmodels/Component/validators/MemoryReserve.h index 8538c2cfd..433a1314f 100644 --- a/IPXACTmodels/Component/validators/MemoryReserve.h +++ b/IPXACTmodels/Component/validators/MemoryReserve.h @@ -41,41 +41,41 @@ class IPXACTMODELS_EXPORT MemoryReserve /*! * Reserve an area. * - * @param [in] newId Id of the reserved area. - * @param [in] newBegin Start point of the area. - * @param [in] newEnd End point of the area. + * @param [in] newId Id of the reserved area. + * @param [in] newBegin Start point of the area. + * @param [in] newEnd End point of the area. */ void addArea(QString const& newId, qint64 newBegin, qint64 newEnd); /*! * Check if reserved areas overlap. * - * @return True, if overlap exists, otherwise false. + * @return True, if overlap exists, otherwise false. */ bool hasOverlap(); /*! * Check if the reserved ares with the same identifier overlap. * - * @return True, if overlap exists, otherwise false. + * @return True, if overlap exists, otherwise false. */ bool hasIdDependantOverlap(); /*! * Find errors related to overlapping. * - * @param [in] errors The error list. - * @param [in] itemIdentifier Identifier for the overlapping items. - * @param [in] context Context used to help find the error. + * @param [in] errors The error list. + * @param [in] itemIdentifier Identifier for the overlapping items. + * @param [in] context Context used to help find the error. */ void findErrorsInOverlap(QVector& errors, QString const& itemIdentifier, QString const& context); /*! * Find errors related to overlapping with same identifiers. * - * @param [in] errors The error list. - * @param [in] itemIdentifier Identifier for the overlapping items. - * @param [in] context Context used to help find the errors. + * @param [in] errors The error list. + * @param [in] itemIdentifier Identifier for the overlapping items. + * @param [in] context Context used to help find the errors. */ void findErrorsInIdDependantOverlap(QVector& errors, QString const& itemIdentifier, QString const& context); @@ -102,16 +102,16 @@ class IPXACTMODELS_EXPORT MemoryReserve /*! * Assignment operator for MemoryArea. * - * @param [in] other Memory area to be assigned. + * @param [in] other Memory area to be assigned. * - * @return The newly assigned memory area. + * @return The newly assigned memory area. */ MemoryArea& operator=(const MemoryArea& other) = default; /*! * Check if a memory area has lower start point than another memory area. * - * @param [in] other Memory area being compared to. + * @param [in] other Memory area being compared to. */ bool operator<(const MemoryArea& other) const; }; diff --git a/IPXACTmodels/Component/validators/ModeValidator.h b/IPXACTmodels/Component/validators/ModeValidator.h index 5dc81c9fe..1f8e0d2b5 100644 --- a/IPXACTmodels/Component/validators/ModeValidator.h +++ b/IPXACTmodels/Component/validators/ModeValidator.h @@ -38,9 +38,9 @@ class IPXACTMODELS_EXPORT ModeValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] sliceValidator The validator for port slices. - * @param [in] component The component containing the modes. - * @param [in] mode The expression parser for solving expressions in modes. + * @param [in] sliceValidator The validator for port slices. + * @param [in] component The component containing the modes. + * @param [in] mode The expression parser for solving expressions in modes. * */ ModeValidator( @@ -57,18 +57,18 @@ class IPXACTMODELS_EXPORT ModeValidator : public HierarchicalValidator /*! * Validates the given mode. * - * @param [in] mode The mode to validate. + * @param [in] mode The mode to validate. * - * @return True, if the mode is valid IP-XACT, otherwise false. + * @return True, if the mode is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer mode) const; /*! * Check if the mode name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; @@ -77,9 +77,9 @@ class IPXACTMODELS_EXPORT ModeValidator : public HierarchicalValidator /*! * Check if the port slices are valid. * - * @param [in] mode The mode whose port slices to check. + * @param [in] mode The mode whose port slices to check. * - * @return True, if the slices are valid, otherwise false. + * @return True, if the slices are valid, otherwise false. */ bool hasValidPortSlices(QSharedPointer mode) const; @@ -88,9 +88,9 @@ class IPXACTMODELS_EXPORT ModeValidator : public HierarchicalValidator /*! * Finds possible errors in a mode and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] mode The mode whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] mode The mode whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer mode, QString const& context) const; @@ -107,7 +107,7 @@ class IPXACTMODELS_EXPORT ModeValidator : public HierarchicalValidator /*! * Set the mode condition expression parser. * - * @param [in] expressionParser The parser to set. + * @param [in] expressionParser The parser to set. */ void setConditionParser(QSharedPointer expressionParser); diff --git a/IPXACTmodels/Component/validators/OtherClockDriverValidator.h b/IPXACTmodels/Component/validators/OtherClockDriverValidator.h index bc0872427..51c1cbaa7 100644 --- a/IPXACTmodels/Component/validators/OtherClockDriverValidator.h +++ b/IPXACTmodels/Component/validators/OtherClockDriverValidator.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT OtherClockDriverValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] expressionParser The parser to use for solving expressions. */ OtherClockDriverValidator(QSharedPointer expressionParser); @@ -41,45 +41,45 @@ class IPXACTMODELS_EXPORT OtherClockDriverValidator /*! * Validates the given other clock driver. * - * @param [in] otherClockDriver The selected other clock driver. + * @param [in] otherClockDriver The selected other clock driver. * - * @return True, if the other clock driver is valid IP-XACT, otherwise false. + * @return True, if the other clock driver is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer otherClockDriver) const; /*! * Check if the name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if a clock value is valid. * - * @param [in] clockUnit The selected clock unit. + * @param [in] clockUnit The selected clock unit. * - * @return True, if the clock value is valid, otherwise false. + * @return True, if the clock value is valid, otherwise false. */ bool hasValidClockValue(QSharedPointer clockUnit) const; /*! * Check if the clock pulse value is valid. * - * @param [in] otherClockDriver The selected other clock driver. + * @param [in] otherClockDriver The selected other clock driver. * - * @return True, if the pulse value is valid, otherwise false. + * @return True, if the pulse value is valid, otherwise false. */ bool hasValidClockPulseValue(QSharedPointer otherClockDriver) const; /*! * Locate errors within an other clock driver. * - * @param [in] errors List of found errors. - * @param [in] otherClockDriver The selected other clock driver. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] otherClockDriver The selected other clock driver. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer otherClockDriver, QString const& context) const; @@ -93,9 +93,9 @@ class IPXACTMODELS_EXPORT OtherClockDriverValidator /*! * Find errors within name. * - * @param [in] errors List of found errors. - * @param [in] otherClockDriver The selected other clock driver. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] otherClockDriver The selected other clock driver. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer otherClockDriver, QString const& context) const; @@ -103,9 +103,9 @@ class IPXACTMODELS_EXPORT OtherClockDriverValidator /*! * Find errors within clock units. * - * @param [in] errors List of found errors. - * @param [in] otherClockDriver The selected other clock driver. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] otherClockDriver The selected other clock driver. + * @param [in] context Context to help locate the error. */ void findErrorsInClockUnits(QVector& errors, QSharedPointer otherClockDriver, QString const& context) const; @@ -113,9 +113,9 @@ class IPXACTMODELS_EXPORT OtherClockDriverValidator /*! * Find errors within clock pulse value. * - * @param [in] errors List of found errors. - * @param [in] otherClockDriver The selected other clock driver. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] otherClockDriver The selected other clock driver. + * @param [in] context Context to help locate the error. */ void findErrorsInClockPulseValue(QVector& errors, QSharedPointer otherClockDriver, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/PortMapValidator.h b/IPXACTmodels/Component/validators/PortMapValidator.h index 6bf3d42b6..42dc9ce1f 100644 --- a/IPXACTmodels/Component/validators/PortMapValidator.h +++ b/IPXACTmodels/Component/validators/PortMapValidator.h @@ -36,9 +36,9 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * The constructor. * - * @param [in] parser The parse to use for solving expressions. - * @param [in] ports The available ports. - * @param [in] libraryHandler The library interface. + * @param [in] parser The parse to use for solving expressions. + * @param [in] ports The available ports. + * @param [in] libraryHandler The library interface. */ PortMapValidator(QSharedPointer parser, QSharedPointer > > ports, @@ -56,9 +56,9 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Handle the change in bus interface. * - * @param [in] newAbstractionReference Abstraction definition of the new bus interface. - * @param [in] newInterfaceMode Interface mode of the new bus interface. - * @param [in] newSystemGroup Used system group of the new bus interface. + * @param [in] newAbstractionReference Abstraction definition of the new bus interface. + * @param [in] newInterfaceMode Interface mode of the new bus interface. + * @param [in] newSystemGroup Used system group of the new bus interface. */ void busInterfaceChanged(QSharedPointer newAbstractionReference, General::InterfaceMode newInterfaceMode, @@ -67,8 +67,8 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Handle the change of abstraction definition. * - * @param [in] newDefinition The new abstraction definition. - * @param [in] newInterfaceMode The new interface mode. + * @param [in] newDefinition The new abstraction definition. + * @param [in] newInterfaceMode The new interface mode. */ void abstractionDefinitionChanged(QSharedPointer newDefinition, General::InterfaceMode newInterfaceMode); @@ -76,71 +76,71 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Handle the change in component. * - * @param [in] newPorts List of new ports. + * @param [in] newPorts List of new ports. */ void componentChanged(QSharedPointer > > newPorts); /*! * Validates the given port map. * - * @param [in] portMap The selected port map. + * @param [in] portMap The selected port map. * - * @return True, if the port map is valid IP-XACT, otherwise false. + * @return True, if the port map is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer const& portMap) const; /*! * Check if the is present value is valid. * - * @param [in] portMap The selected port map. + * @param [in] portMap The selected port map. * - * @return True, if the is present is valid, otherwise false. + * @return True, if the is present is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer const& portMap) const; /*! * Check if the selected logical port is valid. * - * @param [in] logical The selected logical port of a port map. + * @param [in] logical The selected logical port of a port map. * - * @return True, if the logical port is valid, otherwise false. + * @return True, if the logical port is valid, otherwise false. */ bool hasValidLogicalPort(QSharedPointer const& logical) const; /*! * Check if the port map has a valid physical port or a valid tie off. * - * @param [in] portMap The selected port map. + * @param [in] portMap The selected port map. * - * @return True, if the physical mapping is valid, otherwise false. + * @return True, if the physical mapping is valid, otherwise false. */ bool hasValidPhysicalMapping(QSharedPointer const& portMap) const; /*! * Check if the selected physical port is valid. * - * @param [in] physical The selected physical port of a port map. + * @param [in] physical The selected physical port of a port map. * - * @return True, if the physical port is valid, otherwise false. + * @return True, if the physical port is valid, otherwise false. */ bool hasValidPhysicalPort(QSharedPointer const& physical) const; /*! * Check if the tie off value is valid. * - * @param [in] tieOff The selected tie off value. + * @param [in] tieOff The selected tie off value. * - * @return True, if the tie off value is valid, otherwise false. + * @return True, if the tie off value is valid, otherwise false. */ bool hasValidTieOff(QString const& tieOff) const; /*! * Check if the connected ports have valid port types. * - * @param [in] logicalPort The logical port to check. - * @param [in] physicalPort The physical port to check. + * @param [in] logicalPort The logical port to check. + * @param [in] physicalPort The physical port to check. * - * @return True, if the port types are valid, otherwise false. + * @return True, if the port types are valid, otherwise false. */ bool connectedPortsHaveValidPortTypes(QSharedPointer const& logicalPort, QSharedPointer const& physicalPort) const; @@ -148,10 +148,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Check if the connected ports have valid directions. * - * @param [in] logicalPort The logical port to check. - * @param [in] physicalPort The physical port to check. + * @param [in] logicalPort The logical port to check. + * @param [in] physicalPort The physical port to check. * - * @return True, if the directions are valid, otherwise false. + * @return True, if the directions are valid, otherwise false. */ bool connectedPortsHaveValidDirections(QSharedPointer const& logicalPort, QSharedPointer const& physicalPort) const; @@ -159,10 +159,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Check if the connected ports have valid initiatives. * - * @param [in] logicalPort The logical port to check. - * @param [in] physicalPort The physical port to check. + * @param [in] logicalPort The logical port to check. + * @param [in] physicalPort The physical port to check. * - * @return True, if the initiatives are valid, otherwise false. + * @return True, if the initiatives are valid, otherwise false. */ bool connectedPortsHaveValidInitiatives(QSharedPointer const& logicalPort, QSharedPointer const& physicalPort) const; @@ -170,10 +170,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Checks if the logical port has a valid range. * - * @param [in] logicalRange The logical port range to check. - * @param [in] referencedPort The logical signal in the referenced abstraction. + * @param [in] logicalRange The logical port range to check. + * @param [in] referencedPort The logical signal in the referenced abstraction. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool logicalPortHasValidRange(QSharedPointer const & logicalRange, QSharedPointer const & referencedPort) const; @@ -181,10 +181,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Check if the physical port has a valid part select. * - * @param [in] physicalPart The selected part select. - * @param [in] referencedPort Port referenced by the physical port. + * @param [in] physicalPart The selected part select. + * @param [in] referencedPort Port referenced by the physical port. * - * @return True, if the part select is valid, otherwise false. + * @return True, if the part select is valid, otherwise false. */ bool physicalPortHasValidPartSelect(QSharedPointer const& physicalPart, QSharedPointer const& referencedPort) const; @@ -192,10 +192,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Check if the connected ports have the same range. * - * @param [in] logicalRange The logical range of the port map. - * @param [in] physicalPart The physical part selected of the port map. + * @param [in] logicalRange The logical range of the port map. + * @param [in] physicalPart The physical part selected of the port map. * - * @return True, if the connected ports have the same range, otherwise false. + * @return True, if the connected ports have the same range, otherwise false. */ bool connectedPortsHaveSameRange(QSharedPointer const& logicalRange, QSharedPointer const& physicalPart) const; @@ -203,9 +203,9 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Locate errors within a port map. * - * @param [in] errors List of found errors. - * @param [in] portMap The selected port map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] portMap The selected port map. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer portMap, QString const& context) const; @@ -215,42 +215,42 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Checks if both of the given range values exist. * - * @param [in] leftRange The selected left range. - * @param [in] rightRange The selected right range. + * @param [in] leftRange The selected left range. + * @param [in] rightRange The selected right range. * - * @return True, if both of the range values exist. + * @return True, if both of the range values exist. */ bool bothRangeValuesExist(QString const& leftRange, QString const& rightRange) const; /*! * Get the bus width of a logical signal. * - * @param [in] logicalPort The selected logical signal. + * @param [in] logicalPort The selected logical signal. * - * @return The bus width of the selected logical signal. + * @return The bus width of the selected logical signal. */ quint64 getLogicalPortWidth(QSharedPointer const& logicalPort) const; /*! * Check if the range is within the selected width. * - * @param [in] rangeLeft Left range value. - * @param [in] rangeRight Right range value. - * @param [in] width The selected width. + * @param [in] rangeLeft Left range value. + * @param [in] rangeRight Right range value. + * @param [in] width The selected width. * - * @return True, if the range is within the selected width, false otherwise. + * @return True, if the range is within the selected width, false otherwise. */ bool rangeIsWithinWidth(qint64 const& rangeLeft, qint64 const& rangeRight, quint64 const& width) const; /*! * Check if the range is valid in a wire port. * - * @param [in] rangeLeft Left range value. - * @param [in] rangeRight Right range value. - * @param [in] wireLeft Left limit of the wire. - * @param [in] wireRight Right limit of the wire. + * @param [in] rangeLeft Left range value. + * @param [in] rangeRight Right range value. + * @param [in] wireLeft Left limit of the wire. + * @param [in] wireRight Right limit of the wire. * - * @return True, if the range is valid in the wire limits, false otherwise. + * @return True, if the range is valid in the wire limits, false otherwise. */ bool rangeIsValidInWire(quint64 const& rangeLeft, quint64 const& rangeRight, quint64 const& wireLeft, quint64 const& wireRight) const; @@ -258,9 +258,9 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Find errors within port map isPresent. * - * @param [in] errors List of found errors. - * @param [in] portMap The selected port map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] portMap The selected port map. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer portMap, QString const& context) const; @@ -268,10 +268,10 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Find errors within the logical port. * - * @param [in] errors List of found errors. - * @param [in] logicalPort The selected logical port. - * @param [in] referencedPort The abstraction for the logical port. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] logicalPort The selected logical port. + * @param [in] referencedPort The abstraction for the logical port. + * @param [in] context Context to help locate the error. */ void findErrorsInLogicalPort(QVector& errors, QSharedPointer logicalPort, QSharedPointer referencedPort, QString const& context) const; @@ -279,19 +279,19 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Find errors within the logical tie off. * - * @param [in] errors List of found errors. - * @param [in] tieOff The selected tie off value. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] tieOff The selected tie off value. + * @param [in] context Context to help locate the error. */ void findErrorsInTieOff(QVector& errors, QString const& tieOff, QString const& context) const; /*! * Find errors within the physical port. * - * @param [in] errors List of found errors. - * @param [in] physicalPort The physical port to check. - * @param [in] referencedPort The component port referenced by the physical port. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] physicalPort The physical port to check. + * @param [in] referencedPort The component port referenced by the physical port. + * @param [in] context Context to help locate the error. */ void findErrorsInPhysicalPort(QVector& errors, QSharedPointer physicalPort, QSharedPointer referencedPort, QString const& context) const; @@ -299,12 +299,12 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Find errors within the mapping. * - * @param [in] errors List of found errors. - * @param [in] logical The mapped logical port. - * @param [in] physical The mapped physical port. - * @param [in] logicalPort The logical port abstraction. - * @param [in] physicalPort The physical port to check. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] logical The mapped logical port. + * @param [in] physical The mapped physical port. + * @param [in] logicalPort The logical port abstraction. + * @param [in] physicalPort The physical port to check. + * @param [in] context Context to help locate the error. */ void findErrorsInPortConnection(QVector& errors, QSharedPointer logical, QSharedPointer physical, QSharedPointer logicalPort, @@ -313,27 +313,27 @@ class IPXACTMODELS_EXPORT PortMapValidator /*! * Parse expression and check if it is valid. * - * @param [in] expression The expression to parse + * @param [in] expression The expression to parse * - * @return Indication if the expression is valid and the parsed value. + * @return Indication if the expression is valid and the parsed value. */ std::pair checkAndParseExpression(QString const & expression) const; /*! * Get the referenced logical port. * - * @param [in] portName The name of the referenced logical port. + * @param [in] portName The name of the referenced logical port. * - * @return The referenced logical port. + * @return The referenced logical port. */ QSharedPointer findLogicalPort(QString const& portName) const; /*! * Find the referenced physical port. * - * @param [in] portName The name of the referenced physical port. + * @param [in] portName The name of the referenced physical port. * - * @return The referenced physical port. + * @return The referenced physical port. */ QSharedPointer findPhysicalPort(QString const& portName) const; diff --git a/IPXACTmodels/Component/validators/PortSliceValidator.h b/IPXACTmodels/Component/validators/PortSliceValidator.h index 1e75546b3..637a14692 100644 --- a/IPXACTmodels/Component/validators/PortSliceValidator.h +++ b/IPXACTmodels/Component/validators/PortSliceValidator.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT PortSliceValidator /*! * The constructor. * - * @param [in] component The component containing the PortSlices. - * @param [in] PortSlice The expression parser for solving expressions in PortSlices. + * @param [in] component The component containing the PortSlices. + * @param [in] PortSlice The expression parser for solving expressions in PortSlices. * */ PortSliceValidator(QSharedPointer component, QSharedPointer expressionParser); @@ -50,68 +50,68 @@ class IPXACTMODELS_EXPORT PortSliceValidator /*! * Validates the given port slice. * - * @param [in] PortSlice The port slice to validate. + * @param [in] PortSlice The port slice to validate. * - * @return True, if the PortSlice is valid IP-XACT, otherwise false. + * @return True, if the PortSlice is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer portSlice) const; /*! * Validates the port reference in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid port reference, otherwise false. + * @return True, if the portSlice is has a valid port reference, otherwise false. */ bool hasValidPortReference(QSharedPointer portSlice) const; /*! * Validates the left range in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid left range, otherwise false. + * @return True, if the portSlice is has a valid left range, otherwise false. */ bool hasValidLeftRange(QSharedPointer portSlice) const; /*! * Validates the right range in the given port slice. * - * @param [in] portSlice The port slice to validate. + * @param [in] portSlice The port slice to validate. * - * @return True, if the portSlice is has a valid right range, otherwise false. + * @return True, if the portSlice is has a valid right range, otherwise false. */ bool hasValidRightRange(QSharedPointer portSlice) const; /*! * Check if the portSlice name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Finds possible errors in a PortSlice and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] PortSlice The PortSlice whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] PortSlice The PortSlice whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer portSlice, QString const& context) const; /*! * Change the active component. * - * @param [in] newComponent List of found errors. + * @param [in] newComponent List of found errors. */ void componentChange(QSharedPointer newComponent); /*! * Set the expression parser to be used. * - * @param [in] expressionParser The expression parser to set. + * @param [in] expressionParser The expression parser to set. */ void setExpressionParser(QSharedPointer expressionParser); @@ -119,11 +119,11 @@ class IPXACTMODELS_EXPORT PortSliceValidator /* Check if the given value is in the given range. * - * @param [in] value The value to be evaluated. - * @param [in] leftBound The left bound of the range. - * @param [in] rightBound The right bound of the range. + * @param [in] value The value to be evaluated. + * @param [in] leftBound The left bound of the range. + * @param [in] rightBound The right bound of the range. * - * @return True, if the value is in the range, otherwise false. + * @return True, if the value is in the range, otherwise false. */ bool isInValidRange(QString const& value, int leftBound, int rightBound) const; diff --git a/IPXACTmodels/Component/validators/PortTypeValidator.h b/IPXACTmodels/Component/validators/PortTypeValidator.h index 9c984f38f..996089175 100644 --- a/IPXACTmodels/Component/validators/PortTypeValidator.h +++ b/IPXACTmodels/Component/validators/PortTypeValidator.h @@ -27,7 +27,7 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * The constructor. * - * @param [in] views The available views. + * @param [in] views The available views. */ PortTypeValidator(QSharedPointer > > views); @@ -43,17 +43,17 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Change the available views. * - * @param [in] newViews The new views. + * @param [in] newViews The new views. */ void componentChange(QSharedPointer > > newViews); /*! * Validates the given port type definition. * - * @param [in] typeDefinition The selected type definition. - * @param [in] definitionList List containing all the port type definitions. + * @param [in] typeDefinition The selected type definition. + * @param [in] definitionList List containing all the port type definitions. * - * @return True, if the type definition is valid IP-XACT, otherwise false. + * @return True, if the type definition is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer typeDefinition, QSharedPointer > > definitionList) const; @@ -61,19 +61,19 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Checks if the selected type definition has a valid type name. * - * @param [in] typeDefinition The selected type definition. + * @param [in] typeDefinition The selected type definition. * - * @return True, if the type name is valid IP-XACT, otherwise false. + * @return True, if the type name is valid IP-XACT, otherwise false. */ bool hasValidtype(QSharedPointer typeDefinition) const; /*! * Checks if the selected type definition has valid view references. * - * @param [in] typeDefinition The selected type definition. - * @param [in] definitionList List containing all the type definitions of the containing port. + * @param [in] typeDefinition The selected type definition. + * @param [in] definitionList List containing all the type definitions of the containing port. * - * @return True, if the view references are valid IP-XACT, otherwise false. + * @return True, if the view references are valid IP-XACT, otherwise false. */ bool hasValidViewReferences(QSharedPointer typeDefinition, QSharedPointer > > definitionList) const; @@ -81,10 +81,10 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Checks if the selected view reference is valid. * - * @param [in] view The selected view reference. - * @param [in] typeDefinitionList List containing all the type definitions of the containing port. + * @param [in] view The selected view reference. + * @param [in] typeDefinitionList List containing all the type definitions of the containing port. * - * @return True, if the view reference is valid IP-XACT, otherwise false. + * @return True, if the view reference is valid IP-XACT, otherwise false. */ bool hasValidView(QString const& view, QSharedPointer > > typeDefinitionList) const; @@ -92,19 +92,19 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Check if the referenced view exists within the containing component. * - * @param [in] viewRef The selected view reference. + * @param [in] viewRef The selected view reference. * - * @return True, if the view reference exists, otherwise false. + * @return True, if the view reference exists, otherwise false. */ bool referencedViewExists(QString const& viewRef) const; /*! * Checks if the selected view is referenced only once in all of the type definitions. * - * @param [in] referencedView The selected view reference. - * @param [in] typeDefinitionList List containing all the type definitions of the containing port. + * @param [in] referencedView The selected view reference. + * @param [in] typeDefinitionList List containing all the type definitions of the containing port. * - * @return True, if the view reference is used only once in all of the type definitions, otherwise false. + * @return True, if the view reference is used only once in all of the type definitions, otherwise false. */ bool viewIsReferencedOnce(QString const& referencedView, QSharedPointer > > typeDefinitionList) const; @@ -112,10 +112,10 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Find possible errors in a type definition and create a list of them. * - * @param [in/out] errors List of found errors. - * @param [in] context Context to help locate the errors. - * @param [in] typeDefinition The selected type definition. - * @param [in] definitionList List of type definitions contained within the containing port. + * @param [in/out] errors List of found errors. + * @param [in] context Context to help locate the errors. + * @param [in] typeDefinition The selected type definition. + * @param [in] definitionList List of type definitions contained within the containing port. */ void findErrorsIn(QVector& errors, QString const& context, QSharedPointer typeDefinition, @@ -126,10 +126,10 @@ class IPXACTMODELS_EXPORT PortTypeValidator /*! * Find errors in the view references of the selected type definition. * - * @param [in/out] errors List containing the found errors. - * @param [in] context Context to help locate the errors. - * @param [in] typeDefinition The selected type definition. - * @param [in] definitionList List of type definitions contained within the containing port. + * @param [in/out] errors List containing the found errors. + * @param [in] context Context to help locate the errors. + * @param [in] typeDefinition The selected type definition. + * @param [in] definitionList List of type definitions contained within the containing port. */ void findErrorsInViewReferences(QVector& errors, QString const& context, QSharedPointer typeDefinition, diff --git a/IPXACTmodels/Component/validators/PortValidator.h b/IPXACTmodels/Component/validators/PortValidator.h index 9d94f5f20..8e8091273 100644 --- a/IPXACTmodels/Component/validators/PortValidator.h +++ b/IPXACTmodels/Component/validators/PortValidator.h @@ -38,8 +38,8 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The used expression parser. - * @param [in] views The available views. + * @param [in] expressionParser The used expression parser. + * @param [in] views The available views. */ PortValidator(QSharedPointer expressionParser, QSharedPointer > > views); @@ -50,16 +50,16 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * Change the available views. * - * @param [in] newViews The new views. + * @param [in] newViews The new views. */ void componentChange(QSharedPointer > > newViews); /*! * Validates the given Port. * - * @param [in] Port The Port to validate. + * @param [in] Port The Port to validate. * - * @return True, if the Port is valid IP-XACT, otherwise false. + * @return True, if the Port is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer port) const; @@ -67,45 +67,45 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the is present is valid. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the is present is valid, otherwise false. + * @return True, if the is present is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer port) const; /*! * Check if the arrays are valid. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the arrays are valid, otherwise false. + * @return True, if the arrays are valid, otherwise false. */ bool hasValidArrays(QSharedPointer port) const; /*! * Check if an array value is valid. * - * @param [in] arrayValue The selected array value. + * @param [in] arrayValue The selected array value. * - * @return True, if the array value is valid, otherwise false. + * @return True, if the array value is valid, otherwise false. */ bool arrayValueIsValid(QString const& arrayValue) const; /*! * Check if the port wire is valid. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the port wire is valid, otherwise false. + * @return True, if the port wire is valid, otherwise false. */ bool hasValidWire(QSharedPointer port) const; bool hasValidDefaultValue(QSharedPointer port) const; @@ -113,115 +113,115 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * Check if the wire is valid. * - * @param [in] wire The selected wire. + * @param [in] wire The selected wire. * - * @return True, if the wire is valid, otherwise false. + * @return True, if the wire is valid, otherwise false. */ bool wireHasValidDirection(QSharedPointer wire) const; /*! * Check if the wire port bound is valid. * - * @param [in] portBound The selected port bound. + * @param [in] portBound The selected port bound. * - * @return True, if the port bound is valid, otherwise false. + * @return True, if the port bound is valid, otherwise false. */ bool portBoundIsValid(QString const& portBound) const; /*! * Check if the transactional port is valid. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the transactional port is valid, otherwise false. + * @return True, if the transactional port is valid, otherwise false. */ bool hasValidTransactionalPort(QSharedPointer port) const; /*! * Check if a transactional has a valid initiative. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the initiative is valid, false otherwise. + * @return True, if the initiative is valid, false otherwise. */ bool hasValidTransactionalInitiative(QSharedPointer transactional) const; /*! * Check if a transactional has a valid kind. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the kind is valid, false otherwise. + * @return True, if the kind is valid, false otherwise. */ bool hasValidTransactionalKind(QSharedPointer transactional) const; /*! * Check if a transactional has a valid bus width. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the bus width is valid, false otherwise. + * @return True, if the bus width is valid, false otherwise. */ bool hasValidTransactionalWidth(QSharedPointer transactional) const; /*! * Check if a transactional has a valid value for maximum connections. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the maximum connections value is valid, false otherwise. + * @return True, if the maximum connections value is valid, false otherwise. */ bool hasValidTransactionalMaxConnections(QSharedPointer transactional) const; /*! * Check if a transactional has a valid value for minimum connections. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the minimum connections value is valid, false otherwise. + * @return True, if the minimum connections value is valid, false otherwise. */ bool hasValidTransactionalMinConnections(QSharedPointer transactional) const; /*! * Check if a transactional has a protocol. * - * @param [in] transactional The selected transactional + * @param [in] transactional The selected transactional * - * @return True, if the protocol is valid, false otherwise. + * @return True, if the protocol is valid, false otherwise. */ bool hasValidTransactionalProtocol(QSharedPointer transactional) const; /*! * Check if the port has valid type definitions. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the type definitions are valid, false otherwise. + * @return True, if the type definitions are valid, false otherwise. */ bool hasValidTypes(QSharedPointer port) const; /*! * Check if the selected type definitions are valid. * - * @param [in] typeDefinitions The selected type definitions. + * @param [in] typeDefinitions The selected type definitions. * - * @return True, if the type definitions are valid, false otherwise. + * @return True, if the type definitions are valid, false otherwise. */ bool hasValidTypeDefinitions(QSharedPointer > > typeDefinitions) const; /*! * Finds possible errors in a Port and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] Port The Port whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] Port The Port whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsIn(QVector& errors, QSharedPointer port, QString const& context) const; /*! * Get the type definition validator. * - * @return The validator used for type definitions. + * @return The validator used for type definitions. */ QSharedPointer getTypeValidator() const; @@ -234,18 +234,18 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * Finds possible errors in a wire and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] port The Port whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] port The Port whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInWire(QVector& errors, QSharedPointer port, QString const& context) const; /*! * Finds possible errors in a transactional and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] port The port whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] port The port whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInTransactional(QVector &errors, QSharedPointer port, QString const& context) const; @@ -253,9 +253,9 @@ class IPXACTMODELS_EXPORT PortValidator : public HierarchicalValidator /*! * Find possible errors in the selected type definitions. * - * @param [in] errors List of found errors. - * @param [in] typeDefinitions The selected type definitions. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] typeDefinitions The selected type definitions. + * @param [in] context Context to help locate the errors. */ void findErrorsInTypeDefinitions(QVector& errors, QSharedPointer > > typeDefinitions, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/PowerDomainValidator.h b/IPXACTmodels/Component/validators/PowerDomainValidator.h index d4c5caf5a..f65764d63 100644 --- a/IPXACTmodels/Component/validators/PowerDomainValidator.h +++ b/IPXACTmodels/Component/validators/PowerDomainValidator.h @@ -37,8 +37,8 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] parameterValidator Validator used for parameters. */ PowerDomainValidator(QSharedPointer > > availableDomains, QSharedPointer expressionParser, @@ -54,54 +54,54 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Validates the given power domain. * - * @param [in] powerDomain The selected power domain to validate. + * @param [in] powerDomain The selected power domain to validate. * - * @return True, if the power domain is valid IP-XACT, otherwise false. + * @return True, if the power domain is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer powerDomain) const; /*! * Check if the name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the always on expression is valid. * - * @param [in] name The power domain to check. + * @param [in] name The power domain to check. * - * @return True, if the expression is valid, otherwise false. + * @return True, if the expression is valid, otherwise false. */ bool hasValidAlwaysOn(QSharedPointer powerDomain) const; /*! * Check if the subdomain reference is valid. * - * @param [in] name The power domain to check. + * @param [in] name The power domain to check. * - * @return True, if the expression is valid, otherwise false. + * @return True, if the expression is valid, otherwise false. */ bool hasValidSubDomainOf(QSharedPointer powerDomain) const; /*! * Check if the power domain contains valid parameters. * - * @param [in] PowerDomain The selected power domain. + * @param [in] PowerDomain The selected power domain. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer PowerDomain) const; /*! * Locate errors within an power domain. * - * @param [in] errors List of found errors. - * @param [in] PowerDomain The selected power domain. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] PowerDomain The selected power domain. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer PowerDomain, QString const& context) const; @@ -109,7 +109,7 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Change the available power domains. * - * @param [in] powerDomains The new available power domains. + * @param [in] powerDomains The new available power domains. */ void componentChange(QSharedPointer > > powerDomains); @@ -118,9 +118,9 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Find errors within power domain name. * - * @param [in] errors List of found errors. - * @param [in] powerDomain The selected power domain. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] powerDomain The selected power domain. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer PowerDomain, QString const& context) const; @@ -128,9 +128,9 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Find errors within always on expression. * - * @param [in] errors List of found errors. - * @param [in] powerDomain The selected power domain. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] powerDomain The selected power domain. + * @param [in] context Context to help locate the error. */ void findErrorsInAlwaysOn(QVector& errors, QSharedPointer powerDomain, QString const& context) const; @@ -138,9 +138,9 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Find errors within sub domain reference. * - * @param [in] errors List of found errors. - * @param [in] powerDomain The selected power domain. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] powerDomain The selected power domain. + * @param [in] context Context to help locate the error. */ void findErrorsInSubDomainOf(QVector& errors, QSharedPointer powerDomain, QString const& context) const; @@ -148,9 +148,9 @@ class IPXACTMODELS_EXPORT PowerDomainValidator : public HierarchicalValidator /*! * Find errors within power domain parameters. * - * @param [in] errors List of found errors. - * @param [in] PowerDomain The selected power domain. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] PowerDomain The selected power domain. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector& errors, QSharedPointer PowerDomain, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/RegionValidator.h b/IPXACTmodels/Component/validators/RegionValidator.h index b116d6855..5f6d6abdf 100644 --- a/IPXACTmodels/Component/validators/RegionValidator.h +++ b/IPXACTmodels/Component/validators/RegionValidator.h @@ -34,7 +34,7 @@ class IPXACTMODELS_EXPORT RegionValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] expressionParser The parser to use for solving expressions. */ RegionValidator(QSharedPointer expressionParser); @@ -48,45 +48,45 @@ class IPXACTMODELS_EXPORT RegionValidator /*! * Validates the given address region. * - * @param [in] Region The selected address region. + * @param [in] Region The selected address region. * - * @return True, if the address region is valid IP-XACT, otherwise false. + * @return True, if the address region is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer region) const; /*! * Check if the name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the address region contains a valid range. * - * @param [in] Region The selected address region. + * @param [in] Region The selected address region. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool hasValidRange(QSharedPointer region) const; /*! * Check if the address region contains a valid address offset. * - * @param [in] Region The selected address region. + * @param [in] Region The selected address region. * - * @return True, if the address offset is valid, otherwise false. + * @return True, if the address offset is valid, otherwise false. */ bool hasValidAddressOffset(QSharedPointer region) const; /*! * Locate errors within an address region. * - * @param [in] errors List of found errors. - * @param [in] region The selected region. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] region The selected region. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer region, QString const& context) const; @@ -96,9 +96,9 @@ class IPXACTMODELS_EXPORT RegionValidator /*! * Find errors within address region name. * - * @param [in] errors List of found errors. - * @param [in] region The selected address region. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] region The selected address region. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer region, QString const& context) const; @@ -106,9 +106,9 @@ class IPXACTMODELS_EXPORT RegionValidator /*! * Find errors within address space range. * - * @param [in] errors List of found errors. - * @param [in] region The selected address region. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] region The selected address region. + * @param [in] context Context to help locate the error. */ void findErrorsInRange(QVector& errors, QSharedPointer region, QString const& context) const; @@ -116,9 +116,9 @@ class IPXACTMODELS_EXPORT RegionValidator /*! * Find errors within address space offset. * - * @param [in] errors List of found errors. - * @param [in] region The selected address region. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] region The selected address region. + * @param [in] context Context to help locate the error. */ void findErrorsInOffset(QVector& errors, QSharedPointer region, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/RegisterBaseValidator.h b/IPXACTmodels/Component/validators/RegisterBaseValidator.h index d8e341f58..cf40c0d87 100644 --- a/IPXACTmodels/Component/validators/RegisterBaseValidator.h +++ b/IPXACTmodels/Component/validators/RegisterBaseValidator.h @@ -44,8 +44,8 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] parameterValidator Validator used for parameters. */ RegisterBaseValidator(QSharedPointer expressionParser, QSharedPointer parameterValidator, @@ -61,61 +61,61 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Validates the given register. * - * @param [in] selectedRegisterBase The register to validate. + * @param [in] selectedRegisterBase The register to validate. * - * @return True, if the register is valid IP-XACT, otherwise false. + * @return True, if the register is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer selectedRegisterBase) const; /*! * Check if the register contains a valid name. * - * @param [in] selectedRegisterBase The selected register base. + * @param [in] selectedRegisterBase The selected register base. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer selectedRegisterBase) const; /*! * Check if the register contains a valid isPresent value. * - * @param [in] selectedRegisterBase The selected register base. + * @param [in] selectedRegisterBase The selected register base. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer selectedRegisterBase) const; /*! * Check if the register contains a valid dimension value. * - * @param [in] selectedRegisterBase The selected register. + * @param [in] selectedRegisterBase The selected register. * - * @return True, if the dimension is valid, otherwise false. + * @return True, if the dimension is valid, otherwise false. */ bool hasValidDimensions(QSharedPointer selectedRegisterBase) const; /*! * Check if the register contains a valid address offset. * - * @param [in] selectedRegisterBase The selected register. + * @param [in] selectedRegisterBase The selected register. * - * @return True, if the address offset is valid, otherwise false. + * @return True, if the address offset is valid, otherwise false. */ bool hasValidAddressOffset(QSharedPointer selectedRegisterBase) const; /*! * Check if the register contains valid parameters. * - * @param [in] selectedRegisterBase The selected register base. + * @param [in] selectedRegisterBase The selected register base. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer selectedRegisterBase) const; /*! * Check if the register has valid access policies (or rather the mode references of the access policies). * - * @param [in] registerBase The register base to check + * @param [in] registerBase The register base to check * * @return True, if the access policies are valid, otherwise false. */ @@ -124,7 +124,7 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Validate the memory array of a selected register. * - * @param [in] registerBase The register base to check. + * @param [in] registerBase The register base to check. * * @return True, if valid, otherwise false. */ @@ -134,9 +134,9 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors within a name. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer selectedRegisterBase, QString const& context) const; @@ -144,9 +144,9 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors within is present value. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer selectedRegisterBase, QString const& context) const; @@ -154,9 +154,9 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors within dimension. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInDimension(QVector& errors, QSharedPointer selectedRegisterBase, QString const& context) const; @@ -164,18 +164,18 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors within address offset. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInAddressOffset(QVector& errors, QSharedPointer selectedRegisterBase, QString const& context) const; /*! * Find errors within Parameters. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInParameters(QVector&errors, QSharedPointer selectedRegisterBase, QString const& context) const; @@ -183,9 +183,9 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors in the access policies of the selected register. * - * @param [in] errors List of found errors. - * @param [in] selectedRegisterBase The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegisterBase The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInAccessPolicies(QStringList& errors, QSharedPointer registerBase, QString const& context) const; @@ -193,9 +193,9 @@ class IPXACTMODELS_EXPORT RegisterBaseValidator : public HierarchicalValidator /*! * Find errors within memory array. * - * @param [in] errors List of found errors. - * @param [in] registerBase The selected register base. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] registerBase The selected register base. + * @param [in] context Context to help locate the error. */ void findErrorsInMemoryArray(QStringList& errors, QSharedPointer registerBase, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/RegisterFileValidator.h b/IPXACTmodels/Component/validators/RegisterFileValidator.h index d0c97e92a..c1a59539e 100644 --- a/IPXACTmodels/Component/validators/RegisterFileValidator.h +++ b/IPXACTmodels/Component/validators/RegisterFileValidator.h @@ -36,9 +36,9 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * The constructor. * - * @param [in] expressionParser Parser for expressions. - * @param [in] registerValidator Validator for registers. - * @param [in] parameterValidator Validator for parameters. + * @param [in] expressionParser Parser for expressions. + * @param [in] registerValidator Validator for registers. + * @param [in] parameterValidator Validator for parameters. */ RegisterFileValidator(QSharedPointer expressionParser, QSharedPointer registerValidator, @@ -60,29 +60,29 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Validates the given register file. * - * @param [in] selectedRegisterFile The register file to validate. + * @param [in] selectedRegisterFile The register file to validate. * - * @return True, if the register file is valid IP-XACT, otherwise false. + * @return True, if the register file is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer selectedRegisterFile, QString const& addressUnitBits, QString const& addressBlockWidth); /*! * Check if the register file has a valid range. * - * @param [in] selectedRegisterFile The selected register file whose range to check. + * @param [in] selectedRegisterFile The selected register file whose range to check. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool hasValidRange(QSharedPointer selectedRegisterFile) const; /*! * Check if the register file has a valid register data. * - * @param [in] selectedRegisterFile The selected register file whose register data to check - * @param [in] addressUnitBits The number of bits per address unit. - * @param [in] addressBlockWidth The width of the enclosing address block. + * @param [in] selectedRegisterFile The selected register file whose register data to check + * @param [in] addressUnitBits The number of bits per address unit. + * @param [in] addressBlockWidth The width of the enclosing address block. * - * @return True, if the register data is valid, otherwise false. + * @return True, if the register data is valid, otherwise false. */ bool hasValidRegisterData(QSharedPointer selectedRegisterFile, QString const& addressUnitBits, QString const& addressBlockWidth); @@ -90,7 +90,7 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Check if the register file has a valid structure (choice of elements). * - * @param [in] selectedRegisterFile The selected register file to check. + * @param [in] selectedRegisterFile The selected register file to check. * * @return True, if the structure is valid, otherwise false. */ @@ -99,11 +99,11 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Locate errors within a register file. * - * @param [in/out] errors List of found errors. - * @param [in] selectedRegisterFile The selected register file. - * @param [in] context Context to help locate the error. - * @param [in] addressUnitBits The number of bits per address unit. - * @param [in] addressBlockWidth The width of the enclosing address block. + * @param [in/out] errors List of found errors. + * @param [in] selectedRegisterFile The selected register file. + * @param [in] context Context to help locate the error. + * @param [in] addressUnitBits The number of bits per address unit. + * @param [in] addressBlockWidth The width of the enclosing address block. */ void findErrorsIn(QVector& errors, QSharedPointer selectedRegisterFile, @@ -116,9 +116,9 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Find errors within the range value. * - * @param [in/out] errors List of found errors. - * @param [in] selectedRegisterFile The selected register file. - * @param [in] context Context to help locate the error. + * @param [in/out] errors List of found errors. + * @param [in] selectedRegisterFile The selected register file. + * @param [in] context Context to help locate the error. */ void findErrorsInRange(QVector& errors, QSharedPointer selectedRegisterFile, @@ -127,9 +127,9 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Find errors within the register data. * - * @param [in/out] errors List of found errors. - * @param [in] selectedRegisterFile The selected register file. - * @param [in] context Context to help locate the error. + * @param [in/out] errors List of found errors. + * @param [in] selectedRegisterFile The selected register file. + * @param [in] context Context to help locate the error. */ void findErrorsInRegisterData(QVector& errors, QSharedPointer selectedRegisterFile, @@ -140,9 +140,9 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Find errors within the access policies of the register file. * - * @param [in/out] errors List of found errors. - * @param [in] selectedRegisterFile The selected register file. - * @param [in] context Context to help locate the error. + * @param [in/out] errors List of found errors. + * @param [in] selectedRegisterFile The selected register file. + * @param [in] context Context to help locate the error. */ void findErrorsInAccessPolicies(QStringList& errors, QSharedPointer selectedRegisterFile, QString const& context) const; @@ -150,8 +150,8 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Get size of the given register in address units. * - * @param [in] targetRegister The register whose size to get. - * @param [in] addressUnitBits The number of bits per address unit in use. + * @param [in] targetRegister The register whose size to get. + * @param [in] addressUnitBits The number of bits per address unit in use. * * @return The register size in address units. */ @@ -160,15 +160,15 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Find errors in a given child register of the register file being checked. * - * @param [in/out] errors List of found errors. - * @param [in] childRegister The child register to check. - * @param [in] context Context to help locate the error. - * @param [in] addressUnitBits The number of bits in an address unit. - * @param [in] parentRegisterFileRange The range of the parent register file. - * @param [in] addressBlockWidth The width of the enclosing address block. - * @param [in/out] reservedArea The currently reserved memory areas. - * @param [in/out] registerFileNames List of checked register names. - * @param [in/out] duplicateRegisterFileNames List to keep track of duplicate registers to prevent + * @param [in/out] errors List of found errors. + * @param [in] childRegister The child register to check. + * @param [in] context Context to help locate the error. + * @param [in] addressUnitBits The number of bits in an address unit. + * @param [in] parentRegisterFileRange The range of the parent register file. + * @param [in] addressBlockWidth The width of the enclosing address block. + * @param [in/out] reservedArea The currently reserved memory areas. + * @param [in/out] registerFileNames List of checked register names. + * @param [in/out] duplicateRegisterFileNames List to keep track of duplicate registers to prevent * duplicate errors. */ void findErrorsInChildRegister(QStringList& errors, QSharedPointer childRegister, @@ -179,15 +179,15 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Find errors in a given child register file of the register file being checked. * - * @param [in/out] errors List of found errors. - * @param [in] childRegisterFile The child register to check. - * @param [in] context Context to help locate the error. - * @param [in] addressUnitBits The number of bits in an address unit. - * @param [in] parentRegisterFileRange The range of the parent register file. - * @param [in] addressBlockWidth The width of the enclosing address block. - * @param [in/out] reservedArea The currently reserved memory areas. - * @param [in/out] registerFileNames List of checked register file names. - * @param [in/out] duplicateRegisterFileNames List to keep track of duplicate register files to prevent + * @param [in/out] errors List of found errors. + * @param [in] childRegisterFile The child register to check. + * @param [in] context Context to help locate the error. + * @param [in] addressUnitBits The number of bits in an address unit. + * @param [in] parentRegisterFileRange The range of the parent register file. + * @param [in] addressBlockWidth The width of the enclosing address block. + * @param [in/out] reservedArea The currently reserved memory areas. + * @param [in/out] registerFileNames List of checked register file names. + * @param [in/out] duplicateRegisterFileNames List to keep track of duplicate register files to prevent * duplicate errors. */ void findErrorsInChildRegisterFile(QStringList& errors, QSharedPointer childRegisterFile, @@ -198,12 +198,12 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Mark overlapping registers and register files as invalid. * - * @param [in] regIter Iterator pointing to current register(file). - * @param [in] lastEndAddress Currently biggest register end address found. - * @param [in] registerFileRange The address block range. - * @param [in] addressUnitBits The memory map address unit bits. - * @param [in] targetIsRegister Flag indicating if regIter points to register or register file. - * @param [in] lastWasRegister Flag indicating if the previous item was a register or register file. + * @param [in] regIter Iterator pointing to current register(file). + * @param [in] lastEndAddress Currently biggest register end address found. + * @param [in] registerFileRange The address block range. + * @param [in] addressUnitBits The memory map address unit bits. + * @param [in] targetIsRegister Flag indicating if regIter points to register or register file. + * @param [in] lastWasRegister Flag indicating if the previous item was a register or register file. * * @return True, if overlapping registers and/or register files were found, otherwise false. */ @@ -213,7 +213,7 @@ class IPXACTMODELS_EXPORT RegisterFileValidator : public RegisterBaseValidator /*! * Get register file range (size in AUB) taking dimensions into account. * - * @param [in] targetRegisterFile The register file to get range of. + * @param [in] targetRegisterFile The register file to get range of. * * @return The true register file range. */ diff --git a/IPXACTmodels/Component/validators/RegisterValidator.h b/IPXACTmodels/Component/validators/RegisterValidator.h index f011dc1cf..fcd02f4dc 100644 --- a/IPXACTmodels/Component/validators/RegisterValidator.h +++ b/IPXACTmodels/Component/validators/RegisterValidator.h @@ -41,10 +41,10 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] fieldValidator Validator used for fields. - * @param [in] parameterValidator Validator used for parameters. - * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] fieldValidator Validator used for fields. + * @param [in] parameterValidator Validator used for parameters. + * @param [in] docRevision The IP-XACT standard revision to comply to. */ RegisterValidator(QSharedPointer expressionParser, QSharedPointer fieldValidator, @@ -61,67 +61,67 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Change the containing component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void componentChange(QSharedPointer newComponent); /*! * Get the field validator. * - * @return The field validator. + * @return The field validator. */ QSharedPointer getFieldValidator() const; /*! * Validates the given register. * - * @param [in] selectedRegister The register to validate. + * @param [in] selectedRegister The register to validate. * - * @return True, if the register is valid IP-XACT, otherwise false. + * @return True, if the register is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer selectedRegister) const; /*! * Check if the register contains a valid size. * - * @param [in] selectedRegister The selected register. + * @param [in] selectedRegister The selected register. * - * @return True, if the size is valid, otherwise false. + * @return True, if the size is valid, otherwise false. */ bool hasValidSize(QSharedPointer selectedRegister) const; /*! * Check if the register contains valid fields. * - * @param [in] selectedRegister The selected register definition. - * @param [in] registerSize Size of the containing register. + * @param [in] selectedRegister The selected register definition. + * @param [in] registerSize Size of the containing register. * - * @return True, if the fields are valid, otherwise false. + * @return True, if the fields are valid, otherwise false. */ bool hasValidFields(QSharedPointer selectedRegister, QString const& registerSize) const; /*! * Check if the register contains valid alternate registers. * - * @param [in] selectedRegister The selected register. + * @param [in] selectedRegister The selected register. * - * @return True, if the alternate registers are valid, otherwise false. + * @return True, if the alternate registers are valid, otherwise false. */ bool hasValidAlternateRegisters(QSharedPointer selectedRegister) const; /*! * Check if the alternate register contains valid alternate groups. * - * @param [in] selectedRegister The selected alternate register. + * @param [in] selectedRegister The selected alternate register. * - * @return True, if the alternate groups are valid, otherwise false. + * @return True, if the alternate groups are valid, otherwise false. */ bool hasValidAlternateGroups(QSharedPointer selectedRegister) const; /*! * Check if a 2022 std register has a valid structure, valid combination of subelements. * - * @param [in] selectedRegister The register to check. + * @param [in] selectedRegister The register to check. * * @return True, if the structure is valid, otherwise false. */ @@ -130,9 +130,9 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Locate errors within a register. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer selectedRegister, QString const& context) const; @@ -142,10 +142,10 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Check if the field contains a valid access value. * - * @param [in] selectedRegister The selected register definition. - * @param [in] field The selected field + * @param [in] selectedRegister The selected register definition. + * @param [in] field The selected field * - * @return True, if the access value is valid, otherwise false. + * @return True, if the access value is valid, otherwise false. */ bool fieldHasValidAccess(QSharedPointer selectedRegsiter, QSharedPointer field) const; @@ -153,19 +153,19 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Check if the fields contain similar definition groups. * - * @param [in] field The selected field. - * @param [in] comparedField The field being compared to + * @param [in] field The selected field. + * @param [in] comparedField The field being compared to * - * @return True, if the fields are similar, otherwise false. + * @return True, if the fields are similar, otherwise false. */ bool fieldsHaveSimilarDefinitionGroups(QSharedPointer field, QSharedPointer comparedField) const; /*! * Find errors within size. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInSize(QVector& errors, QSharedPointer selectedRegister, QString const& context) const; @@ -173,9 +173,9 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Find errors within fields. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected register. + * @param [in] context Context to help locate the error. */ void findErrorsInFields(QVector& errors, QSharedPointer selectedRegister, QString const& registerSize, QString const& context) const; @@ -183,17 +183,17 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Find errors within alternate registers. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected register. + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected register. */ void findErrorsInAlternateRegisters(QVector& errors, QSharedPointer selectedRegister) const; /*! * Find errors within alternate groups. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected alternate register. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected alternate register. + * @param [in] context Context to help locate the error. */ void findErrorsInAlternateGroups(QVector& errors, QSharedPointer selectedRegister, QString const& context) const; @@ -201,10 +201,10 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Find errors within the mode references of an alternate register. * - * @param [in] errors List of found errors. - * @param [in] selectedRegister The selected register. - * @param [in] context Context to help locate the error. - * @param [in] + * @param [in] errors List of found errors. + * @param [in] selectedRegister The selected register. + * @param [in] context Context to help locate the error. + * @param [in] */ void findErrorsInAlternateRegisterModeRefs(QStringList& errors, QSharedPointer selectedRegister, QString const& context, @@ -214,8 +214,8 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Validate single alternate register. * - * @param [in] alternateRegister The alternate register to check. - * @param [in] selectedRegister The parent register. + * @param [in] alternateRegister The alternate register to check. + * @param [in] selectedRegister The parent register. * * @return True, if the alternate register is valid, otherwise false. */ @@ -224,7 +224,7 @@ class IPXACTMODELS_EXPORT RegisterValidator : public RegisterBaseValidator /*! * Get the bit width of the field taking into account the dimensions of it if std22 is in use. * - * @param [in] field The field whose width to get. + * @param [in] field The field whose width to get. * * @return The true bit width of the field. */ diff --git a/IPXACTmodels/Component/validators/RemapStateValidator.h b/IPXACTmodels/Component/validators/RemapStateValidator.h index 6e7614156..360403645 100644 --- a/IPXACTmodels/Component/validators/RemapStateValidator.h +++ b/IPXACTmodels/Component/validators/RemapStateValidator.h @@ -31,8 +31,8 @@ class IPXACTMODELS_EXPORT RemapStateValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] ports The available component ports. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] ports The available component ports. */ RemapStateValidator(QSharedPointer expressionParser, QSharedPointer > > ports); @@ -43,43 +43,43 @@ class IPXACTMODELS_EXPORT RemapStateValidator /*! * Change the available ports. * - * @param [in] newPorts The new ports. + * @param [in] newPorts The new ports. */ void componentChange(QSharedPointer > > newPorts); /*! * Validates the given remap state. * - * @param [in] remapState The remap state to validate. + * @param [in] remapState The remap state to validate. * - * @return True, if the remap state is valid IP-XACT, otherwise false. + * @return True, if the remap state is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer remapState) const; /*! * Check if the remap state has a valid name. * - * @param [in] remapState The selected remap state. + * @param [in] remapState The selected remap state. * - * @return True, if the name is valid IP-XACT, otherwise false. + * @return True, if the name is valid IP-XACT, otherwise false. */ bool hasValidName(QSharedPointer remapState) const; /*! * Check if the remap state has valid remap ports. * - * @param [in] remapState The selected remap state. + * @param [in] remapState The selected remap state. * - * @return True, if the remap ports are valid IP-XACT, otherwise false. + * @return True, if the remap ports are valid IP-XACT, otherwise false. */ bool hasValidRemapPorts(QSharedPointer remapState) const; /*! * Locate errors within a remap state. * - * @param [in] errors List of found errors. - * @param [in] remapState The selected remap state. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] remapState The selected remap state. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer remapState, QString const& context) const; @@ -93,37 +93,37 @@ class IPXACTMODELS_EXPORT RemapStateValidator /*! * Check if the remap port has a valid port reference. * - * @param [in] remapPort The selected remap port. + * @param [in] remapPort The selected remap port. * - * @return True, if the port reference is valid IP-XACT, otherwise false. + * @return True, if the port reference is valid IP-XACT, otherwise false. */ bool remapPortHasValidPortReference(QSharedPointer remapPort) const; /*! * Check if the remap port has a valid port index. * - * @param [in] remapPort The selected remap port. - * @param [in] referencedPort The port referenced by the remap port. + * @param [in] remapPort The selected remap port. + * @param [in] referencedPort The port referenced by the remap port. * - * @return True, if the port index is valid IP-XACT, otherwise false. + * @return True, if the port index is valid IP-XACT, otherwise false. */ bool remapPortHasValidIndex(QSharedPointer remapPort, QSharedPointer referencedPort) const; /*! * Check if the remap port has a valid value. * - * @param [in] remapPort The selected remap port. + * @param [in] remapPort The selected remap port. * - * @return True, if the value is valid IP-XACT, otherwise false. + * @return True, if the value is valid IP-XACT, otherwise false. */ bool remapPortHasValidValue(QSharedPointer remapPort) const; /*! * Find errors within a name. * - * @param [in] errors List of found errors. - * @param [in] remapState The selected remap state. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] remapState The selected remap state. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer remapState, QString const& context) const; @@ -131,9 +131,9 @@ class IPXACTMODELS_EXPORT RemapStateValidator /*! * Find errors within remap ports. * - * @param [in] errors List of found errors. - * @param [in] remapState The selected remap state. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] remapState The selected remap state. + * @param [in] context Context to help locate the error. */ void findErrorsInRemapPorts(QVector& errors, QSharedPointer remapState, QString const& context) const; @@ -141,9 +141,9 @@ class IPXACTMODELS_EXPORT RemapStateValidator /*! * Find errors within remap port port reference. * - * @param [in] errors List of found errors. - * @param [in] remapPort The selected remap port. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] remapPort The selected remap port. + * @param [in] context Context to help locate the error. */ void findErrorsInRemapPortPortReference(QVector& errors, QSharedPointer remapPort, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/SubspaceMapValidator.h b/IPXACTmodels/Component/validators/SubspaceMapValidator.h index 9fff0cc7b..fe982e683 100644 --- a/IPXACTmodels/Component/validators/SubspaceMapValidator.h +++ b/IPXACTmodels/Component/validators/SubspaceMapValidator.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT SubspaceMapValidator : public MemoryBlockValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] parameterValidator Validator used for parameters. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] parameterValidator Validator used for parameters. */ SubspaceMapValidator(QSharedPointer expressionParser, QSharedPointer parameterValidator, Document::Revision docRevision); @@ -48,43 +48,43 @@ class IPXACTMODELS_EXPORT SubspaceMapValidator : public MemoryBlockValidator /*! * Change the containing component. * - * @param [in] component The new component. + * @param [in] component The new component. */ void componentChange(QSharedPointer component); /*! * Validates the given subspace map. * - * @param [in] subspace The subspace map to validate. + * @param [in] subspace The subspace map to validate. * - * @return True, if the subspace map is valid IP-XACT, otherwise false. + * @return True, if the subspace map is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer subspace) const; /*! * Check if the selected subspace map has a valid master bus interface reference. * - * @param [in] subspace The selected subspace map. + * @param [in] subspace The selected subspace map. * - * @return True, if the master bus interface reference is valid, false otherwise. + * @return True, if the master bus interface reference is valid, false otherwise. */ bool hasValidMasterReference(QSharedPointer subspace) const; /*! * Check if the selected subspace map has a valid segment reference. * - * @param [in] subspace The selected subspace map. + * @param [in] subspace The selected subspace map. * - * @return True, if the segment reference is valid, false otherwise. + * @return True, if the segment reference is valid, false otherwise. */ bool hasValidSegmentReference(QSharedPointer subspace) const; /*! * Locate errors within a subspace map. * - * @param [in] errors List of found errors. - * @param [in] subspace The selected subspace map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] subspace The selected subspace map. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer subspace, QString const& context) const; @@ -98,62 +98,62 @@ class IPXACTMODELS_EXPORT SubspaceMapValidator : public MemoryBlockValidator /*! * Get the type of the memory block. * - * @return Identification type of the memory block. + * @return Identification type of the memory block. */ virtual QString getBlockType() const override final; /*! * Check if the referenced master bus interface exists. * - * @param [in] masterReference Reference to the selected master bus interface. + * @param [in] masterReference Reference to the selected master bus interface. * - * @return True, if the master bus interface reference exists, false otherwise. + * @return True, if the master bus interface reference exists, false otherwise. */ bool masterReferenceExists(QString const& masterReference) const; /*! * Check if the referenced bus interface is master. * - * @param [in] masterReference Reference to the selected bus interface. + * @param [in] masterReference Reference to the selected bus interface. * - * @return True, if the bus interface is master, false otherwise. + * @return True, if the bus interface is master, false otherwise. */ bool referencedBusIsMaster(QString const& masterReference) const; /*! * Check if the address space within the selected master bus interface contains the selected segment. * - * @param [in] masterReference Reference to the selected master bus interface. - * @param [in] segmentReference Reference to the selected segment. + * @param [in] masterReference Reference to the selected master bus interface. + * @param [in] segmentReference Reference to the selected segment. * - * @return True, if the address space contains the selected segment, false otherwise. + * @return True, if the address space contains the selected segment, false otherwise. */ bool spaceContainsSegmentReference(QString const& masterReference, QString const& segmentReference) const; /*! * Get the selected bus interface. * - * @param [in] masterReference Reference to the selected bus interface. + * @param [in] masterReference Reference to the selected bus interface. * - * @return The selected bus interface. + * @return The selected bus interface. */ QSharedPointer getReferencedBusInterface(QString const& masterReference) const; /*! * Get the address space within the selected master bus interface. * - * @param [in] masterReference Reference to the selected bus interface. + * @param [in] masterReference Reference to the selected bus interface. * - * @return Address space within the selected master bus interface. + * @return Address space within the selected master bus interface. */ QSharedPointer getReferencedSpace(QString const& masterReference) const; /*! * Find errors within master bus interface reference. * - * @param [in] errors List of found errors. - * @param [in] subspace The selected subspace map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] subspace The selected subspace map. + * @param [in] context Context to help locate the error. */ void findErrorsInMasterReference(QVector& errors, QSharedPointer subspace, QString const& context) const; @@ -161,9 +161,9 @@ class IPXACTMODELS_EXPORT SubspaceMapValidator : public MemoryBlockValidator /*! * Find errors within segment reference. * - * @param [in] errors List of found errors. - * @param [in] subspace The selected subspace map. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] subspace The selected subspace map. + * @param [in] context Context to help locate the error. */ void findErrorsInSegmentReference(QVector& errors, QSharedPointer subspace, QString const& context) const; diff --git a/IPXACTmodels/Component/validators/ViewValidator.h b/IPXACTmodels/Component/validators/ViewValidator.h index 2f065b11d..07ef0330a 100644 --- a/IPXACTmodels/Component/validators/ViewValidator.h +++ b/IPXACTmodels/Component/validators/ViewValidator.h @@ -37,8 +37,8 @@ class IPXACTMODELS_EXPORT ViewValidator : public HierarchicalValidator /*! * The constructor. * - * @param [in] expressionParser The used expression parser. - * @param [in] model The containing component model. + * @param [in] expressionParser The used expression parser. + * @param [in] model The containing component model. */ ViewValidator(QSharedPointer expressionParser, QSharedPointer model); @@ -48,88 +48,88 @@ class IPXACTMODELS_EXPORT ViewValidator : public HierarchicalValidator /*! * Change the available model. * - * @param [in] newModel The new model. + * @param [in] newModel The new model. */ void componentChange(QSharedPointer newModel); /*! * Validates the given View. * - * @param [in] View The View to validate. + * @param [in] View The View to validate. * - * @return True, if the View is valid IP-XACT, otherwise false. + * @return True, if the View is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer view) const; /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the is present value is valid. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return True, if the is present value is valid, otherwise false. + * @return True, if the is present value is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer view) const; /*! * Check if the environment identifiers are valid. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return True, if the environment identifiers are valid, otherwise false. + * @return True, if the environment identifiers are valid, otherwise false. */ bool hasValidEnvironmentIdentifiers(QSharedPointer view) const; /*! * Check if the component instantiation reference is valid. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return True, if the component instantiation reference is valid, otherwise false. + * @return True, if the component instantiation reference is valid, otherwise false. */ bool hasValidComponentInstantiationReference(QSharedPointer view) const; /*! * Check if the is design instantiation reference is valid. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return True, if the design instantiation reference is valid, otherwise false. + * @return True, if the design instantiation reference is valid, otherwise false. */ bool hasValidDesignInstantiationReference(QSharedPointer view) const; /*! * Check if the design configuration reference is valid. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return True, if the is design configuration reference is valid, otherwise false. + * @return True, if the is design configuration reference is valid, otherwise false. */ bool hasValidDesignConfigurationInstantiationReference(QSharedPointer view) const; /*! * Check if an environment identifier is valid. * - * @param [in] name The environment identifier to be evaluated. + * @param [in] name The environment identifier to be evaluated. * - * @return True, if the environment identifier is valid, otherwise false. + * @return True, if the environment identifier is valid, otherwise false. */ bool isValidEnvId(QSharedPointer const& envId) const; /*! * Finds possible errors in a View and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] View The View whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] View The View whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer view, QString const& contex) const; diff --git a/IPXACTmodels/Design/ActiveInterface.h b/IPXACTmodels/Design/ActiveInterface.h index f38fadfe5..1ca55cb09 100644 --- a/IPXACTmodels/Design/ActiveInterface.h +++ b/IPXACTmodels/Design/ActiveInterface.h @@ -29,8 +29,8 @@ class IPXACTMODELS_EXPORT ActiveInterface : public HierInterface /*! * The constructor. * - * @param [in] componentRef The name of the referenced component instance. - * @param [in] busRef The name of the referenced bus interface. + * @param [in] componentRef The name of the referenced component instance. + * @param [in] busRef The name of the referenced bus interface. */ ActiveInterface(QString const& componentRef = QString(), QString const& busRef = QString()); @@ -52,7 +52,7 @@ class IPXACTMODELS_EXPORT ActiveInterface : public HierInterface /*! * Comparison operator. * - * @return True, if the interfaces refer the same component and bus interface, otherwise false. + * @return True, if the interfaces refer the same component and bus interface, otherwise false. */ bool operator==(const ActiveInterface& other) const; @@ -64,45 +64,45 @@ class IPXACTMODELS_EXPORT ActiveInterface : public HierInterface /*! * The operator <. * - * @return The operator uses QString to compare instance names and bus interface names. + * @return The operator uses QString to compare instance names and bus interface names. */ bool operator<(const ActiveInterface& other) const; /*! * Checks if the interface referenced a given instance and a bus interface. * - * @param [in] instanceName The name of the component instance to compare to. - * @param [in] busInterfaceName The name of the bus interface to compare to. + * @param [in] instanceName The name of the component instance to compare to. + * @param [in] busInterfaceName The name of the bus interface to compare to. * - * @return True, if the given instance and bus interface are reference by the interface. + * @return True, if the given instance and bus interface are reference by the interface. */ bool references(QString const& instanceName, QString const& busInterfaceName) const; /*! * Get the referenced component. * - * @return The name of the referenced component. + * @return The name of the referenced component. */ QString getComponentReference() const; /*! * Set a new component referenced. * - * @param [in] newComponentReference The new component reference. + * @param [in] newComponentReference The new component reference. */ void setComponentReference(QString const& newComponentReference); /*! * Get a list of excluded ports. * - * @return Pointer to a list containing the excluded ports. + * @return Pointer to a list containing the excluded ports. */ QSharedPointer getExcludePorts() const; /*! * Set a new list of excluded ports. * - * @param [in] newExcludePorts A new list of excluded ports. + * @param [in] newExcludePorts A new list of excluded ports. */ void setExcludePorts(QSharedPointer newExcludePorts); diff --git a/IPXACTmodels/Design/AdHocConnection.h b/IPXACTmodels/Design/AdHocConnection.h index 312400c91..025505782 100644 --- a/IPXACTmodels/Design/AdHocConnection.h +++ b/IPXACTmodels/Design/AdHocConnection.h @@ -31,10 +31,10 @@ class IPXACTMODELS_EXPORT AdHocConnection : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name The name of the adHocConnection. - * @param [in] tiedValue Fixed logic value for the connection. - * @param [in] route The route of the connection. - * @param [in] offPage Specifies whether the connection is off page or not. + * @param [in] name The name of the adHocConnection. + * @param [in] tiedValue Fixed logic value for the connection. + * @param [in] route The route of the connection. + * @param [in] offPage Specifies whether the connection is off page or not. */ AdHocConnection(QString name, QString tiedValue = QString(), @@ -59,92 +59,92 @@ class IPXACTMODELS_EXPORT AdHocConnection : public NameGroup, public Extendable /*! * Gets the internal port references of the connection. * - * @return A pointer to a list of internal port references. + * @return A pointer to a list of internal port references. */ QSharedPointer > > getInternalPortReferences() const; /*! * Gets the external port references of the connection. * - * @return A pointer to a list of external port references. + * @return A pointer to a list of external port references. */ QSharedPointer > > getExternalPortReferences() const; /*! * Sets the route of the connection. * - * @param [in] route The route to set. + * @param [in] route The route to set. */ void setRoute(QList const& route) const; /*! * Gets the route of the connection. * - * @return The route of the connection. + * @return The route of the connection. */ QList getRoute() const; /*! * Checks if the connection is treated as an off-page connection. * - * @return True if off-page connection, otherwise false. + * @return True if off-page connection, otherwise false. */ bool isOffPage() const; /*! * Set/unset the connection to off-page connection. * - * @param [in] offPage True if set to off-page, otherwise false. + * @param [in] offPage True if set to off-page, otherwise false. */ void setOffPage(bool offPage); /*! * Set a new list of internal port references. * - * @param [in] newInternals The new list of internal port references. + * @param [in] newInternals The new list of internal port references. */ void setInternalPortReferences(QSharedPointer > > newInternals); /*! * Set a new list of external port references. * - * @param [in] newExternals The new list of external port references. + * @param [in] newExternals The new list of external port references. */ void setExternalPortReferences(QSharedPointer > > newExternals); /*! * Get the presence of the connection. * - * @return The presence value of the connection. + * @return The presence value of the connection. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new value for presence. + * @param [in] newIsPresent The new value for presence. */ void setIsPresent(QString const& newIsPresent); /*! * Get the tied value of the connection. * - * @return The tied value. + * @return The tied value. */ QString getTiedValue() const; /*! * Set the tied value. * - * @param [in] newTiedValue The new tied value. + * @param [in] newTiedValue The new tied value. */ void setTiedValue(QString const& newTiedValue); /*! * Change the component reference of contained interfaces. * - * @param [in] oldName The old component reference. - * @param [in] newName The new component reference. + * @param [in] oldName The old component reference. + * @param [in] newName The new component reference. */ void changeInterfaceComponentReferences(QString const& oldName, QString const& newName) const; diff --git a/IPXACTmodels/Design/ComponentInstance.h b/IPXACTmodels/Design/ComponentInstance.h index 188cb6c6d..d9140a84e 100644 --- a/IPXACTmodels/Design/ComponentInstance.h +++ b/IPXACTmodels/Design/ComponentInstance.h @@ -56,8 +56,8 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * The constructor. * - * @param [in] instanceName The name of the component instance. - * @param [in] componentRef The referenced component. + * @param [in] instanceName The name of the component instance. + * @param [in] componentRef The referenced component. */ ComponentInstance(QString const& instanceName, QSharedPointer componentRef); @@ -79,7 +79,7 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Sets the name of the instance. * - * @param [in] name The name to set. + * @param [in] name The name to set. */ void setInstanceName(QString const& name); @@ -91,7 +91,7 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Sets the component reference. * - * @param [in] vlnv The referenced component VLNV. + * @param [in] vlnv The referenced component VLNV. */ void setComponentRef(QSharedPointer newComponentRef); @@ -103,21 +103,21 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Get the presence of the instance. * - * @return A QString containing the presence. + * @return A QString containing the presence. */ QString getIsPresent() const; /*! * Set the presence of the instance. * - * @param [in] newIsPresent The new value for the presence. + * @param [in] newIsPresent The new value for the presence. */ void setIsPresent(QString const& newIsPresent); /*! * Sets the configurable element values. * - * @param [in] values The configurable element values to set. + * @param [in] values The configurable element values to set. */ void setConfigurableElementValues(QSharedPointer > > newValues); @@ -131,74 +131,74 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Sets the global position of the instance. * - * @param [in] pos The global position in the design, in pixels. + * @param [in] pos The global position in the design, in pixels. */ void setPosition(QPointF const& pos); /*! * Sets the name of the import source instance. * - * @param [in] nameRef The name of the import source instance. + * @param [in] nameRef The name of the import source instance. */ void setImportRef(QString const& nameRef); /*! * Sets the property values. * - * @param [in] values The property values. + * @param [in] values The property values. */ void setPropertyValues(QMap const& values); /*! * Updates the position of the bus interface with the given name. * - * @param [in] name The name of the bus interface. - * @param [in] pos The local position of the bus interface. + * @param [in] name The name of the bus interface. + * @param [in] pos The local position of the bus interface. */ void updateBusInterfacePosition(QString const& name, QPointF const& pos); /*! * Remove bus interface position. * - * @param [in] interfaceName Name of the removed bus interface. + * @param [in] interfaceName Name of the removed bus interface. */ void removeBusInterfacePosition(QString const& interfaceName); /*! * Updates the position of the ad-hoc port with the given name. * - * @param [in] name The name of the ad-hoc port. - * @param [in] pos The local position of the ad-hoc port. + * @param [in] name The name of the ad-hoc port. + * @param [in] pos The local position of the ad-hoc port. */ void updateAdHocPortPosition(QString const& name, QPointF const& pos); /*! * Updates the position of the API interface with the given name. * - * @param [in] name The name of the API interface. - * @param [in] pos The local position of the API interface. + * @param [in] name The name of the API interface. + * @param [in] pos The local position of the API interface. */ void updateApiInterfacePosition(QString const& name, QPointF const& pos); /*! * Remove API interface position. * - * @param [in] name Name of the selected API interface. + * @param [in] name Name of the selected API interface. */ void removeApiInterfacePosition(QString const& name); /*! * Updates the position of the API interface with the given name. * - * @param [in] name The name of the API interface. - * @param [in] pos The local position of the API interface. + * @param [in] name The name of the API interface. + * @param [in] pos The local position of the API interface. */ void updateComInterfacePosition(QString const& name, QPointF const& pos); /*! * Remove COM interface position. * - * @param [in] name Name of the selected COM interface. + * @param [in] name Name of the selected COM interface. */ void removeComInterfacePosition(QString const& name); @@ -210,14 +210,14 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Set the imported value for the component instance. * - * @param [in] isImported True if the component is imported, false otherwise. + * @param [in] isImported True if the component is imported, false otherwise. */ void setImported(bool isImported); /*! * Returns true if the instance is an imported one. * - * @return True if the component is imported, false otherwise. + * @return True if the component is imported, false otherwise. */ bool isImported() const; @@ -259,49 +259,49 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Get the Uuid of the instance. * - * @return QString containing the uuid. + * @return QString containing the uuid. */ QString getUuid() const; /*! * Set the universally unique identifier (Kactus2 extension). * - * @param [in] newUuid The new unique identifier. + * @param [in] newUuid The new unique identifier. */ void setUuid(QString const& newUuid); /*! * Checks if the component instance is a draft. * - * @return True, if the instance is a draft, otherwise false. + * @return True, if the instance is a draft, otherwise false. */ bool isDraft() const; /*! * Set the draft status of a component instance (Kactus2 extension). * - * @param [in] instanceIsDraft True for draft component instance, false for normal. + * @param [in] instanceIsDraft True for draft component instance, false for normal. */ void setDraft(bool instanceIsDraft); /*! * Hides an ad hoc port in the instance. * - * @param [in] portName The name of the port to hide. + * @param [in] portName The name of the port to hide. */ void hideAdHocPort(QString const& portName); /*! * Sets the file set reference. * - * @param [in] fileSetName The name of the referenced file set in the top-level component. + * @param [in] fileSetName The name of the referenced file set in the top-level component. */ void setFileSetRef(QString const& fileSetName); /*! * Sets the HW mapping information for the SW instance. * - * @param [in] hwRef The name of the HW component instance to which the SW instance is mapped. + * @param [in] hwRef The name of the HW component instance to which the SW instance is mapped. */ void setMapping(QString const& hwRef); @@ -322,11 +322,11 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Update a positions map extension (Kactus2 extension). * - * @param [in] newReferenceName The name of the new reference. - * @param [in] newPosition The position of the new reference. - * @param [in] groupIdentifier The identifier for the group. - * @param [in] itemIdentifier The identifier for the item. - * @param [in] referenceIdentifier The identifier for the reference. + * @param [in] newReferenceName The name of the new reference. + * @param [in] newPosition The position of the new reference. + * @param [in] groupIdentifier The identifier for the group. + * @param [in] itemIdentifier The identifier for the item. + * @param [in] referenceIdentifier The identifier for the reference. */ void updatePositionsMap(QString const& newReferenceName, QPointF const& newPosition, QString const& groupIdentifier, QString const& itemIdentifier, QString const& referenceIdentifier) const; @@ -337,9 +337,9 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Get a map of positions (Kactus2 extension). * - * @param [in] groupIdentifier The identifier of the position group. - * @param [in] itemIdentifier The identifier of the position item. - * @param [in] referenceIdentifier The identifier of the position reference. + * @param [in] groupIdentifier The identifier of the position group. + * @param [in] itemIdentifier The identifier of the position item. + * @param [in] referenceIdentifier The identifier of the position reference. */ QMap getPositionMap(QString const& groupIdentifier, QString const& itemIdentifier, QString const& referenceIdentifier) const; @@ -348,8 +348,8 @@ class IPXACTMODELS_EXPORT ComponentInstance : public Extendable, public NameGrou /*! * Sets the Kactus2 vendor extension value. If the extension does not exist, it is created. * - * @param [in] value The value to set. - * @param [in] extensionType The type of the vendor extension. + * @param [in] value The value to set. + * @param [in] extensionType The type of the vendor extension. */ void setValueExtension(QString const& value, QString const& extensionType); diff --git a/IPXACTmodels/Design/ComponentInstanceReader.h b/IPXACTmodels/Design/ComponentInstanceReader.h index bfd692cf5..7e3e6c077 100644 --- a/IPXACTmodels/Design/ComponentInstanceReader.h +++ b/IPXACTmodels/Design/ComponentInstanceReader.h @@ -28,10 +28,10 @@ namespace ComponentInstanceReader /*! * Creates a component instance from XML definition. * - * @param [in] instanceNode The XML description of the component instance. - * @param [in] docRevision The IP-XACT revision to comply. + * @param [in] instanceNode The XML description of the component instance. + * @param [in] docRevision The IP-XACT revision to comply. * - * @return The created component instance. + * @return The created component instance. */ IPXACTMODELS_EXPORT QSharedPointer createComponentInstanceFrom(QDomNode const& instanceNode, Document::Revision docRevision); @@ -41,50 +41,50 @@ namespace ComponentInstanceReader /*! * Parse the power domain links of the instance. * - * @param [in] instanceNode XML description of the instance. - * @param [in] instance The component instance whose power domain links are read. + * @param [in] instanceNode XML description of the instance. + * @param [in] instance The component instance whose power domain links are read. * - * @return + * @return */ void parsePowerDomainLinks(QDomNode const& instanceNode, QSharedPointer instance) ; /*! * Parse extensions of the instance. * - * @param [in] componentInstanceNode XML description of the extensions. - * @param [in] instance The component instance whose extensions are read. + * @param [in] componentInstanceNode XML description of the extensions. + * @param [in] instance The component instance whose extensions are read. */ void parseExtensions(const QDomNode& componentInstanceNode, QSharedPointer instance) ; /*! * Parse the draft flag of the instance. * - * @param [in] draftNode XML description of the draft flag. - * @param [in] instance The possessing component instance. + * @param [in] draftNode XML description of the draft flag. + * @param [in] instance The possessing component instance. */ void parseDraft(QDomElement const& draftNode, QSharedPointer instance) ; /*! * Parse the position of the instance. * - * @param [in] positionElement XML description of the instance position. - * @param [in] instance The possessing component instance. + * @param [in] positionElement XML description of the instance position. + * @param [in] instance The possessing component instance. */ void parsePosition(QDomElement const& positionElement, QSharedPointer instance) ; /*! * Parse import information. * - * @param [in] importElement XML description of the instance import. - * @param [in] instance The possessing component instance. + * @param [in] importElement XML description of the instance import. + * @param [in] instance The possessing component instance. */ void parseImport(QDomElement const& importElement, QSharedPointer instance) ; /*! * Parse port positions. * - * @param [in] portPositionsElement XML description of the component instance port positions. - * @param [in] instance The possessing component instance. + * @param [in] portPositionsElement XML description of the component instance port positions. + * @param [in] instance The possessing component instance. */ void parsePortPositions(QDomElement const& portPositionsElement, QSharedPointer instance) ; @@ -92,16 +92,16 @@ namespace ComponentInstanceReader /*! * Parse ad-hoc visibilities. * - * @param [in] adHocElement XML description of the ad-hoc visibilities. - * @param [in] instance The possessing component instance. + * @param [in] adHocElement XML description of the ad-hoc visibilities. + * @param [in] instance The possessing component instance. */ void parseAdHocVisibilities(QDomElement const& adHocElement, QSharedPointer instance) ; /*! * Parse api interface positions. * - * @param [in] apiElement XML description of the api interfaces. - * @param [in] instance The possessing component instance. + * @param [in] apiElement XML description of the api interfaces. + * @param [in] instance The possessing component instance. */ void parseApiInterfacePositions(QDomElement const& apiElement, QSharedPointer instance) ; @@ -109,8 +109,8 @@ namespace ComponentInstanceReader /*! * Parse com interface positions. * - * @param [in] comElement XML description of the com interfaces. - * @param [in] instance The possessing component instance. + * @param [in] comElement XML description of the com interfaces. + * @param [in] instance The possessing component instance. */ void parseComInterfacePositions(QDomElement const& comElement, QSharedPointer instance) ; @@ -118,17 +118,17 @@ namespace ComponentInstanceReader /*! * Parse property values. * - * @param [in] propertyElement XML description of the property values. - * @param [in] instance The possessing component instance. + * @param [in] propertyElement XML description of the property values. + * @param [in] instance The possessing component instance. */ void parsePropertyValues(QDomElement const& propertyElement, QSharedPointer instance) ; /*! * Create mapped positions. * - * @param [in] positionElement XML description of the positions. - * @param [in] itemIdentifier Identifier for the containing XML element. - * @param [in] referenceIdentifier Identifier for the reference. + * @param [in] positionElement XML description of the positions. + * @param [in] itemIdentifier Identifier for the containing XML element. + * @param [in] referenceIdentifier Identifier for the reference. */ QMap createMappedPositions(QDomElement const& positionElement, QString const& itemIdentifier, QString const& referenceIdentifier) ; @@ -136,16 +136,16 @@ namespace ComponentInstanceReader /*! * Parse file set reference. * - * @param [in] fileSetRefElement XML description of the file set reference. - * @param [in] instance The possessing component instance. + * @param [in] fileSetRefElement XML description of the file set reference. + * @param [in] instance The possessing component instance. */ void parseFileSetRef(QDomElement const& fileSetRefElement, QSharedPointer instance) ; /*! * Parse hardware mapping. * - * @param [in] mappingElement XML description of the mapping. - * @param [in] instance The possessing component instance. + * @param [in] mappingElement XML description of the mapping. + * @param [in] instance The possessing component instance. */ void parseMapping(QDomElement const& mappingElement, QSharedPointer instance) ; } diff --git a/IPXACTmodels/Design/ComponentInstanceWriter.h b/IPXACTmodels/Design/ComponentInstanceWriter.h index 55a2f2b83..ef786a9a6 100644 --- a/IPXACTmodels/Design/ComponentInstanceWriter.h +++ b/IPXACTmodels/Design/ComponentInstanceWriter.h @@ -28,9 +28,9 @@ namespace ComponentInstanceWriter /*! * Write the component instance. * - * @param [in] writer The used XML writer. - * @param [in] design The selected component instance. - * @param [in] docRevision The IP-XACT standard revision to apply. + * @param [in] writer The used XML writer. + * @param [in] design The selected component instance. + * @param [in] docRevision The IP-XACT standard revision to apply. */ IPXACTMODELS_EXPORT void writeComponentInstance(QXmlStreamWriter& writer, QSharedPointer instance, Document::Revision docRevision); @@ -40,9 +40,9 @@ namespace ComponentInstanceWriter /*! * Write a configurable VLNV. * - * @param [in] writer The used XML writer. - * @param [in] VLNVreference The configurable VLNV. - * @param [in] xmlElementName The name of the XML element. + * @param [in] writer The used XML writer. + * @param [in] VLNVreference The configurable VLNV. + * @param [in] xmlElementName The name of the XML element. */ void writeConfigurableVLNVReference(QXmlStreamWriter& writer, QSharedPointer VLNVreference, QString const& xmlElementName); @@ -50,8 +50,8 @@ namespace ComponentInstanceWriter /*! * Write the power domain links of the component instance * - * @param [in] writer The used XML writer. - * @param [in] instance The instance whose power domain links to write. + * @param [in] writer The used XML writer. + * @param [in] instance The instance whose power domain links to write. */ void writePowerDomainLinks(QXmlStreamWriter& writer, QSharedPointer instance); } diff --git a/IPXACTmodels/Design/Design.h b/IPXACTmodels/Design/Design.h index da8f0aab1..0913e35ae 100644 --- a/IPXACTmodels/Design/Design.h +++ b/IPXACTmodels/Design/Design.h @@ -53,7 +53,7 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * The constructor. * - * @param [in] vlnv The VLNV for the design. + * @param [in] vlnv The VLNV for the design. */ Design(VLNV const& vlnv, Document::Revision revision); @@ -75,14 +75,14 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Clone this design. * - * @return A pointer to the cloned copy. + * @return A pointer to the cloned copy. */ QSharedPointer clone() const final; /*! * Set the VLNV. * - * @param [in] vlnv The new VLNV. + * @param [in] vlnv The new VLNV. */ void setVlnv(VLNV const& vlnv) final; @@ -94,40 +94,40 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Get the component instances. * - * @return A pointer to a list containing the component instances + * @return A pointer to a list containing the component instances */ QSharedPointer > > getComponentInstances() const; /*! * Get the description of the specified HW instance. * - * @param [in] instanceName The name of the instance to be searched for. + * @param [in] instanceName The name of the instance to be searched for. * - * @return The description of the found HW instance. + * @return The description of the found HW instance. */ QString getHWInstanceDescription(QString const& instanceName) const; /*! * Get a list of the interconnections. * - * @return Pointer to a list of interconnections. + * @return Pointer to a list of interconnections. */ QSharedPointer > > getInterconnections() const; /*! * Check if the specified interface is connected to some other interface within the design. * - * @param [in] instanceName The name of the instance. - * @param [in] interfaceName The name of the interface. + * @param [in] instanceName The name of the instance. + * @param [in] interfaceName The name of the interface. * - * @return True if at least one interconnection is found, false otherwise. + * @return True if at least one interconnection is found, false otherwise. */ bool hasInterconnection(QString const& instanceName, QString const& interfaceName) const; /*! * Get a list of ad-hoc connections. * - * @return Pointer to a list of ad-hoc connections. + * @return Pointer to a list of ad-hoc connections. */ QSharedPointer > > getAdHocConnections() const; @@ -164,35 +164,35 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Set the component instances. * - * @param [in] newComponentInstances A list of new component instances. + * @param [in] newComponentInstances A list of new component instances. */ void setComponentInstances(QSharedPointer > > newComponentInstances); /*! * Set the interconnections. * - * @param [in] newInterconnections A list of new interconnections. + * @param [in] newInterconnections A list of new interconnections. */ void setInterconnections(QSharedPointer > > newInterconnections); /*! * Set the ad-hoc connections. * - * @param [in] newAdHocConnections A list of new ad-hoc connections. + * @param [in] newAdHocConnections A list of new ad-hoc connections. */ void setAdHocConnections(QSharedPointer > > newAdHocConnections); /*! * Sets the API dependencies for the design. * - * @param [in] apiDependencies A list of API dependencies. + * @param [in] apiDependencies A list of API dependencies. */ void setApiConnections(QList > newApiConnections) const; /*! * Sets the COM connections for the design. * - * @param [in] comConnections A list of COM connections. + * @param [in] comConnections A list of COM connections. */ void setComConnections(QList > newComConnections) const; @@ -204,80 +204,80 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Get the dependent files. * - * @return A list of the dependent file names. + * @return A list of the dependent file names. */ QStringList getDependentFiles() const final; /*! * Get dependend VLNVs. * - * @return A list of the dependend VLNVs. + * @return A list of the dependend VLNVs. */ QList getDependentVLNVs() const final; /*! * Get the VLNV of the HW component instantiated with the given name. * - * @param [in] instanceName The name identifying the component instance. + * @param [in] instanceName The name identifying the component instance. * - * @return VLNV of the instantiated component. + * @return VLNV of the instantiated component. */ VLNV getHWComponentVLNV(QString const& instanceName) const; /*! * Check if the design contains a given HW instance. * - * @param [in] instanceName The name of the HW instance being searched. + * @param [in] instanceName The name of the HW instance being searched. * - * @return True if the instance is found, false otherwise. + * @return True if the instance is found, false otherwise. */ bool containsHWInstance(QString const& instanceName) const; /*! * Check if there is a configurable element value set for the given HW instance. * - * @param [in] instanceName The name of the HW instance. - * @param [in] confElementName The identifier of the configurable element value. + * @param [in] instanceName The name of the HW instance. + * @param [in] confElementName The identifier of the configurable element value. * - * @return Ture if the value has been set, otherwise false. + * @return Ture if the value has been set, otherwise false. */ bool hasConfElementValue(QString const& instanceName, QString const& confElementName) const; /*! * Get the configurable element value set for the given HW instance. * - * @param [in] instanceName Identifies the HW instance. - * @param [in] confElementName Identifies the configurable element value. + * @param [in] instanceName Identifies the HW instance. + * @param [in] confElementName Identifies the configurable element value. * - * @return QString containing the configurable element value. + * @return QString containing the configurable element value. */ QString getConfElementValue(QString const& instanceName, QString const& confElementName) const; /*! * Set the implementation type of the design. * - * @param [in] implementation The new implementation type. + * @param [in] implementation The new implementation type. */ void setDesignImplementation(KactusAttribute::Implementation implementation); /*! * Get the implementation type. * - * @return The implementation type. + * @return The implementation type. */ KactusAttribute::Implementation getDesignImplementation() const; /*! * Get the monitor interconnections. * - * @return A pointer to the monitor interconnections. + * @return A pointer to the monitor interconnections. */ QSharedPointer > > getMonitorInterconnecions() const; /*! * Set the monitor interconnections. * - * @param [in] newMonitorInterconnections The new monitor interconnections. + * @param [in] newMonitorInterconnections The new monitor interconnections. */ void setMonitorInterconnections( QSharedPointer > > newMonitorInterconnections); @@ -285,14 +285,14 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Adds a column to the design vendor extensions. * - * @param [in] column The column to add. + * @param [in] column The column to add. */ void addColumn(QSharedPointer column); /*! * Removes a column from design vendor extensions. * - * @param [in] column The column to remove + * @param [in] column The column to remove */ void removeColumn(QSharedPointer column) const; @@ -303,14 +303,14 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Get the interface graphics data. * - * @return A list containing all the interface graphics data. + * @return A list containing all the interface graphics data. */ QList > getInterfaceGraphicsData() const; /*! * Remove the selected interface graphics data. * - * @param [in] name Name of the selected graphics data. + * @param [in] name Name of the selected graphics data. */ void removeInterfaceGraphicsData(QString const& name) const; @@ -318,21 +318,21 @@ class IPXACTMODELS_EXPORT Design : public Document /*! * Copy the shared lists of another design. * - * @param [in] other The design being copied. + * @param [in] other The design being copied. */ void copySharedLists(Design const& other); /*! * Gets the vendor extension containing the column layout. * - * @return The extensions for the column layout. + * @return The extensions for the column layout. */ QSharedPointer getLayoutExtension() const; /*! * Gets the vendor extension containing the interconnection routes. * - * @return The extensions for the interconnection routes. + * @return The extensions for the interconnection routes. */ QSharedPointer getRoutesExtension() const; diff --git a/IPXACTmodels/Design/DesignReader.h b/IPXACTmodels/Design/DesignReader.h index 1e5d5ec76..82f6da0eb 100644 --- a/IPXACTmodels/Design/DesignReader.h +++ b/IPXACTmodels/Design/DesignReader.h @@ -32,9 +32,9 @@ namespace DesignReader /*! * Creates a design from XML definition. * - * @param [in] document The XML document to create the design from. + * @param [in] document The XML document to create the design from. * - * @return The created design. + * @return The created design. */ IPXACTMODELS_EXPORT QSharedPointer createDesignFrom(QDomDocument const& document); @@ -43,40 +43,40 @@ namespace DesignReader /*! * Reads the component instances from XML to design. * - * @param [in] designNode The XML description of the design. - * @param [in] newDesign The new design item. + * @param [in] designNode The XML description of the design. + * @param [in] newDesign The new design item. */ void parseComponentInstances(QDomNode const& designNode, QSharedPointer newDesign); /*! * Reads the interconnections from XML to design. * - * @param [in] designNode The XML description of the design. - * @param [in] newDesign The new design item. + * @param [in] designNode The XML description of the design. + * @param [in] newDesign The new design item. */ void parseInterconnections(QDomNode const& designNode, QSharedPointer newDesign); /*! * Reads a single interconnection from XML. * - * @param [in] interconnectionNode The XML description of the interconnection. - * @param [in] newDesign The new design item. + * @param [in] interconnectionNode The XML description of the interconnection. + * @param [in] newDesign The new design item. */ void parseSingleInterconnection(QDomNode const& interconnectionNode, QSharedPointer newDesign); /*! * Reads an interconnection between components. * - * @param [in] interconnectionNode The XML description of the interconnection. - * @param [in] newDesign The new design item. + * @param [in] interconnectionNode The XML description of the interconnection. + * @param [in] newDesign The new design item. */ void parseComponentInterconnection(QDomNode const& interconnectionNode, QSharedPointer newDesign); /*! * Reads interconnection extensions. * - * @param [in] interconnectionNode XML description of the interconnection. - * @param [in] interconnection The new interconnection item. + * @param [in] interconnectionNode XML description of the interconnection. + * @param [in] interconnection The new interconnection item. */ void parseInterconnectionExtensions(const QDomNode& interconnectionNode, QSharedPointer interconnection); @@ -84,9 +84,9 @@ namespace DesignReader /*! * Reads an active interface. * - * @param [in] interfaceNode The XML description of the active interface. - * @param [in] newInterface The new interface item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] interfaceNode The XML description of the active interface. + * @param [in] newInterface The new interface item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseActiveInterface(QDomNode const& interfaceNode, QSharedPointer newInterface, Document::Revision docRevision); @@ -94,26 +94,26 @@ namespace DesignReader /*! * Reads a component reference for active interface, monitor interface and ad-hoc connection. * - * @param [in] interfaceNode - * @param [in] docRevision + * @param [in] interfaceNode + * @param [in] docRevision * - * @return The read component reference. + * @return The read component reference. */ QString parseComponentReference(QDomNode const& interfaceNode, Document::Revision docRevision); /*! * Reads a hierarchical interface. * - * @param [in] interfaceNode The XML description of the hierarchical interface. - * @param [in] newInterface The new interface item. + * @param [in] interfaceNode The XML description of the hierarchical interface. + * @param [in] newInterface The new interface item. */ void parseHierInterface(QDomNode const& interfaceNode, QSharedPointer newInterface); /*! * Reads interface extensions. * - * @param [in] interfaceNode XML description of the hierarchical interface. - * @param [in] newInterface The new interface item. + * @param [in] interfaceNode XML description of the hierarchical interface. + * @param [in] newInterface The new interface item. */ void parseHierInterfaceExtensions(const QDomNode& interfaceNode, QSharedPointer newInterface); @@ -121,17 +121,17 @@ namespace DesignReader /*! * Reads a monitor interconnection. * - * @param [in] monitorNode The XML description of the monitor interconnection. - * @param [in] newDesign The new design item. + * @param [in] monitorNode The XML description of the monitor interconnection. + * @param [in] newDesign The new design item. */ void parseMonitorInterconnection(QDomNode const& monitorNode, QSharedPointer newDesign); /*! * Reads a monitor interface. * - * @param [in] interfaceNode The XML description of the monitor interface. - * @param [in] newInterface The new interface item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] interfaceNode The XML description of the monitor interface. + * @param [in] newInterface The new interface item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseMonitorInterface(QDomNode const& interfaceNode, QSharedPointer newInterface, Document::Revision docRevision); @@ -139,25 +139,25 @@ namespace DesignReader /*! * Reads the ad-hoc connections. * - * @param [in] designNode The XML description of the design. - * @param [in] newDesign The new design item. + * @param [in] designNode The XML description of the design. + * @param [in] newDesign The new design item. */ void parseAdHocConnections(QDomNode const& designNode, QSharedPointer newDesign); /*! * Reads a single ad-hoc connection. * - * @param [in] adHocNode XML description of an ad-hoc connection. - * @param [in] newDesign The new design item. + * @param [in] adHocNode XML description of an ad-hoc connection. + * @param [in] newDesign The new design item. */ void parseSingleAdHocConnection(const QDomNode& adHocNode, QSharedPointer newDesign); /*! * Reads the internal port references. * - * @param [in] internalNodes XML description of the internal port references. - * @param [in] newAdHocConnection The new ad-hoc connection item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] internalNodes XML description of the internal port references. + * @param [in] newAdHocConnection The new ad-hoc connection item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseInternalPortReferences(const QDomNodeList& internalNodes, QSharedPointer newAdHocConnection, Document::Revision docRevision); @@ -165,9 +165,9 @@ namespace DesignReader /*! * Reads the external port references. * - * @param [in] externalNodes XML description of the external port references. - * @param [in] newAdHocConnection The new ad-hoc connection item. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] externalNodes XML description of the external port references. + * @param [in] newAdHocConnection The new ad-hoc connection item. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseExternalPortReferences(const QDomNodeList& externalNodes, QSharedPointer newAdHocConnection, @@ -176,8 +176,8 @@ namespace DesignReader /*! * Creates a port reference. * - * @param [in] portReferenceNode The XML description of the port. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] portReferenceNode The XML description of the port. + * @param [in] docRevision The applied IP-XACT standard revision. */ QSharedPointer createPortReference(QDomNode const& portReferenceNode, Document::Revision docRevision); @@ -185,8 +185,8 @@ namespace DesignReader /*! * Reads ad-hoc connection extensions. * - * @param [in] adHocNode XML description of the ad-hoc connection. - * @param [in] newAdHocConnection The new ad-hoc connection item. + * @param [in] adHocNode XML description of the ad-hoc connection. + * @param [in] newAdHocConnection The new ad-hoc connection item. */ void parseAdHocConnectionExtensions(const QDomNode& adHocNode, QSharedPointer newAdHocConnection); @@ -194,83 +194,83 @@ namespace DesignReader /*! * Reads the design vendor extensions. * - * @param [in] documentNode The XML description of the document. - * @param [in] design The new design item. + * @param [in] documentNode The XML description of the document. + * @param [in] design The new design item. */ void parseDesignExtensions(QDomNode const& documentNode, QSharedPointer design); /*! * Reads the design column layout (Kactus2 extension). * - * @param [in] columnLayoutNode The XML description of the column layout. - * @param [in] design The new design item. + * @param [in] columnLayoutNode The XML description of the column layout. + * @param [in] design The new design item. */ void parseColumnLayout(QDomNode const& columnLayoutNode, QSharedPointer design); /*! * Reads the route for a connection (Kactus2 extension). * - * @param [in] routesElement The XML description of the route. - * @param [in] design The new design item. + * @param [in] routesElement The XML description of the route. + * @param [in] design The new design item. * - * @return + * @return */ void parseRoutes(QDomElement const& routesElement, QSharedPointer design); /*! * Reads the software instances (Kactus2 extension). * - * @param [in] swInstancesNode The XML description of the software instances. - * @param [in] design The new design item. + * @param [in] swInstancesNode The XML description of the software instances. + * @param [in] design The new design item. */ void parseSwInstances(QDomNode const& swInstancesNode, QSharedPointer design); /*! * Reads the a single software instance (Kactus2 extension). * - * @param [in] QDomNode const& node The XML description of the software instance. + * @param [in] QDomNode const& node The XML description of the software instance. * - * @return The parsed software instance. + * @return The parsed software instance. */ QSharedPointer parseSwInstance(QDomNode const& node); /*! * Reads the ad-hoc port (Kactus2:extension). * - * @param [in] adHocsNode The XML description of the ad-hoc ports. - * @param [in] design The new design item. + * @param [in] adHocsNode The XML description of the ad-hoc ports. + * @param [in] design The new design item. */ void parseAdHocPortPositions(QDomNode const& adHocsNode, QSharedPointer design); /*! * Reads the api connections (Kactus2 extension). * - * @param [in] apiConnectionsNode The XML description of the api connections. - * @param [in] design The new design item. + * @param [in] apiConnectionsNode The XML description of the api connections. + * @param [in] design The new design item. */ void parseApiConnections(QDomNode const& apiConnectionsNode, QSharedPointerdesign); /*! * Reads the com connections (Kactus2 extension). * - * @param [in] comConnectionsNode The XML description of the com connections. - * @param [in] design The new design item. + * @param [in] comConnectionsNode The XML description of the com connections. + * @param [in] design The new design item. */ void parseComConnections(QDomNode const& comConnectionsNode, QSharedPointer design); /*! * Reads the interface graphics extensions for the design. * - * @param [in] extensionsNode The XML description of the design vendor extensions. - * @param [in] design The new design item. + * @param [in] extensionsNode The XML description of the design vendor extensions. + * @param [in] design The new design item. */ void parseInterfaceGraphics(QDomElement const& extensionsNode, QSharedPointer design); /*! * Reads the sticky notes for the design. * - * @param [in] extensionNode The XML description of the design vendor extensions. - * @param [in] design The new design item. + * @param [in] extensionNode The XML description of the design vendor extensions. + * @param [in] design The new design item. */ void parseNotes(QDomElement const& extensionNode, QSharedPointer design); } diff --git a/IPXACTmodels/Design/DesignWriter.h b/IPXACTmodels/Design/DesignWriter.h index 65d971e99..a99d6d32c 100644 --- a/IPXACTmodels/Design/DesignWriter.h +++ b/IPXACTmodels/Design/DesignWriter.h @@ -27,8 +27,8 @@ namespace DesignWriter /*! * Write the design. * - * @param [in] writer The used XML writer. - * @param [in] design The selected design. + * @param [in] writer The used XML writer. + * @param [in] design The selected design. */ IPXACTMODELS_EXPORT void writeDesign(QXmlStreamWriter& writer, QSharedPointer design); @@ -37,33 +37,33 @@ namespace DesignWriter /*! * Write the start of the XML file. * - * @param [in] writer The used XML writer. - * @param [in] design The selected design. + * @param [in] writer The used XML writer. + * @param [in] design The selected design. */ void writeDesignStart(QXmlStreamWriter& writer, QSharedPointer design); /*! * Write the component instances of the design. * - * @param [in] writer The used XML writer. - * @param [in] design The selected design. + * @param [in] writer The used XML writer. + * @param [in] design The selected design. */ void writeComponentInstances(QXmlStreamWriter& writer, QSharedPointer design); /*! * Write the design interconnections. * - * @param [in] writer The used XML writer. - * @param [in] design The selected design. + * @param [in] writer The used XML writer. + * @param [in] design The selected design. */ void writeInterconnections(QXmlStreamWriter& writer, QSharedPointer design); /*! * Write a single interconnection. * - * @param [in] writer The used XML writer. - * @param [in] currentInterconnection The selected interconnection. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] currentInterconnection The selected interconnection. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeSingleInterconncetion(QXmlStreamWriter& writer, QSharedPointer currentInterconnection, Document::Revision docRevision); @@ -71,9 +71,9 @@ namespace DesignWriter /*! * Write an active interface. * - * @param [in] writer The used XML writer. - * @param [in] activeInterface The selected active interface. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] activeInterface The selected active interface. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeActiveInterface(QXmlStreamWriter& writer, QSharedPointer activeInterface, Document::Revision docRevision); @@ -83,17 +83,17 @@ namespace DesignWriter /*! * Write a hier interface. * - * @param [in] writer The used XML writer. - * @param [in] hierInterface The selected hier interface. + * @param [in] writer The used XML writer. + * @param [in] hierInterface The selected hier interface. */ void writeHierInterface(QXmlStreamWriter& writer, QSharedPointer hierInterface); /*! * Write a monitor interconnection. * - * @param [in] writer The used XML writer. - * @param [in] monitorConnection The selected monitor interconnection. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] monitorConnection The selected monitor interconnection. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeMonitorInterconnection(QXmlStreamWriter& writer, QSharedPointer monitorConnection, Document::Revision docRevision); @@ -101,9 +101,9 @@ namespace DesignWriter /*! * Write a monitor interface. * - * @param [in] writer The used XML writer. - * @param [in] monitorInterface The selected monitor interface. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] monitorInterface The selected monitor interface. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeMonitorInterface(QXmlStreamWriter& writer, QSharedPointer monitorInterface, Document::Revision docRevision); @@ -111,17 +111,17 @@ namespace DesignWriter /*! * Write ad-hoc connections. * - * @param [in] writer The used XML writer. - * @param [in] design The selected design. + * @param [in] writer The used XML writer. + * @param [in] design The selected design. */ void writeAdHocConnections(QXmlStreamWriter& writer, QSharedPointer design); /*! * Write a single ad-hoc connection. * - * @param [in] writer The used XML writer. - * @param [in] adHocConnection The selected ad-hoc connection. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] adHocConnection The selected ad-hoc connection. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeSingleAdHocConnection(QXmlStreamWriter& writer, QSharedPointer adHocConnection, Document::Revision docRevision); @@ -129,9 +129,9 @@ namespace DesignWriter /*! * Write ad-hoc port references. * - * @param [in] writer The used XML writer. - * @param [in] adHocConnection The selected ad-hoc connection. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] adHocConnection The selected ad-hoc connection. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeAdHocPortReferences(QXmlStreamWriter& writer, QSharedPointer adHocConnection, Document::Revision docRevision); @@ -139,9 +139,9 @@ namespace DesignWriter /*! * Write a port reference. * - * @param [in] writer The used XML writer. - * @param [in] portRefernce The selected port reference. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used XML writer. + * @param [in] portRefernce The selected port reference. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writePortReference(QXmlStreamWriter& writer, QSharedPointer portRefernce, Document::Revision docRevision); diff --git a/IPXACTmodels/Design/HierInterface.h b/IPXACTmodels/Design/HierInterface.h index 6dd7a7bb6..9521c28cb 100644 --- a/IPXACTmodels/Design/HierInterface.h +++ b/IPXACTmodels/Design/HierInterface.h @@ -28,7 +28,7 @@ class IPXACTMODELS_EXPORT HierInterface : public Extendable /*! * The constructor. * - * @param [in] busRef The name of the referenced bus interface. + * @param [in] busRef The name of the referenced bus interface. */ explicit HierInterface(QString const& busRef = QString()); @@ -50,7 +50,7 @@ class IPXACTMODELS_EXPORT HierInterface : public Extendable /*! * Comparison operator. * - * @return True, if the bus interfaces reference the same interface. + * @return True, if the bus interfaces reference the same interface. */ bool operator==(const HierInterface& other) const; @@ -67,56 +67,56 @@ class IPXACTMODELS_EXPORT HierInterface : public Extendable /*! * Get the name of the referenced bus interface. * - * @return The name of the referenced bus interface. + * @return The name of the referenced bus interface. */ QString getBusReference() const; /*! * Set the bus interface reference. * - * @param [in] newBusReference The name of the new bus interface reference. + * @param [in] newBusReference The name of the new bus interface reference. */ void setBusReference(QString const& newBusReference); /*! * Get the presence. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence. + * @param [in] newIsPresent The new presence. */ void setIsPresent(QString const& newIsPresent); /*! * Get the description. * - * @return The description. + * @return The description. */ QString getDescription() const; /*! * Set the description. * - * @param [in] newDescription The new description. + * @param [in] newDescription The new description. */ void setDescription(QString const& newDescription); /*! * Set the route to this interface. * - * @param [in] newRoute The new route. + * @param [in] newRoute The new route. */ void setRoute(QList newRoute) const; /*! * Get the route to this interface. * - * @return The route to this interface. + * @return The route to this interface. */ QList getRoute() const; diff --git a/IPXACTmodels/Design/Interconnection.h b/IPXACTmodels/Design/Interconnection.h index a77c98d97..74fcdef77 100644 --- a/IPXACTmodels/Design/Interconnection.h +++ b/IPXACTmodels/Design/Interconnection.h @@ -32,10 +32,10 @@ class IPXACTMODELS_EXPORT Interconnection : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name The name of the interconnection. - * @param [in] startInterface The start interface. - * @param [in] displayName The display name. - * @param [in] description The description. + * @param [in] name The name of the interconnection. + * @param [in] startInterface The start interface. + * @param [in] displayName The display name. + * @param [in] description The description. */ Interconnection(QString const name, QSharedPointer startInterface, QString const& displayName = QString(), QString const& description = QString ()); @@ -63,74 +63,74 @@ class IPXACTMODELS_EXPORT Interconnection : public NameGroup, public Extendable /*! * Checks if the interconnection is treated as an off-page connection. * - * @return True if off-page connection, otherwise false. + * @return True if off-page connection, otherwise false. */ bool isOffPage() const; /*! * Set/unset the connection to off-page connection. * - * @param [in] offPage True if set to off-page, otherwise false. + * @param [in] offPage True if set to off-page, otherwise false. */ void setOffPage(bool offpage); /*! * Get the start interface. * - * @return Pointer to the start interface. + * @return Pointer to the start interface. */ QSharedPointer getStartInterface() const; /*! * Set the start interface. * - * @param [in] newStartInterface The new start interface. + * @param [in] newStartInterface The new start interface. */ void setStartInterface(QSharedPointer newStartInterface); /*! * Get the active interfaces. * - * @return A pointer to a list containing the active interfaces. + * @return A pointer to a list containing the active interfaces. */ QSharedPointer > > getActiveInterfaces() const; /*! * Get the hier interfaces. * - * @return A pointer to a list containing the hier interfaces. + * @return A pointer to a list containing the hier interfaces. */ QSharedPointer > > getHierInterfaces() const; /*! * Get the presence. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence. + * @param [in] newIsPresent The new presence. */ void setIsPresent(QString const& newIsPresent); /*! * Check if an interface references a given component and a bus interface. * - * @param [in] instanceName Name of the component. - * @param [in] busInterfaceName Name of the bus interface. + * @param [in] instanceName Name of the component. + * @param [in] busInterfaceName Name of the bus interface. * - * @return True, if an interface references the given component and bus interface, otherwise false. + * @return True, if an interface references the given component and bus interface, otherwise false. */ bool hasInterfaceReferencingComponent(QString const& instanceName, QString const& busInterfaceName) const; /*! * Change the component reference of contained interfaces. * - * @param [in] oldName The old component reference. - * @param [in] newName The new component reference. + * @param [in] oldName The old component reference. + * @param [in] newName The new component reference. */ void changeInterfaceComponentReferences(QString const& oldComponent, QString const& newComponent); diff --git a/IPXACTmodels/Design/MonitorInterconnection.h b/IPXACTmodels/Design/MonitorInterconnection.h index cb1a3b9bd..9c9e68690 100644 --- a/IPXACTmodels/Design/MonitorInterconnection.h +++ b/IPXACTmodels/Design/MonitorInterconnection.h @@ -30,10 +30,10 @@ class IPXACTMODELS_EXPORT MonitorInterconnection : public NameGroup /*! * The constructor. * - * @param [in] name The name of the interconnection. - * @param [in] activeInterface The monitored active interface. - * @param [in] displayName Display name. - * @param [in] description Description. + * @param [in] name The name of the interconnection. + * @param [in] activeInterface The monitored active interface. + * @param [in] displayName Display name. + * @param [in] description Description. */ MonitorInterconnection(QString const& name, QSharedPointer activeInterface = QSharedPointer(0), @@ -62,42 +62,42 @@ class IPXACTMODELS_EXPORT MonitorInterconnection : public NameGroup /*! * Get the monitored active interface. * - * @return Pointer to the monitored active interface. + * @return Pointer to the monitored active interface. */ QSharedPointer getMonitoredActiveInterface() const; /*! * Set the monitored active interface. * - * @param [in] newActiveInterface The new monitored active interface. + * @param [in] newActiveInterface The new monitored active interface. */ void setMonitoredctiveInterface(QSharedPointer newActiveInterface); /*! * Get the monitor interfaces. * - * @return A pointer to a list of monitor interfaces. + * @return A pointer to a list of monitor interfaces. */ QSharedPointer > > getMonitorInterfaces() const; /*! * Set the monitor interfaces. * - * @param [in] newMonitorInterfaces The new monitor interfaces. + * @param [in] newMonitorInterfaces The new monitor interfaces. */ void setMonitorInterfaces(QSharedPointer > > newMonitorInterfaces); /*! * Get the presence. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence. + * @param [in] newIsPresent The new presence. */ void setIsPresent(QString const& newIsPresent); diff --git a/IPXACTmodels/Design/MonitorInterface.h b/IPXACTmodels/Design/MonitorInterface.h index 4022cdb49..b779c4ade 100644 --- a/IPXACTmodels/Design/MonitorInterface.h +++ b/IPXACTmodels/Design/MonitorInterface.h @@ -27,8 +27,8 @@ class IPXACTMODELS_EXPORT MonitorInterface : public HierInterface /*! * The constructor. * - * @param [in] componentRef The name of the referenced component instance. - * @param [in] busRef The name of the referenced bus interface. + * @param [in] componentRef The name of the referenced component instance. + * @param [in] busRef The name of the referenced bus interface. */ MonitorInterface(QString componentRef = QString(), QString busRef = QString()); @@ -65,38 +65,38 @@ class IPXACTMODELS_EXPORT MonitorInterface : public HierInterface /*! * Checks if the interface referenced a given instance and a bus interface. * - * @param [in] instanceName The name of the component instance to compare to. - * @param [in] busInterfaceName The name of the bus interface to compare to. + * @param [in] instanceName The name of the component instance to compare to. + * @param [in] busInterfaceName The name of the bus interface to compare to. * - * @return True, if the given instance and bus interface are reference by the interface. + * @return True, if the given instance and bus interface are reference by the interface. */ bool references(QString const& instanceName, QString const& busInterfaceName) const; /*! * Get the component reference. * - * @return The name of the referenced component + * @return The name of the referenced component */ QString getComponentReference() const; /*! * Set the component reference. * - * @param [in] newComponentReference The new component reference. + * @param [in] newComponentReference The new component reference. */ void setComponentReference(QString const& newComponentReference); /*! * Get the path. * - * @return The path. + * @return The path. */ QString getPath() const; /*! * Set the path. * - * @param [in] newPath The new path. + * @param [in] newPath The new path. */ void setPath(QString const& newPath); diff --git a/IPXACTmodels/Design/PortReference.h b/IPXACTmodels/Design/PortReference.h index 3058514a1..ab1b5d2ee 100644 --- a/IPXACTmodels/Design/PortReference.h +++ b/IPXACTmodels/Design/PortReference.h @@ -35,8 +35,8 @@ class IPXACTMODELS_EXPORT PortReference /*! * The constructor. * - * @param [in] portRef The name of the referenced port. - * @param [in] componentRef The name of the referenced component. + * @param [in] portRef The name of the referenced port. + * @param [in] componentRef The name of the referenced component. */ PortReference(QString const& portRef, QString const& componentRef = QString()); @@ -58,14 +58,14 @@ class IPXACTMODELS_EXPORT PortReference /*! * Gets the name of the referenced port. * - * @return The referenced port. + * @return The referenced port. */ QString getPortRef() const; /*! * Gets the name of the referenced component instance. * - * @return The name of the referenced component instance. + * @return The name of the referenced component instance. * * @remark Only for internal port references. */ @@ -74,28 +74,28 @@ class IPXACTMODELS_EXPORT PortReference /*! * Set port reference. * - * @param [in] newPortRef The new port reference. + * @param [in] newPortRef The new port reference. */ void setPortRef(QString const& newPortRef); /*! * Set the component reference. * - * @param [in] newComponentRef The new component reference. + * @param [in] newComponentRef The new component reference. */ void setComponentRef(QString const& newComponentRef); /*! * Get the presence. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence. + * @param [in] newIsPresent The new presence. */ void setIsPresent(QString const& newIsPresent); @@ -104,14 +104,14 @@ class IPXACTMODELS_EXPORT PortReference /*! * Get the part select. * - * @return The part select. + * @return The part select. */ QSharedPointer getPartSelect() const; /*! * Set the part select. * - * @param [in] newPartSelect The new part select. + * @param [in] newPartSelect The new part select. */ void setPartSelect(QSharedPointer newPartSelect); diff --git a/IPXACTmodels/Design/validator/AdHocConnectionValidator.h b/IPXACTmodels/Design/validator/AdHocConnectionValidator.h index 44093479d..3dff88779 100644 --- a/IPXACTmodels/Design/validator/AdHocConnectionValidator.h +++ b/IPXACTmodels/Design/validator/AdHocConnectionValidator.h @@ -40,8 +40,8 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ AdHocConnectionValidator(QSharedPointer parser, LibraryInterface* library); @@ -51,61 +51,61 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Change the used component instances. * - * @param [in] newInstances A list of the new component instances. + * @param [in] newInstances A list of the new component instances. */ void changeComponentInstances(QSharedPointer > > newInstances); /*! * Validates the given ad hoc connection. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the ad hoc connection is valid IP-XACT, otherwise false. + * @return True, if the ad hoc connection is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer connection) const; /*! * Check if the name is valid. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer connection) const; /*! * Check if the isPresent is valid. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent) const; /*! * Check if the tied value is valid. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the tied value is valid, otherwise false. + * @return True, if the tied value is valid, otherwise false. */ bool hasValidTiedValue(QSharedPointer connection) const; /*! * Check if the port references are valid. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the port references are valid, otherwise false. + * @return True, if the port references are valid, otherwise false. */ bool hasValidPortReferences(QSharedPointer connection) const; /*! * Locate errors within an ad hoc connection. * - * @param [in] errors List of found errors. - * @param [in] connection The selected ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer connection, QString const& context) const; @@ -119,38 +119,38 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Check if an internal port reference is valid. * - * @param [in] portReference The selected internal port reference. - * @param [in] tiedValue Tied value of the ad hoc connection. + * @param [in] portReference The selected internal port reference. + * @param [in] tiedValue Tied value of the ad hoc connection. * - * @return True, if the internal port reference is valid, otherwise false. + * @return True, if the internal port reference is valid, otherwise false. */ bool internalPortReferenceIsValid(QSharedPointer portReference, QString const& tiedValue) const; /*! * Get the referenced component instance. * - * @param [in] instanceReference The name of the referenced component instance. + * @param [in] instanceReference The name of the referenced component instance. * - * @return The referenced component instance, or a null pointer if the component instance is not found. + * @return The referenced component instance, or a null pointer if the component instance is not found. */ QSharedPointer getReferencedComponentInstance(QString const& instanceReference) const; /*! * Get the component referenced by the component instance. * - * @param [in] referencingInstance The selected component instance. + * @param [in] referencingInstance The selected component instance. * - * @return The referenced component instance, or a null pointer if the component is not found. + * @return The referenced component instance, or a null pointer if the component is not found. */ QSharedPointer getReferencedComponent(QSharedPointer referencingInstance) const; /*! * Get the port referenced by the port reference. * - * @param [in] component The selected component. - * @param [in] portReference The selected port reference. + * @param [in] component The selected component. + * @param [in] portReference The selected port reference. * - * @return The referenced port, or a null pointer if the port is not found. + * @return The referenced port, or a null pointer if the port is not found. */ QSharedPointer getReferencedPort(QSharedPointer component, QSharedPointer portReference) const; @@ -158,46 +158,46 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Check if the referenced port default value is valid. * - * @param [in] tiedValue The tied value of the connection. - * @param [in] referencedPort The referenced port. + * @param [in] tiedValue The tied value of the connection. + * @param [in] referencedPort The referenced port. * - * @return True, if the port default value is valid, otherwise false. + * @return True, if the port default value is valid, otherwise false. */ bool tiedValueIsValidWithReferencedPort(QString const& tiedValue, QSharedPointer referencedPort) const; /*! * Check if the external port reference is valid. * - * @param [in] externalPort The selected external port. + * @param [in] externalPort The selected external port. * - * @return True, if the external port reference is valid, otherwise false. + * @return True, if the external port reference is valid, otherwise false. */ bool externalPortReferenceIsValid(QSharedPointer externalPort) const; /*! * Check if the port reference part select is valid. * - * @param [in] partSelect The selected part select. + * @param [in] partSelect The selected part select. * - * @return True, if the port reference part select is valid, otherwise false. + * @return True, if the port reference part select is valid, otherwise false. */ bool portReferencePartSelectIsValid(QSharedPointer partSelect) const; /*! * Check if an expression is valid unsigned int expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. * - * @return True, if the expression is valid, otherwise false. + * @return True, if the expression is valid, otherwise false. */ bool unsignedIntExpressionIsValid(QString const& expression) const; /*! * Find errors in name. * - * @param [in] errors List of found errors. - * @param [in] connection The selected ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QSharedPointer connection, QString const& context) const; @@ -205,10 +205,10 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in isPresent. * - * @param [in] errors List of found errors. - * @param [in] isPresent The selected isPresent value. - * @param [in] innerContext Context information of the ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] isPresent The selected isPresent value. + * @param [in] innerContext Context information of the ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInIsPresent(QVector& errors, QString const& isPresent, QString const& innerContext, QString const& context) const; @@ -216,9 +216,9 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in tied value. * - * @param [in] errors List of found errors. - * @param [in] connection The selected ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInTiedValue(QVector& errors, QSharedPointer connection, QString const& context) const; @@ -226,10 +226,10 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in port references. * - * @param [in] errors List of found errors. - * @param [in] connection The selected ad hoc connection. - * @param [in] innerContext Context information of the ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected ad hoc connection. + * @param [in] innerContext Context information of the ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInPortReferences(QVector& errors, QSharedPointer connection, QString const& innerContext, QString const& context) const; @@ -237,12 +237,12 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in an internal port reference. * - * @param [in] errors List of found errors. - * @param [in] internalPort The selected internal port reference. - * @param [in] tiedValue The tied value of the connection. - * @param [in] elementName Element name of the internal port reference. - * @param [in] innerContext Context information of the ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] internalPort The selected internal port reference. + * @param [in] tiedValue The tied value of the connection. + * @param [in] elementName Element name of the internal port reference. + * @param [in] innerContext Context information of the ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInInternalPortReference(QVector& errors, QSharedPointer internalPort, QString const& tiedValue, QString const& elementName, QString const& innerContext, QString const& context) @@ -251,11 +251,11 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in an external port reference. * - * @param [in] errors List of found errors. - * @param [in] externalPort The selected external port reference. - * @param [in] elementName Element name of the external port reference. - * @param [in] innerContext Context information of the ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] externalPort The selected external port reference. + * @param [in] elementName Element name of the external port reference. + * @param [in] innerContext Context information of the ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInExternalPortReference(QVector& errors, QSharedPointer externalPort, QString const& elementName, QString const& innerContext, QString const& context) const; @@ -263,11 +263,11 @@ class IPXACTMODELS_EXPORT AdHocConnectionValidator /*! * Find errors in port reference part select. * - * @param [in] errors List of found errors. - * @param [in] partSelect The selected part select. - * @param [in] elementName The element name of the port reference. - * @param [in] innerContext Context information of the ad hoc connection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] partSelect The selected part select. + * @param [in] elementName The element name of the port reference. + * @param [in] innerContext Context information of the ad hoc connection. + * @param [in] context Context to help locate the errors. */ void findErrorsInPortReferencePartSelect(QVector& errors, QSharedPointer partSelect, QString const& elementName, QString const& innerContext, QString const& context) const; diff --git a/IPXACTmodels/Design/validator/ComponentInstanceValidator.h b/IPXACTmodels/Design/validator/ComponentInstanceValidator.h index dd998c373..48c3cc5e5 100644 --- a/IPXACTmodels/Design/validator/ComponentInstanceValidator.h +++ b/IPXACTmodels/Design/validator/ComponentInstanceValidator.h @@ -33,8 +33,8 @@ class IPXACTMODELS_EXPORT ComponentInstanceValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ ComponentInstanceValidator(QSharedPointer parser, LibraryInterface* library); @@ -44,45 +44,45 @@ class IPXACTMODELS_EXPORT ComponentInstanceValidator /*! * Validates the given component instance. * - * @param [in] instance The selected component instance. + * @param [in] instance The selected component instance. * - * @return True, if the component instance is valid IP-XACT, otherwise false. + * @return True, if the component instance is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer instance) const; /*! * Check if the name is valid. * - * @param [in] instance The selected component instance. + * @param [in] instance The selected component instance. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer instance) const; /*! * Check if the isPresent is valid. * - * @param [in] instance The selected component instance. + * @param [in] instance The selected component instance. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer instance) const; /*! * Check if the component reference is valid. * - * @param [in] instance The selected component instance. + * @param [in] instance The selected component instance. * - * @return True, if the component reference is valid, otherwise false. + * @return True, if the component reference is valid, otherwise false. */ bool hasValidComponentReference(QSharedPointer instance) const; /*! * Locate errors within a component instance. * - * @param [in] errors List of found errors. - * @param [in] instance The selected component instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instance The selected component instance. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer instance, QString const& context) const; @@ -96,9 +96,9 @@ class IPXACTMODELS_EXPORT ComponentInstanceValidator /*! * Find errors in name. * - * @param [in] errors List of found errors. - * @param [in] instance The selected component instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instance The selected component instance. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QSharedPointer instance, QString const& context) const; @@ -106,9 +106,9 @@ class IPXACTMODELS_EXPORT ComponentInstanceValidator /*! * Find errors in isPresent. * - * @param [in] errors List of found errors. - * @param [in] instance The selected component instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instance The selected component instance. + * @param [in] context Context to help locate the errors. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer instance, QString const& context) const; @@ -116,9 +116,9 @@ class IPXACTMODELS_EXPORT ComponentInstanceValidator /*! * Find errors in component reference. * - * @param [in] errors List of found errors. - * @param [in] instance The selected component instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instance The selected component instance. + * @param [in] context Context to help locate the errors. */ void findErrorsInComponentReference(QVector& errors, QSharedPointer instance, QString const& context) const; diff --git a/IPXACTmodels/Design/validator/DesignValidator.h b/IPXACTmodels/Design/validator/DesignValidator.h index 901677895..2190a232f 100644 --- a/IPXACTmodels/Design/validator/DesignValidator.h +++ b/IPXACTmodels/Design/validator/DesignValidator.h @@ -39,8 +39,8 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ DesignValidator(QSharedPointer parser, LibraryInterface* library); @@ -50,80 +50,80 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Validates the given design. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the design is valid IP-XACT, otherwise false. + * @return True, if the design is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer design) const; /*! * Check if the design vlnv is valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the vlnv is valid, otherwise false. + * @return True, if the vlnv is valid, otherwise false. */ bool hasValidVLNV(QSharedPointer design) const; /*! * Check if the component instances are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the component instances are valid, otherwise false. + * @return True, if the component instances are valid, otherwise false. */ bool hasValidComponentInstances(QSharedPointer design) const; /*! * Check if the interconnections are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the interconnections are valid, otherwise false. + * @return True, if the interconnections are valid, otherwise false. */ bool hasValidInterconnections(QSharedPointer design) const; /*! * Check if the monitor interconnections are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the monitor interconnections are valid, otherwise false. + * @return True, if the monitor interconnections are valid, otherwise false. */ bool hasValidMonitorInterconnections(QSharedPointer design) const; /*! * Check if the ad hoc connections are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the ad hoc connections are valid, otherwise false. + * @return True, if the ad hoc connections are valid, otherwise false. */ bool hasValidAdHocConnections(QSharedPointer design) const; /*! * Check if the parameters are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer design) const; /*! * Check if the assertions are valid. * - * @param [in] design The selected design. + * @param [in] design The selected design. * - * @return True, if the assertions are valid, otherwise false. + * @return True, if the assertions are valid, otherwise false. */ bool hasValidAssertions(QSharedPointer design) const; /*! * Locate errors within a design. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. + * @param [in] errors List of found errors. + * @param [in] design The selected design. */ void findErrorsIn(QVector& errors, QSharedPointer design) const; @@ -136,17 +136,17 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in design VLNV. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. + * @param [in] errors List of found errors. + * @param [in] design The selected design. */ void findErrorsInVLNV(QVector& errors, QSharedPointer design) const; /*! * Find errors in component instances. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInComponentInstances(QVector& errors, QSharedPointer design, QString const& context) const; @@ -154,9 +154,9 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in interconnections. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInInterconnections(QVector& errors, QSharedPointer design, QString const& context) const; @@ -164,9 +164,9 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in monitor interconnections. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInMonitorInterconnections(QVector& errors, QSharedPointer design, QString const& context) const; @@ -174,9 +174,9 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in ad hoc connections. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInAdHocConnections(QVector& errors, QSharedPointer design, QString const& context) const; @@ -184,9 +184,9 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in parameters. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInParameters(QVector& errors, QSharedPointer design, QString const& context) const; @@ -194,9 +194,9 @@ class IPXACTMODELS_EXPORT DesignValidator /*! * Find errors in assertions. * - * @param [in] errors List of found errors. - * @param [in] design The selected design. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] design The selected design. + * @param [in] context Context to help locate the errors. */ void findErrorsInAssertions(QVector& errors, QSharedPointer design, QString const& context) const; diff --git a/IPXACTmodels/Design/validator/InterconnectionValidator.h b/IPXACTmodels/Design/validator/InterconnectionValidator.h index e1f64964b..b62bce7e4 100644 --- a/IPXACTmodels/Design/validator/InterconnectionValidator.h +++ b/IPXACTmodels/Design/validator/InterconnectionValidator.h @@ -42,8 +42,8 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ InterconnectionValidator(QSharedPointer parser, LibraryInterface* library); @@ -53,88 +53,88 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Change the available component instances. * - * @param [in] newInstances The new component instances. + * @param [in] newInstances The new component instances. */ void changeComponentInstances(QSharedPointer > > newInstances); /*! * Validates the given interconnection. * - * @param [in] interconnection The selected interconnection. + * @param [in] interconnection The selected interconnection. * - * @return True, if the interconnection is valid IP-XACT, otherwise false. + * @return True, if the interconnection is valid IP-XACT, otherwise false. */ bool validateInterconnection(QSharedPointer interconnection) const; /*! * Check if the name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Check if the isPresent is valid. * - * @param [in] isPresent The selected isPresent value. + * @param [in] isPresent The selected isPresent value. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent) const; /*! * Check if the start interface is valid. * - * @param [in] interconnection The selected interconnection. + * @param [in] interconnection The selected interconnection. * - * @return True, if the start interface is valid, otherwise false. + * @return True, if the start interface is valid, otherwise false. */ bool hasValidStartInterface(QSharedPointer interconnection) const; /*! * Check if the interfaces are valid. * - * @param [in] interconnection The selected interconnection. + * @param [in] interconnection The selected interconnection. * - * @return True, if the interfaces are valid, otherwise false. + * @return True, if the interfaces are valid, otherwise false. */ bool hasValidInterfaces(QSharedPointer interConnection) const; /*! * Validates the given monitor interconnection. * - * @param [in] connection The selected monitor interconnection. + * @param [in] connection The selected monitor interconnection. * - * @return True, if the monitor interconnection is valid, otherwise false. + * @return True, if the monitor interconnection is valid, otherwise false. */ bool validateMonitorInterconnection(QSharedPointer connection) const; /*! * Check if the monitored active interface is valid. * - * @param [in] connection The selected monitor interconnection. + * @param [in] connection The selected monitor interconnection. * - * @return True, if the monitored active interface is valid, otherwise false. + * @return True, if the monitored active interface is valid, otherwise false. */ bool hasValidMonitoredActiveInterface(QSharedPointer connection) const; /*! * Check if the monitor interfaces are valid. * - * @param [in] connection The selected monitor interconnection. + * @param [in] connection The selected monitor interconnection. * - * @return True, if the monitor interfaces are valid, otherwise false. + * @return True, if the monitor interfaces are valid, otherwise false. */ bool hasValidMonitorInterfaces(QSharedPointer connection) const; /*! * Locate errors within an interconnection. * - * @param [in] errors List of found errors. - * @param [in] interconnection The selected interconnection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] interconnection The selected interconnection. + * @param [in] context Context to help locate the errors. */ void findErrorsInInterconnection(QVector& errors, QSharedPointer interconnection, QString const& context) const; @@ -142,9 +142,9 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Locate errors within a monitor interconnection. * - * @param [in] errors List of found errors. - * @param [in] connection The selected monitor interconnection. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected monitor interconnection. + * @param [in] context Context to help locate the errors. */ void findErrorsInMonitorInterconnection(QVector& errors, QSharedPointer connection, QString const& context) const; @@ -158,11 +158,11 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Check if a reference combination of component and bus interface is valid. * - * @param [in] referenceCombinations The used component / bus interface combinations. - * @param [in] componentReference The selected component reference. - * @param [in] busReference The selected bus reference. + * @param [in] referenceCombinations The used component / bus interface combinations. + * @param [in] componentReference The selected component reference. + * @param [in] busReference The selected bus reference. * - * @return True, if the component / bus interface reference pair is unique, otherwise false. + * @return True, if the component / bus interface reference pair is unique, otherwise false. */ bool referenceCombinationIsUnique(QMap referenceCombinations, QString const& componentReference, QString const& busReference) const; @@ -170,47 +170,47 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Check if an active interface is valid. * - * @param [in] activeInterface The selected active interface. + * @param [in] activeInterface The selected active interface. * - * @return True, if the active interface is valid, otherwise false. + * @return True, if the active interface is valid, otherwise false. */ bool activeInterfaceIsValid(QSharedPointer activeInterface) const; /*! * Get the reference component instance. * - * @param [in] instanceReference The selected component instance reference. + * @param [in] instanceReference The selected component instance reference. * - * @return The referenced component instance. + * @return The referenced component instance. */ QSharedPointer getReferencedComponentInstance(QString const& instanceReference) const; /*! * Get the component referenced by the component instance. * - * @param [in] referencingInstance The selected component instance. + * @param [in] referencingInstance The selected component instance. * - * @return The referenced component. + * @return The referenced component. */ QSharedPointer getReferencedComponent(QSharedPointer referencingInstance) const; /*! * Check if the bus interface reference is valid. * - * @param [in] component The referenced component. - * @param [in] busReference The selected bus interface reference. + * @param [in] component The referenced component. + * @param [in] busReference The selected bus interface reference. * - * @return True, if the bus interface reference is valid, otherwise false. + * @return True, if the bus interface reference is valid, otherwise false. */ bool busReferenceIsValid(QSharedPointer component, QString const& busReference) const; /*! * Check if the exclude ports of an active interface are valid. * - * @param [in] component The referenced component. - * @param [in] activeInterface The selected active interface. + * @param [in] component The referenced component. + * @param [in] activeInterface The selected active interface. * - * @return True, if the exclude ports are valid, otherwise false. + * @return True, if the exclude ports are valid, otherwise false. */ bool excludePortsAreValid(QSharedPointer component, QSharedPointer activeInterface) const; @@ -218,10 +218,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Check if a single exclude port is valid. * - * @param [in] portReference The selected port reference. - * @param [in] portMaps The port maps to search the port for. + * @param [in] portReference The selected port reference. + * @param [in] portMaps The port maps to search the port for. * - * @return True, if the exclude port is valid, otherwise false. + * @return True, if the exclude port is valid, otherwise false. */ bool singleExcludePortIsValid(QString const& portReference, QSharedPointer > > portMaps) const; @@ -229,19 +229,19 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Check if a monitor interface is valid. * - * @param [in] monitorInterface The selected monitor interface. + * @param [in] monitorInterface The selected monitor interface. * - * @return True, if the monitor interface is valid, otherwise false. + * @return True, if the monitor interface is valid, otherwise false. */ bool monitorInterfaceIsValid(QSharedPointer monitorInterface) const; /*! * Find errors in name. * - * @param [in] errors List of found errors. - * @param [in] name The selected name. - * @param [in] element The name of the containing element. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] name The selected name. + * @param [in] element The name of the containing element. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QString const& name, QString const& element, QString const& context) const; @@ -249,10 +249,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in isPresent. * - * @param [in] errors List of found errors. - * @param [in] isPresent The selected isPresent value. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] isPresent The selected isPresent value. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInIsPresent(QVector& errors, QString const& isPresent, QString const& innerContext, QString const& context) const; @@ -260,10 +260,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in the interconnection start interface. * - * @param [in] errors List of found errors. - * @param [in] interconnection The selected interconnection. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] interconnection The selected interconnection. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInStartInterface(QVector& errors, QSharedPointer interconnection, QString const& innerContext, QString const& context) const; @@ -271,10 +271,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in an active interface. * - * @param [in] errors List of found errors. - * @param [in] activeInterface The selected active interface. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] activeInterface The selected active interface. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInActiveInterface(QVector& errors, QSharedPointer activeInterface, QString const& innerContext, QString const& context) const; @@ -282,12 +282,12 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in component reference. * - * @param [in] errors List of found errors. - * @param [in] componentReference The selected component reference. - * @param [in] referencedInstance The referenced component instance. - * @param [in] elementName The name of the containing element. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] componentReference The selected component reference. + * @param [in] referencedInstance The referenced component instance. + * @param [in] elementName The name of the containing element. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInComponentReference(QVector& errors, QString const& componentReference, QSharedPointer referencedInstance, QString const& elementName, @@ -296,12 +296,12 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in bus interface reference. * - * @param [in] errors List of found errors. - * @param [in] busReference The selected bus interface reference. - * @param [in] referencedComponent The referenced component. - * @param [in] elementName The containing element. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] busReference The selected bus interface reference. + * @param [in] referencedComponent The referenced component. + * @param [in] elementName The containing element. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInBusReference(QVector& errors, QString const& busReference, QSharedPointer referencedComponent, QString const& elementName, QString const& innerContext, @@ -310,11 +310,11 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in exclude ports. * - * @param [in] errors List of found errors. - * @param [in] activeInterface The selected active interface. - * @param [in] referencedComponent The referenced component - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] activeInterface The selected active interface. + * @param [in] referencedComponent The referenced component + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInExcludePorts(QVector& errors, QSharedPointer activeInterface, QSharedPointer referencedComponent, QString const& innerContext) const; @@ -322,10 +322,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in interfaces. * - * @param [in] errors List of found errors. - * @param [in] interconnection The selected interconnection. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] interconnection The selected interconnection. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInInterfaces(QVector& errors, QSharedPointer interConnection, QString const& innerContext, QString const& context) const; @@ -333,10 +333,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in monitored active interface. * - * @param [in] errors List of found errors. - * @param [in] connection The selected connection. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected connection. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInMonitoredActiveInterface(QVector& errors, QSharedPointer connection, QString const& innerContext, QString const& context) @@ -345,10 +345,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in a monitor interface. * - * @param [in] errors List of found errors. - * @param [in] monitorInterface The selected monitor interface. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] monitorInterface The selected monitor interface. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInSingleMonitorInterface(QVector& errors, QSharedPointer monitorInterface, QString const& elementName, QString const& innerContext, @@ -357,10 +357,10 @@ class IPXACTMODELS_EXPORT InterconnectionValidator /*! * Find errors in monitor interfaces. * - * @param [in] errors List of found errors. - * @param [in] connection The selected monitor interconnection. - * @param [in] innerContext The item context to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] connection The selected monitor interconnection. + * @param [in] innerContext The item context to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInMonitorInterfaces(QVector& errors, QSharedPointer connection, QString const& innerContext, QString const& context) const; diff --git a/IPXACTmodels/DesignConfiguration/AbstractorInstance.h b/IPXACTmodels/DesignConfiguration/AbstractorInstance.h index c3124b5b4..bbbc2dec1 100644 --- a/IPXACTmodels/DesignConfiguration/AbstractorInstance.h +++ b/IPXACTmodels/DesignConfiguration/AbstractorInstance.h @@ -36,7 +36,7 @@ class IPXACTMODELS_EXPORT AbstractorInstance : public Extendable /*! * Copy constructor. * - * @param [in] other Target to copy. + * @param [in] other Target to copy. */ AbstractorInstance(const AbstractorInstance& other); @@ -48,84 +48,84 @@ class IPXACTMODELS_EXPORT AbstractorInstance : public Extendable /*! * Get the VLNV reference to the abstractor. * - * @return The configurable VLNV of the abstractor. + * @return The configurable VLNV of the abstractor. */ QSharedPointer getAbstractorRef() const; /*! * Get the description. * - * @return The description. + * @return The description. */ QString getShortDescription() const; /*! * Get the description. * - * @return The description. + * @return The description. */ QString getDescription() const; /*! * Get the display name. * - * @return The display name of the abstractor instance. + * @return The display name of the abstractor instance. */ QString getDisplayName() const; /*! * Get the instance name. * - * @return The name of this instance. + * @return The name of this instance. */ QString getInstanceName() const; /*! * Get the name of the view associated with this instance. * - * @return The selected view name of the instance. + * @return The selected view name of the instance. */ QString getViewName() const; /*! * Set the abstractor reference. * - * @param [in] abstractorRef A VLNV tag of the abstractor reference. + * @param [in] abstractorRef A VLNV tag of the abstractor reference. */ void setAbstractorRef(QSharedPointer abstractorRef); /*! * Set the short description. * - * @param [in] shortDescription The new short description. + * @param [in] shortDescription The new short description. */ void setShortDescription(const QString& shortDescription); /*! * Set the description. * - * @param [in] description The new description. + * @param [in] description The new description. */ void setDescription(const QString& description); /*! * Set the display name. * - * @param [in] displayName The new display name. + * @param [in] displayName The new display name. */ void setDisplayName(const QString& displayName); /*! * Set the name for the instance. * - * @param [in] instanceName The new instance name. + * @param [in] instanceName The new instance name. */ void setInstanceName(const QString& instanceName); /*! * Set the name of the selected view. * - * @param [in] viewName The name of the selected view. + * @param [in] viewName The name of the selected view. */ void setViewName(const QString& viewName); diff --git a/IPXACTmodels/DesignConfiguration/DesignConfiguration.h b/IPXACTmodels/DesignConfiguration/DesignConfiguration.h index 1b4934a46..646d05be6 100644 --- a/IPXACTmodels/DesignConfiguration/DesignConfiguration.h +++ b/IPXACTmodels/DesignConfiguration/DesignConfiguration.h @@ -44,7 +44,7 @@ class IPXACTMODELS_EXPORT DesignConfiguration : public Document /*! * The constructor. * - * @param [in] vlnv VLNV to be set for the design configuration. + * @param [in] vlnv VLNV to be set for the design configuration. */ DesignConfiguration(VLNV const& vlnv, Revision revision); @@ -71,49 +71,49 @@ class IPXACTMODELS_EXPORT DesignConfiguration : public Document /*! * Set the vlnv. * - * @param [in] vlnv Reference to the vlnv to be set. + * @param [in] vlnv Reference to the vlnv to be set. */ void setVlnv(const VLNV& vlnv) final; /*! * Get the design reference. * - * @return VLNV element representing the design. + * @return VLNV element representing the design. */ VLNV getDesignRef() const; /*! * Get the list of generator chain configurations. * - * @return The list containing pointers to the generator chain configurations. + * @return The list containing pointers to the generator chain configurations. */ QSharedPointer > > getGeneratorChainConfs(); /*! * Get the list of interconnection configurations. * - * @return A list containing pointers to the interconnection configurations. + * @return A list containing pointers to the interconnection configurations. */ QSharedPointer > > getInterconnectionConfs(); /*! * Get the list of view configurations. * - * @return A list containing pointers to the view configurations. + * @return A list containing pointers to the view configurations. */ QSharedPointer > > getViewConfigurations(); /*! * Set the design reference. * - * @param [in] designRef A VLNV tag that identifies the design. + * @param [in] designRef A VLNV tag that identifies the design. */ void setDesignRef(const VLNV& designRef); /*! * Set the generator chain configurations. * - * @param [in] generatorChainConfs A list containing pointers to the generator chain configurations. + * @param [in] generatorChainConfs A list containing pointers to the generator chain configurations. */ void setGeneratorChainConfs( QSharedPointer > > generatorChainConfs); @@ -121,7 +121,7 @@ class IPXACTMODELS_EXPORT DesignConfiguration : public Document /*! * Set the interconnection configurations. * - * @param [in] interconnectionConfs A list containing pointers to the interconnection configurations. + * @param [in] interconnectionConfs A list containing pointers to the interconnection configurations. */ void setInterconnectionConfs( QSharedPointer > > interconnectionConfs); @@ -129,100 +129,100 @@ class IPXACTMODELS_EXPORT DesignConfiguration : public Document /*! * Set the view configurations. * - * @param [in] newViewConfigurations A list containing pointers to the view configurations. + * @param [in] newViewConfigurations A list containing pointers to the view configurations. */ void setViewConfigurations(QSharedPointer > > newViewConfigurations); /*! * Get the list of the files needed by this design configuration. * - * @return Empty QStringlist (contains VLNV dependencies). + * @return Empty QStringlist (contains VLNV dependencies). */ virtual QStringList getDependentFiles() const; /*! * Get the list of VLNVs needed by this design configuration. * - * @return A list of pointers to VLNVs that are needed in this design configuration. + * @return A list of pointers to VLNVs that are needed in this design configuration. */ virtual QList getDependentVLNVs() const; /*! * Add a new view configuration to the design configuration. * - * @param [in] instanceName The name of the component instance that's view is set. - * @param [in] viewName The name of the component's view that is set as active. + * @param [in] instanceName The name of the component instance that's view is set. + * @param [in] viewName The name of the component's view that is set as active. */ virtual void addViewConfiguration(QString const& instanceName, QString const& viewName); /*! * Remove the view configuration. * - * @param [in] instanceName The instance name of the view configuration to be removed. + * @param [in] instanceName The instance name of the view configuration to be removed. */ virtual void removeViewConfiguration(QString const& instanceName); /*! * Get the active view configuration for the given component instance. * - * @param [in] instanceName Identifies the component instance. + * @param [in] instanceName Identifies the component instance. * - * @return The active view configuration. + * @return The active view configuration. */ QSharedPointer getViewConfiguration(QString const& instanceName) const; /*! * Get the active view name for the given component instance. * - * @param [in] instanceName Identifies the component instance. + * @param [in] instanceName Identifies the component instance. * - * @return The name of the active view. + * @return The name of the active view. */ QString getActiveView(QString const& instanceName) const; /*! * Check if an active view has been defined for the given instance. * - * @param [in] instanceName The name of the component instance that's active view is searched for. + * @param [in] instanceName The name of the component instance that's active view is searched for. * - * @return True if an active view is found, false otherwise. + * @return True if an active view is found, false otherwise. */ bool hasActiveView(QString const& instanceName) const; /*! * Set the implementation type of the design configuration. * - * @param [in] implementation The implementation type. + * @param [in] implementation The implementation type. */ void setDesignConfigImplementation(KactusAttribute::Implementation implementation); /*! * Get the implementation type. * - * @return The implementation type. + * @return The implementation type. */ KactusAttribute::Implementation getDesignConfigImplementation() const; /*! * Finds and creates instance extensions. * - * @param [in] instanceUUID The id of the instance whose extension is being searched. + * @param [in] instanceUUID The id of the instance whose extension is being searched. * - * @return The instance extension. + * @return The instance extension. */ QSharedPointer findOrCreateInstanceExtension(QString const& instanceUUID); /*! * Gets the override view configuration. * - * @return Pairs of instance id and their overridden views. + * @return Pairs of instance id and their overridden views. */ QMap getKactus2ViewOverrides() const; /*! * Sets the override view configuration. * - * @param [in] kactus2ViewOverrides The new view overrides. + * @param [in] kactus2ViewOverrides The new view overrides. */ void setKactus2ViewOverrides(QMap kactus2ViewOverrides); diff --git a/IPXACTmodels/DesignConfiguration/DesignConfigurationReader.h b/IPXACTmodels/DesignConfiguration/DesignConfigurationReader.h index 06dcbf924..0b4dc8785 100644 --- a/IPXACTmodels/DesignConfiguration/DesignConfigurationReader.h +++ b/IPXACTmodels/DesignConfiguration/DesignConfigurationReader.h @@ -25,9 +25,9 @@ namespace DesignConfigurationReader /*! * Creates a design configuration from XML definition. * - * @param [in] document The XML document to create the design configuration from. + * @param [in] document The XML document to create the design configuration from. * - * @return The created design configuration. + * @return The created design configuration. */ IPXACTMODELS_EXPORT QSharedPointer createDesignConfigurationFrom(QDomDocument const& document); @@ -37,8 +37,8 @@ namespace DesignConfigurationReader /*! * Reads the design reference property from XML to a design configuration. * - * @param [in] designConfigurationNode The XML description of the design configuration. - * @param [in] newDesignConfiguration The item where to insert the design reference. + * @param [in] designConfigurationNode The XML description of the design configuration. + * @param [in] newDesignConfiguration The item where to insert the design reference. */ void parseDesignReference(QDomNode const& designConfigurationNode, QSharedPointer newDesignConfiguration); @@ -46,8 +46,8 @@ namespace DesignConfigurationReader /*! * Reads the generator chain configurations from XML to a design configuration. * - * @param [in] designConfigurationDocument The XML description of the design configuration. - * @param [in] newDesignConfiguration The item where to insert the chain configurations. + * @param [in] designConfigurationDocument The XML description of the design configuration. + * @param [in] newDesignConfiguration The item where to insert the chain configurations. */ void parseGeneratorChainConfigurations(QDomDocument const& designConfigurationDocument, QSharedPointer newDesignConfiguration); @@ -55,8 +55,8 @@ namespace DesignConfigurationReader /*! * Reads a single generator chain configurations from XML. * - * @param [in] chainConfigurationNode The XML description of a generator chain configuration. - * @param [in] newDesignConfiguration The item where to insert the chain configuration. + * @param [in] chainConfigurationNode The XML description of a generator chain configuration. + * @param [in] newDesignConfiguration The item where to insert the chain configuration. */ void parseSingleGeneratorChainConfiguration(QDomNode const& chainConfigurationNode, QSharedPointer newDesignConfiguration); @@ -64,8 +64,8 @@ namespace DesignConfigurationReader /*! * Reads interconnection configurations from XML. * - * @param [in] designConfigurationDocument The XML description of a design configuration. - * @param [in] newDesignConfiguration The item where to insert the interconnection configurations. + * @param [in] designConfigurationDocument The XML description of a design configuration. + * @param [in] newDesignConfiguration The item where to insert the interconnection configurations. */ void parseInterconnectionConfigurations(QDomDocument const& designConfigurationDocument, QSharedPointer newDesignConfiguration); @@ -73,9 +73,9 @@ namespace DesignConfigurationReader /*! * Reads multiple abstractor instances from XML. * - * @param [in] interconnectionConfigurationNode The XML description of an interconnection configuration. - * @param [in] newInterconnectionConfiguration The item where to insert multiple abstractor instances. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] interconnectionConfigurationNode The XML description of an interconnection configuration. + * @param [in] newInterconnectionConfiguration The item where to insert multiple abstractor instances. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseMultipleAbstractors(QDomNode const& interconnectionConfigurationNode, QSharedPointer newInterconnectionConfiguration, @@ -84,9 +84,9 @@ namespace DesignConfigurationReader /*! * Reads the interface references from XML. * - * @param [in] multipleAbstractorsNode The XML description of multiple abstractor instances. - * @param [in] newMultipleAbstractorInstances The item where to insert the interface references. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] multipleAbstractorsNode The XML description of multiple abstractor instances. + * @param [in] newMultipleAbstractorInstances The item where to insert the interface references. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseInterfaceReferences(QDomNode const& multipleAbstractorsNode, QSharedPointer newMultipleAbstractorInstances, @@ -95,9 +95,9 @@ namespace DesignConfigurationReader /*! * Reads the abstractor instances from XML. * - * @param [in] multipleAbstractorsNode The XML description of a multiple abstractor instances. - * @param [in] newMultipleAbstractorInstances The item where to insert the abstractor instances. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] multipleAbstractorsNode The XML description of a multiple abstractor instances. + * @param [in] newMultipleAbstractorInstances The item where to insert the abstractor instances. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseAbstractorInstances(QDomNode const& multipleAbstractorsNode, QSharedPointer newMultipleAbstractorInstances, @@ -106,18 +106,18 @@ namespace DesignConfigurationReader /*! * Get a list of name containing QDomNode child nodes. * - * @param [in] targetNode The QDomNode from where to get the child nodes. - * @param [in] elementName The tag of the elements to be searched for. + * @param [in] targetNode The QDomNode from where to get the child nodes. + * @param [in] elementName The tag of the elements to be searched for. * - * @return A list of child nodes containing the specified element name. + * @return A list of child nodes containing the specified element name. */ QDomNodeList getNamedChildNodes(QDomNode const& targetNode, QString elementName); /*! * Reads the view configurations from XML. * - * @param [in] designConfigurationDocument The XML description of a design configuration. - * @param [in] newDesignConfiguration The item where to insert the view configurations. + * @param [in] designConfigurationDocument The XML description of a design configuration. + * @param [in] newDesignConfiguration The item where to insert the view configurations. */ void parseViewConfigurations(QDomDocument const& designConfigurationDocument, QSharedPointer newDesignConfiguration); @@ -125,8 +125,8 @@ namespace DesignConfigurationReader /*! * Reads the design configuration extensions. * - * @param [in] designConfigurationNode XML description of the design configuration. - * @param [in] newDesignConfiguration The new design configuration item. + * @param [in] designConfigurationNode XML description of the design configuration. + * @param [in] newDesignConfiguration The new design configuration item. */ void parseDesignConfigurationExtensions(QDomNode const& designConfigurationNode, QSharedPointer newDesignConfiguration); @@ -134,8 +134,8 @@ namespace DesignConfigurationReader /*! * Reads the view overrides. * - * @param [in] viewOverridesNode XML description of the view overrides. - * @param [in] newDesignConfiguration The new design configuration item. + * @param [in] viewOverridesNode XML description of the view overrides. + * @param [in] newDesignConfiguration The new design configuration item. */ void parseViewOverrides(QDomElement const& viewOverridesNode, QSharedPointer newDesignConfiguration); diff --git a/IPXACTmodels/DesignConfiguration/DesignConfigurationWriter.h b/IPXACTmodels/DesignConfiguration/DesignConfigurationWriter.h index 5c56f8e5b..65e15a719 100644 --- a/IPXACTmodels/DesignConfiguration/DesignConfigurationWriter.h +++ b/IPXACTmodels/DesignConfiguration/DesignConfigurationWriter.h @@ -32,8 +32,8 @@ namespace DesignConfigurationWriter /*! * Writes the given design configuration into xml. * - * @param [in] writer The xml writer to use. - * @param [in] designConfiguration The selected design configuration. + * @param [in] writer The xml writer to use. + * @param [in] designConfiguration The selected design configuration. */ IPXACTMODELS_EXPORT void writeDesignConfiguration(QXmlStreamWriter& writer, QSharedPointer designConfiguration); @@ -43,8 +43,8 @@ namespace DesignConfigurationWriter /*! * Write the document start elements. * - * @param [in] writer The used xml writer. - * @param [in] designConfiguration The selected design configuration. + * @param [in] writer The used xml writer. + * @param [in] designConfiguration The selected design configuration. */ void writeDesignConfigurationStart(QXmlStreamWriter& writer, QSharedPointer designConfiguration); @@ -52,16 +52,16 @@ namespace DesignConfigurationWriter /*! * Write the VLNV of the design configuration's referenced design. * - * @param [in] writer The used xml writer. - * @param [in] designReference The VLNV of the referenced design. + * @param [in] writer The used xml writer. + * @param [in] designReference The VLNV of the referenced design. */ void writeDesignReference(QXmlStreamWriter& writer, VLNV const& designReference); /*! * Write generator chain configuration. * - * @param [in] writer The used xml writer. - * @param [in] designConfiguration The selected design configuration. + * @param [in] writer The used xml writer. + * @param [in] designConfiguration The selected design configuration. */ void writeGeneratorChainConfiguration(QXmlStreamWriter& writer, QSharedPointer designConfiguration); @@ -69,8 +69,8 @@ namespace DesignConfigurationWriter /*! * Write the interconnection configurations. * - * @param [in] writer The used xml writer. - * @param [in] designConfiguration The selected design configuration. + * @param [in] writer The used xml writer. + * @param [in] designConfiguration The selected design configuration. */ void writeInterConnectionConfiguration(QXmlStreamWriter& writer, QSharedPointer designConfiguration); @@ -78,8 +78,8 @@ namespace DesignConfigurationWriter /*! * Write the multiple abstractor instances. * - * @param [in] writer The used xml writer. - * @param [in] multipleAbstractors A list of multipleAbastractors. + * @param [in] writer The used xml writer. + * @param [in] multipleAbstractors A list of multipleAbastractors. */ void writeMultipleAbstractorInstances(QXmlStreamWriter& writer, QSharedPointer > > multipleAbstractors, @@ -88,8 +88,8 @@ namespace DesignConfigurationWriter /*! * Write the interface references. * - * @param [in] writer The used xml writer. - * @param [in] interfaceReferences A list of interface references. + * @param [in] writer The used xml writer. + * @param [in] interfaceReferences A list of interface references. */ void writeInterfaceReferences(QXmlStreamWriter& writer, QSharedPointer > > interfaceReferences, @@ -98,8 +98,8 @@ namespace DesignConfigurationWriter /*! * Write the abstractor instances. * - * @param [in] writer The used xml writer. - * @param [in] abstractorInstances A list of abstractor instances. + * @param [in] writer The used xml writer. + * @param [in] abstractorInstances A list of abstractor instances. */ void writeAbstractorInstances(QXmlStreamWriter& writer, QSharedPointer > > abstractorInstances, @@ -108,8 +108,8 @@ namespace DesignConfigurationWriter /*! * Write the view configurations. * - * @param [in] writer The used xml writer. - * @param [in] designConfiguration The selected design configuration. + * @param [in] writer The used xml writer. + * @param [in] designConfiguration The selected design configuration. */ void writeViewConfigurations(QXmlStreamWriter& writer, QSharedPointer designConfiguration); diff --git a/IPXACTmodels/DesignConfiguration/InterconnectionConfiguration.h b/IPXACTmodels/DesignConfiguration/InterconnectionConfiguration.h index dc9a51e56..5dc5e3105 100644 --- a/IPXACTmodels/DesignConfiguration/InterconnectionConfiguration.h +++ b/IPXACTmodels/DesignConfiguration/InterconnectionConfiguration.h @@ -45,42 +45,42 @@ class IPXACTMODELS_EXPORT InterconnectionConfiguration : public Extendable /*! * Get the isPresent value. * - * @return The isPresent value. + * @return The isPresent value. */ QString getIsPresent() const; /*! * Set the isPresent value. * - * @param [in] newIsPresent The new value for the isPresent. + * @param [in] newIsPresent The new value for the isPresent. */ void setIsPresent(QString const& newIsPresent); /*! * Get the referenced interconnection. * - * @return The name of the referenced interconnection. + * @return The name of the referenced interconnection. */ QString getInterconnectionReference() const; /*! * Set the referenced interconnection. * - * @param [in] newInterconnecionReference The name of the referenced interconnection. + * @param [in] newInterconnecionReference The name of the referenced interconnection. */ void setInterconnectionReference(QString const& newInterconnecionReference); /*! * Get a list of multipleAbstractorInstances. * - * @return A list of multipleAbstractorInstances. + * @return A list of multipleAbstractorInstances. */ QSharedPointer > > getAbstractorInstances() const; /*! * Set the multipleAbstractorInstances. * - * @param [in] newAbstractorInstances A new list of multipleAbstractorInstances. + * @param [in] newAbstractorInstances A new list of multipleAbstractorInstances. */ void setAbstractorInstances( QSharedPointer > > newAbstractorInstances); @@ -88,7 +88,7 @@ class IPXACTMODELS_EXPORT InterconnectionConfiguration : public Extendable /*! * Get the VLNVs used in this element. * - * @return A list of the used VLNV elements. + * @return A list of the used VLNV elements. */ QList getDependantVLNVs() const; diff --git a/IPXACTmodels/DesignConfiguration/InterfaceRef.h b/IPXACTmodels/DesignConfiguration/InterfaceRef.h index d35147780..d51be63ec 100644 --- a/IPXACTmodels/DesignConfiguration/InterfaceRef.h +++ b/IPXACTmodels/DesignConfiguration/InterfaceRef.h @@ -44,42 +44,42 @@ class IPXACTMODELS_EXPORT InterfaceRef : public Extendable /*! * Get the isPresent value. * - * @return The value of isPresent. + * @return The value of isPresent. */ QString getIsPresent() const; /*! * Set the value for isPresent. * - * @param [in] newIsPresent The new value for isPresent. + * @param [in] newIsPresent The new value for isPresent. */ void setIsPresent(QString const& newIsPresent); /*! * Get the name of the referenced component. * - * @return The name of the referenced component. + * @return The name of the referenced component. */ QString getComponentRef() const; /*! * Set the referenced component. * - * @param [in] newComponentRef The name of the referenced component. + * @param [in] newComponentRef The name of the referenced component. */ void setComponentRef(QString const& newComponentRef); /*! * Get the name of the referenced bus interface. * - * @return The name of the referenced bus interface. + * @return The name of the referenced bus interface. */ QString getBusRef() const; /*! * Set the referenced bus interface. * - * @param [in] newBusRef The name of the referenced bus interface. + * @param [in] newBusRef The name of the referenced bus interface. */ void setBusRef(QString const& newBusRef); diff --git a/IPXACTmodels/DesignConfiguration/MultipleAbstractorInstances.h b/IPXACTmodels/DesignConfiguration/MultipleAbstractorInstances.h index bd8ab1765..427b2d206 100644 --- a/IPXACTmodels/DesignConfiguration/MultipleAbstractorInstances.h +++ b/IPXACTmodels/DesignConfiguration/MultipleAbstractorInstances.h @@ -50,49 +50,49 @@ class IPXACTMODELS_EXPORT MultipleAbstractorInstances /*! * Get the value for the isPresent. * - * @return The value of the isPresent. + * @return The value of the isPresent. */ QString getIsPresent() const; /*! * Set the value for the isPresent. * - * @param [in] newIsPresent The new value for the isPresent. + * @param [in] newIsPresent The new value for the isPresent. */ void setIsPresent(QString const& newIsPresent); /*! * Get interface references. * - * @return A list of pointers to the interface references. + * @return A list of pointers to the interface references. */ QSharedPointer > > getInterfaceReferences() const; /*! * Set the interface references. * - * @param [in] newInterfaceReferences A list of pointers to the interface references. + * @param [in] newInterfaceReferences A list of pointers to the interface references. */ void setInterfaceReferences(QSharedPointer > > newInterfaceReferences); /*! * Get the abstractor instances. * - * @return A list of pointers to the abstractor instances. + * @return A list of pointers to the abstractor instances. */ QSharedPointer > > getAbstractorInstances() const; /*! * Set the abstractor instances. * - * @param [in] newAbstractorInstances A list of pointers to the abstractor instances. + * @param [in] newAbstractorInstances A list of pointers to the abstractor instances. */ void setAbstractorInstances(QSharedPointer > > newAbstractorInstances); /*! * Get the VLNVs used in the contained elements. * - * @return A list of used VLNVs. + * @return A list of used VLNVs. */ QList getDependantVLNVs() const; diff --git a/IPXACTmodels/DesignConfiguration/ViewConfiguration.h b/IPXACTmodels/DesignConfiguration/ViewConfiguration.h index e265b5522..bd207efd2 100644 --- a/IPXACTmodels/DesignConfiguration/ViewConfiguration.h +++ b/IPXACTmodels/DesignConfiguration/ViewConfiguration.h @@ -36,7 +36,7 @@ class IPXACTMODELS_EXPORT ViewConfiguration : public Extendable /*! * The constructor. * - * @param [in] instanceName The name of this instance. + * @param [in] instanceName The name of this instance. */ explicit ViewConfiguration(QString const& instanceName); @@ -55,56 +55,56 @@ class IPXACTMODELS_EXPORT ViewConfiguration : public Extendable /*! * Get the name of this instance. * - * @return The name of this instance. + * @return The name of this instance. */ QString getInstanceName() const; /*! * Set the name for this instance. * - * @param [in] newInstanceName The new name for this instance. + * @param [in] newInstanceName The new name for this instance. */ void setInstanceName(QString const& newInstanceName); /*! * Get the value of isPresent. * - * @return The value of isPresent. + * @return The value of isPresent. */ QString getIsPresent() const; /*! * Set the value for isPresent. * - * @param [in] newIsPresent The new value for isPresent. + * @param [in] newIsPresent The new value for isPresent. */ void setIsPresent(QString const& newIsPresent); /*! * Get the referenced view. * - * @return The referenced view. + * @return The referenced view. */ QString getViewReference() const; /*! * Set the referenced view. * - * @param [in] newViewReference The new view reference. + * @param [in] newViewReference The new view reference. */ void setViewReference(QString const& newViewReference); /*! * Get the configurable element values of the referenced view. * - * @return The configurable element values of the referenced view. + * @return The configurable element values of the referenced view. */ QSharedPointer > > getViewConfigurableElements() const; /*! * Set the configurable element values of the referenced view. * - * @param [in] newConfigurableElements The new configurable element values for the referenced view. + * @param [in] newConfigurableElements The new configurable element values for the referenced view. */ void setViewConfigurableElements( QSharedPointer > > newConfigurableElements); diff --git a/IPXACTmodels/DesignConfiguration/validators/DesignConfigurationValidator.h b/IPXACTmodels/DesignConfiguration/validators/DesignConfigurationValidator.h index 5c029e416..a53baa91b 100644 --- a/IPXACTmodels/DesignConfiguration/validators/DesignConfigurationValidator.h +++ b/IPXACTmodels/DesignConfiguration/validators/DesignConfigurationValidator.h @@ -38,8 +38,8 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ DesignConfigurationValidator(QSharedPointer parser, LibraryInterface* library); @@ -49,80 +49,80 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Validates the given design configuration. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the design configuration is valid IP-XACT, otherwise false. + * @return True, if the design configuration is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer designConfiguration); /*! * Check if the design configuration vlnv is valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the vlnv is valid, otherwise false. + * @return True, if the vlnv is valid, otherwise false. */ bool hasValidVLNV(QSharedPointer designConfiguration) const; /*! * Check if the design reference is valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the design reference is valid, otherwise false. + * @return True, if the design reference is valid, otherwise false. */ bool hasValidDesignReference(QSharedPointer designConfiguration) const; /*! * Check if the generator chain configurations are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the generator chain configurations are valid, otherwise false. + * @return True, if the generator chain configurations are valid, otherwise false. */ bool hasValidGeneratorChainConfigurations(QSharedPointer designConfiguration) const; /*! * Check if the interconnection configurations are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the interconnection configurations are valid, otherwise false. + * @return True, if the interconnection configurations are valid, otherwise false. */ bool hasValidInterconnectionConfigurations(QSharedPointer designConfiguration) const; /*! * Check if the view configurations are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the view configurations are valid, otherwise false. + * @return True, if the view configurations are valid, otherwise false. */ virtual bool hasValidViewConfigurations(QSharedPointer designConfiguration) const; /*! * Check if the parameters are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the parameters are valid, otherwise false. + * @return True, if the parameters are valid, otherwise false. */ bool hasValidParameters(QSharedPointer designConfiguration) const; /*! * Check if the assertions are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the assertions are valid, otherwise false. + * @return True, if the assertions are valid, otherwise false. */ bool hasValidAssertions(QSharedPointer designConfiguration) const; /*! * Locate errors within a design configuration. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. */ void findErrorsIn(QVector& errors, QSharedPointer designConfiguration); @@ -131,14 +131,14 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Get the view configuration validator. * - * @return The used view configuration validator. + * @return The used view configuration validator. */ QSharedPointer getViewConfigurationValidator() const; /*! * Get the library interface. * - * @return The used library interface. + * @return The used library interface. */ LibraryInterface* getLibraryHandler() const; @@ -151,17 +151,17 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in design configuration VLNV. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. */ void findErrorsInVLNV(QVector& errors, QSharedPointer designConfiguration) const; /*! * Find errors in design reference. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInDesignReference(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; @@ -169,9 +169,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in generator chain configurations. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInGeneratorChainConfigurations(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; @@ -179,9 +179,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in interconnection configurations. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInInterconnectionConfigurations(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; @@ -189,9 +189,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in view configurations. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInViewConfigurations(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; @@ -199,9 +199,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in parameters. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInParameters(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; @@ -209,9 +209,9 @@ class IPXACTMODELS_EXPORT DesignConfigurationValidator /*! * Find errors in assertions. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInAssertions(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; diff --git a/IPXACTmodels/DesignConfiguration/validators/InterconnectionConfigurationValidator.h b/IPXACTmodels/DesignConfiguration/validators/InterconnectionConfigurationValidator.h index 6c94a403c..0a70c1f70 100644 --- a/IPXACTmodels/DesignConfiguration/validators/InterconnectionConfigurationValidator.h +++ b/IPXACTmodels/DesignConfiguration/validators/InterconnectionConfigurationValidator.h @@ -44,8 +44,8 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ InterconnectionConfigurationValidator(QSharedPointer parser, LibraryInterface* library); @@ -55,52 +55,52 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Change the available elements contained in a design. * - * @param [in] newDesign The new design. + * @param [in] newDesign The new design. */ void designChanged(QSharedPointer newDesign); /*! * Validates the given interconnection configuration. * - * @param [in] configuration The selected interconnection configuration. + * @param [in] configuration The selected interconnection configuration. * - * @return True, if the interconnection configuration is valid IP-XACT, otherwise false. + * @return True, if the interconnection configuration is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer configuration); /*! * Check if the interconnection reference is valid. * - * @param [in] configuration The selected interconnection configuration. + * @param [in] configuration The selected interconnection configuration. * - * @return True, if the interconnection reference is valid, otherwise false. + * @return True, if the interconnection reference is valid, otherwise false. */ bool hasValidInterconnectionReference(QSharedPointer configuration) const; /*! * Check if the is present value is valid. * - * @param [in] isPresent The selected is present value. + * @param [in] isPresent The selected is present value. * - * @return True, if the is present value is valid, otherwise false. + * @return True, if the is present value is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent) const; /*! * Check if the multiple abstractor instances are valid. * - * @param [in] configuration The selected interconnection configuration. + * @param [in] configuration The selected interconnection configuration. * - * @return True, if the multiple abstractor instances are valid, otherwise false. + * @return True, if the multiple abstractor instances are valid, otherwise false. */ bool hasValidMultipleAbstractorInstances(QSharedPointer configuration); /*! * Locate errors within an interconnection configuration. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected interconnection configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected interconnection configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer configuration, QString const& context); @@ -114,70 +114,70 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Check if a multiple abstractor instance is valid. * - * @param [in] multipleInstance The selected multiple abstractor instance. + * @param [in] multipleInstance The selected multiple abstractor instance. * - * @return True, if the multiple abstractor instance is valid, otherwise false. + * @return True, if the multiple abstractor instance is valid, otherwise false. */ bool multipleAbstractorInstanceIsValid(QSharedPointer multipleInstance); /*! * Check if a multiple abstractor instance interface references are valid. * - * @param [in] multipleInstance The selected multiple abstractor instance. + * @param [in] multipleInstance The selected multiple abstractor instance. * - * @return True, if the multiple abstractor instance interface references are valid, otherwise false. + * @return True, if the multiple abstractor instance interface references are valid, otherwise false. */ bool hasValidInterfaceReferences(QSharedPointer multipleInstance); /*! * Check if an interface reference component reference valid. * - * @param [in] interfaceReference The selected interface reference. + * @param [in] interfaceReference The selected interface reference. * - * @return True, if the interface reference component reference is valid, otherwise false. + * @return True, if the interface reference component reference is valid, otherwise false. */ bool interfaceReferenceComponentReferenceIsValid(QSharedPointer interfaceReference) const; /*! * Check if an interface reference bus reference is valid. * - * @param [in] interfaceReference The selected interface reference. + * @param [in] interfaceReference The selected interface reference. * - * @return True, if the interface reference bus reference is valid, otherwise false. + * @return True, if the interface reference bus reference is valid, otherwise false. */ bool interfaceReferenceBusReferenceIsValid(QSharedPointer interfaceReference); /*! * Change the currently available bus interfaces. * - * @param [in] interfaceReference The selected interface reference. + * @param [in] interfaceReference The selected interface reference. */ void changeAvailableBusInterfaces(QSharedPointer interfaceReference); /*! * Check if an abstractor instance is valid. * - * @param [in] instance The selected abstractor instance. + * @param [in] instance The selected abstractor instance. * - * @return True, if the abstractor instance is valid, otherwise false. + * @return True, if the abstractor instance is valid, otherwise false. */ bool abstractorInstanceIsValid(QSharedPointer instance) const; /*! * Check if a name is valid. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; /*! * Find errors in interconnection reference. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected interconnection configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected interconnection configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInInterconnectionReference(QVector& errors, QSharedPointer configuration, QString const& context) const; @@ -185,9 +185,9 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Find errors in is present value. * - * @param [in] errors List of found errors. - * @param [in] isPresent The selected is present value. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] isPresent The selected is present value. + * @param [in] context Context to help locate the errors. */ void findErrorsInIsPresent(QVector& errors, QString const& isPresent, QString const& innerContext, QString const& context) const; @@ -195,10 +195,10 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Find errors in multiple abstractor instances. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected interconnection configuration. - * @param [in] innerContext Context of the interconnection configuration to help locate the errors. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected interconnection configuration. + * @param [in] innerContext Context of the interconnection configuration to help locate the errors. + * @param [in] context Context to help locate the errors. */ void findErrorsInMultipleAbstractorInstances(QVector& errors, QSharedPointer configuration, QString const& innerContext, @@ -207,9 +207,9 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Find errors in a single multiple abstractor instance. * - * @param [in] errors List of found errors. - * @param [in] multipleInstance The selected multiple abstractor instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] multipleInstance The selected multiple abstractor instance. + * @param [in] context Context to help locate the errors. */ void findErrorsInOneMultipleAbstractorInstance(QVector& errors, QSharedPointer multipleInstance, QString const& context); @@ -217,9 +217,9 @@ class IPXACTMODELS_EXPORT InterconnectionConfigurationValidator /*! * Find errors in an abstractor instance. * - * @param [in] errors List of found errors. - * @param [in] instance The selected abstractor instance. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] instance The selected abstractor instance. + * @param [in] context Context to help locate the errors. */ void findErrorsInAbstractorInstance(QVector& errors, QSharedPointer instance, QString const& context) const; diff --git a/IPXACTmodels/DesignConfiguration/validators/ViewConfigurationValidator.h b/IPXACTmodels/DesignConfiguration/validators/ViewConfigurationValidator.h index 8ac5306b8..120dca007 100644 --- a/IPXACTmodels/DesignConfiguration/validators/ViewConfigurationValidator.h +++ b/IPXACTmodels/DesignConfiguration/validators/ViewConfigurationValidator.h @@ -38,8 +38,8 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * The constructor. * - * @param [in] library The used library interface. - * @param [in] parser The used expression parser. + * @param [in] library The used library interface. + * @param [in] parser The used expression parser. */ ViewConfigurationValidator(LibraryInterface* library, QSharedPointer parser); @@ -53,52 +53,52 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * Change the available component instances. * - * @param [in] newInstances The new component instances. + * @param [in] newInstances The new component instances. */ virtual void changeComponentInstances(QSharedPointer > > newInstances); /*! * Validates the given view configuration. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. * - * @return True, if the view configuration is valid IP-XACT, otherwise false. + * @return True, if the view configuration is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer configuration); /*! * Check if the name is valid. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer configuration) const; /*! * Check if the is present value is valid. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. * - * @return True, if the is present value is valid, otherwise false. + * @return True, if the is present value is valid, otherwise false. */ bool hasValidIsPresent(QSharedPointer configuration) const; /*! * Check if the view reference is valid. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. * - * @return True, if the view reference is valid, otherwise false. + * @return True, if the view reference is valid, otherwise false. */ virtual bool hasValidViewReference(QSharedPointer configuration); /*! * Locate errors within a view configuration. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected view configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected view configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer configuration, QString const& context); @@ -108,14 +108,14 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * Get the available component instances. * - * @return A list of the currently available component instances. + * @return A list of the currently available component instances. */ QSharedPointer > > getAvailableInstances() const; /*! * Get the library interface. * - * @return The currently used library interface. + * @return The currently used library interface. */ LibraryInterface* getLibraryHandler() const; @@ -124,16 +124,16 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * Change the currently available views. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. */ void changeAvailableViews(QSharedPointer configuration); /*! * Find errors in name. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected view configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected view configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QSharedPointer configuration, QString const& context) const; @@ -141,9 +141,9 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * Find errors in is present value. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected view configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected view configuration. + * @param [in] context Context to help locate the errors. */ void findErrorsInIsPresent(QVector& errors, QSharedPointer configuration, QString const& context) const; @@ -151,9 +151,9 @@ class IPXACTMODELS_EXPORT ViewConfigurationValidator /*! * Find errors in view reference. * - * @param [in] errors List of found errors. - * @param [in] configuration The selected view configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] configuration The selected view configuration. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInViewReference(QVector& errors, QSharedPointer configuration, QString const& context); diff --git a/IPXACTmodels/common/AccessTypes.h b/IPXACTmodels/common/AccessTypes.h index 6f6416228..bcc5ff1ce 100644 --- a/IPXACTmodels/common/AccessTypes.h +++ b/IPXACTmodels/common/AccessTypes.h @@ -40,19 +40,19 @@ namespace AccessTypes * * If The str does not match any of the enum values the default value specified as parameter will be returned. * - * @param [in] str QString containing the string to be converted. - * @param [in] defaultValue The value that will be returned if no match is found. + * @param [in] str QString containing the string to be converted. + * @param [in] defaultValue The value that will be returned if no match is found. * - * @return Access that matches the str or default value. + * @return Access that matches the str or default value. */ IPXACTMODELS_EXPORT AccessTypes::Access str2Access(QString str, AccessTypes::Access defaultValue); /*! * Convert the Access value to QString. * - * @param [in] access The Access value to be converted into QString. + * @param [in] access The Access value to be converted into QString. * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString access2Str(const AccessTypes::Access access); } diff --git a/IPXACTmodels/common/Assertion.h b/IPXACTmodels/common/Assertion.h index 3b21a30c7..dd516a4bd 100644 --- a/IPXACTmodels/common/Assertion.h +++ b/IPXACTmodels/common/Assertion.h @@ -44,14 +44,14 @@ class IPXACTMODELS_EXPORT Assertion : public NameGroup /*! * Get the assert associated with this assertion. * - * @return The assert. + * @return The assert. */ QString getAssert() const; /*! * Set the assert associated with this assertion. * - * @param [in] newAssert The new assert value. + * @param [in] newAssert The new assert value. */ void setAssert(QString const& newAssert); diff --git a/IPXACTmodels/common/BooleanValue.h b/IPXACTmodels/common/BooleanValue.h index 48a6bc3fb..da5e73c6f 100644 --- a/IPXACTmodels/common/BooleanValue.h +++ b/IPXACTmodels/common/BooleanValue.h @@ -35,21 +35,21 @@ class IPXACTMODELS_EXPORT BooleanValue /*! * Set a boolean value. * - * @param [in] value The new boolean value. + * @param [in] value The new boolean value. */ void setValue(bool value); /*! * Get the contained value as a boolean value. * - * @return True for a BOOL_TRUE, otherwise false. + * @return True for a BOOL_TRUE, otherwise false. */ bool toBool() const; /*! * Gets the value as a string. * - * @return String of the given value. + * @return String of the given value. */ QString toString() const; diff --git a/IPXACTmodels/common/BuildModel.h b/IPXACTmodels/common/BuildModel.h index 2b56cddb9..b7dd2b2e3 100644 --- a/IPXACTmodels/common/BuildModel.h +++ b/IPXACTmodels/common/BuildModel.h @@ -48,42 +48,42 @@ class IPXACTMODELS_EXPORT BuildModel /*! * Get the command. * - * @return The command. + * @return The command. */ QString getCommand() const; /*! * Get the flags. * - * @return The flags. + * @return The flags. */ QString getFlags() const; /*! * Get the replace default flags expression. * - * @return An expression determining should the default flags be replaced or not. + * @return An expression determining should the default flags be replaced or not. */ QString getReplaceDefaultFlags() const; /*! * Set the command. * - * @param [in] newCommand The new command. + * @param [in] newCommand The new command. */ void setCommand(QString const& newCommand); /*! * Set the flags. * - * @param [in] newFlags The new flags. + * @param [in] newFlags The new flags. */ void setFlags(QString const& newFlags); /*! * Set the expression for default flags replacement. * - * @param [in] newReplaceDefaultFlags The new replacing expression. + * @param [in] newReplaceDefaultFlags The new replacing expression. */ void setReplaceDefaultFlags(QString const& newReplaceDefaultFlags); diff --git a/IPXACTmodels/common/CellSpecification.h b/IPXACTmodels/common/CellSpecification.h index 97528430f..2be66ad33 100644 --- a/IPXACTmodels/common/CellSpecification.h +++ b/IPXACTmodels/common/CellSpecification.h @@ -52,42 +52,42 @@ class IPXACTMODELS_EXPORT CellSpecification /*! * Sets the cell strength. * - * @param [in] strength The strength to set. + * @param [in] strength The strength to set. */ void setCellStrength(CellStrengthType strength); /*! * Gets the cell strength. * - * @return The cell strength. + * @return The cell strength. */ CellStrengthType getCellStrength() const; /*! * Sets the cell function. * - * @param [in] function The function to set. + * @param [in] function The function to set. */ void setCellFunction(QString const& function); /*! * Gets the cell function. * - * @return The cell function. + * @return The cell function. */ QString getCellFunction() const; /*! * Sets the cell class. * - * @param [in] cellClass The class to set. + * @param [in] cellClass The class to set. */ void setCellClass(CellClassType cellClass); /*! * Gets the cell class. * - * @return The cell class. + * @return The cell class. */ CellClassType getCellClass() const; diff --git a/IPXACTmodels/common/Choice.h b/IPXACTmodels/common/Choice.h index 889a174ea..79464bc1d 100644 --- a/IPXACTmodels/common/Choice.h +++ b/IPXACTmodels/common/Choice.h @@ -44,23 +44,23 @@ class IPXACTMODELS_EXPORT Choice /*! * Get the name of the choice. * - * @return QString containing the name. + * @return QString containing the name. */ QString name() const; /*! * Set the name of the choice. * - * @param [in] name QString containing the name. + * @param [in] name QString containing the name. */ void setName(const QString& name); /*! * Finds if the choice has an enumeration with the given value. * - * @param [in] enumerationValue The enumeration value to search for. + * @param [in] enumerationValue The enumeration value to search for. * - * @return True, if the choice has an enumeration with the given value, otherwise false. + * @return True, if the choice has an enumeration with the given value, otherwise false. */ bool hasEnumeration(QString const& enumerationValue) const; @@ -68,14 +68,14 @@ class IPXACTMODELS_EXPORT Choice * Gets the enumeration values of the choice. If a text has been specified for the enumeration, * it is returned instead of the value. * - * @return The enumeration values. + * @return The enumeration values. */ QStringList getEnumerationValues() const; /*! * Get the enumerations of the choice. * - * @return The enumerations of the choice. + * @return The enumerations of the choice. */ QSharedPointer > > enumerations() const; diff --git a/IPXACTmodels/common/ChoiceReader.h b/IPXACTmodels/common/ChoiceReader.h index 52c892488..95adfb668 100644 --- a/IPXACTmodels/common/ChoiceReader.h +++ b/IPXACTmodels/common/ChoiceReader.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT ChoiceReader /*! * Creates a new Choice from a given Choice node. * - * @param [in] choiceNode XML description of the choice. + * @param [in] choiceNode XML description of the choice. */ QSharedPointer createChoiceFrom(QDomNode const& choiceNode) const; diff --git a/IPXACTmodels/common/ChoiceWriter.h b/IPXACTmodels/common/ChoiceWriter.h index 38c77403e..1b1ea31ab 100644 --- a/IPXACTmodels/common/ChoiceWriter.h +++ b/IPXACTmodels/common/ChoiceWriter.h @@ -24,8 +24,8 @@ namespace ChoiceWriter /* * Writes a single choice to XML. * - * @param [in] writer The XML writer. - * @param [in] choice The choice to be written. + * @param [in] writer The XML writer. + * @param [in] choice The choice to be written. */ void writeChoice(QXmlStreamWriter& writer, QSharedPointer choice); @@ -34,8 +34,8 @@ namespace ChoiceWriter /* * Writes a single choice enumeration to XML. * - * @param [in] writer The XML writer. - * @param [in] choice The enumeration to be written. + * @param [in] writer The XML writer. + * @param [in] choice The enumeration to be written. */ void writeEnumeration(QXmlStreamWriter& writer, QSharedPointer enumeration); } diff --git a/IPXACTmodels/common/ClockUnit.h b/IPXACTmodels/common/ClockUnit.h index eb0f048be..95d77c0fc 100644 --- a/IPXACTmodels/common/ClockUnit.h +++ b/IPXACTmodels/common/ClockUnit.h @@ -34,49 +34,49 @@ class IPXACTMODELS_EXPORT ClockUnit /*! * The constructor. * - * @param [in] value The contained value. + * @param [in] value The contained value. */ explicit ClockUnit(QString const& value = QString()); /*! * Get the assigned value. * - * @return Value of the clock unit. + * @return Value of the clock unit. */ QString getValue() const; /*! * Set the value. * - * @param [in] newValue The new value to be set. + * @param [in] newValue The new value to be set. */ void setValue(QString const& newValue); /*! * Get the used time units. * - * @return The used time unit. + * @return The used time unit. */ TimeUnit getTimeUnit() const; /*! * Set a new time unit. * - * @param [in] newTimeUnit The new time unit. + * @param [in] newTimeUnit The new time unit. */ void setTimeUnit(TimeUnit newTimeUnit); /*! * Set a new time unit. * - * @param [in] newTimeUnit String form of the new time unit. + * @param [in] newTimeUnit String form of the new time unit. */ void setTimeUnit(QString const& newTimeUnit); /*! * Change the used time unit to string. * - * @return String containing the used time unit. + * @return String containing the used time unit. */ QString timeUnitToString() const; diff --git a/IPXACTmodels/common/CommonItemsReader.h b/IPXACTmodels/common/CommonItemsReader.h index ea3e664d5..159769421 100644 --- a/IPXACTmodels/common/CommonItemsReader.h +++ b/IPXACTmodels/common/CommonItemsReader.h @@ -54,27 +54,27 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parse and create VLNV from XML file. * - * @param [in] vlnvNode XML description of the VLNV. - * @param [in] type The type of the VLNV. + * @param [in] vlnvNode XML description of the VLNV. + * @param [in] type The type of the VLNV. * - * @return The new VLNV. + * @return The new VLNV. */ static VLNV createVLNVFrom(QDomNode const& vlnvNode, VLNV::IPXactType type); /*! * Parses the VLNV from XML to attributes of an element. * - * @param [in] vlnvNode The XML description of the VLNV. - * @param [in] vlnvType The type of the VLNV. + * @param [in] vlnvNode The XML description of the VLNV. + * @param [in] vlnvType The type of the VLNV. */ static VLNV parseVLNVAttributes(QDomNode const& vlnvNode, VLNV::IPXactType vlnvType); /*! * Parses and creates parameters from XML. * - * @param [in] itemNode XML description of item containing the parameters. - * @param [in] revision The standard revision of the XML document being read. - * @return A list of new parameters. + * @param [in] itemNode XML description of item containing the parameters. + * @param [in] revision The standard revision of the XML document being read. + * @return A list of new parameters. */ static QSharedPointer > > parseAndCreateParameters (QDomNode const& itemNode, Document::Revision revision = Document::Revision::Std14); @@ -82,18 +82,18 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parses the vendor extensions from XML to a document. * - * @param [in] itemNode The XML description of the document. - * @param [in] element The object in which the parsed vendor extensions are stored. + * @param [in] itemNode The XML description of the document. + * @param [in] element The object in which the parsed vendor extensions are stored. */ static void parseVendorExtensions(QDomNode const& itemNode, QSharedPointer element); /*! * Parses a configurable VLNV. * - * @param [in] configurableVLNVNode The XML description of the configurable VLNV. - * @param [in] type The type of the configurable VLNV. + * @param [in] configurableVLNVNode The XML description of the configurable VLNV. + * @param [in] type The type of the configurable VLNV. * - * @return A VLNV with configurable element values. + * @return A VLNV with configurable element values. */ static QSharedPointer parseConfigurableVLNVReference( QDomNode const& configurableVLNVNode, VLNV::IPXactType type); @@ -101,9 +101,9 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parses a single configurable element value. * - * @param [in] configurableElementNode The XML description of the configurable element value. + * @param [in] configurableElementNode The XML description of the configurable element value. * - * @return A configurable element value. + * @return A configurable element value. */ static QSharedPointer parseConfigurableElementValue( QDomNode const& configurableElementNode); @@ -111,18 +111,18 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parse attributes of an element. * - * @param [in] attributedNode The XML node containing the attributes. + * @param [in] attributedNode The XML node containing the attributes. * - * @return The parsed attributes. + * @return The parsed attributes. */ static QMap parseAttributes(QDomNode const& attributedNode); /*! * Parses the isPresent element. * - * @param [in] isPresentElement The is present element. + * @param [in] isPresentElement The is present element. * - * @return A QString containing the isPresent element for the item. + * @return A QString containing the isPresent element for the item. */ static QString parseIsPresent(QDomElement const& isPresentElement); @@ -130,8 +130,8 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parses choices. * - * @param [in] itemNode XML description of the IP-XACT element. - * @return A list of choices. + * @param [in] itemNode XML description of the IP-XACT element. + * @return A list of choices. */ static QSharedPointer > > parseChoices(QDomNode const& itemNode); @@ -144,7 +144,7 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parses mode references. * - * @param [in] itemNode XML description of the IP-XACT element. + * @param [in] itemNode XML description of the IP-XACT element. * * @return A list of parsed mode references. */ @@ -153,8 +153,8 @@ class IPXACTMODELS_EXPORT CommonItemsReader /*! * Parse file set references. * - * @param [in] itemNode XML description of the IP-XACT element. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] itemNode XML description of the IP-XACT element. + * @param [in] docRevision The IP-XACT standard revision in use. * * @return A list of parsed file set references. */ diff --git a/IPXACTmodels/common/CommonItemsWriter.h b/IPXACTmodels/common/CommonItemsWriter.h index 6033aac60..83940c140 100644 --- a/IPXACTmodels/common/CommonItemsWriter.h +++ b/IPXACTmodels/common/CommonItemsWriter.h @@ -41,57 +41,57 @@ class CommonItemsWriter /*! * Writes the given VLNV as separate elements into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeVLNVElements(QXmlStreamWriter& writer, VLNV const& vlnv); /*! * Writes the given VLNV as attributes for the current element into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeVLNVAttributes(QXmlStreamWriter& writer, VLNV const& vlnv); /*! * Writes the description for the current element into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeDisplayName(QXmlStreamWriter& writer, QString const& displayName); /*! * Writes the description for the current element into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeDescription(QXmlStreamWriter& writer, QString const& description); /*! * Writes the short description for the current element into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeShortDescription(QXmlStreamWriter& writer, QString const& shortDescription); /*! * Writes the short description for the current element into XML. * - * @param [in] writer The used XML writer. - * @param [in] VLNV The VLNV to write. + * @param [in] writer The used XML writer. + * @param [in] VLNV The VLNV to write. */ static void writeChoices(QXmlStreamWriter& writer, QSharedPointer > > choices); /*! * Writes the parameters of a given document into XML. * - * @param [in] writer The used XML writer. - * @param [in] parameters A list of the parameters to be written. - * @param [in] docRevision The document std revision. + * @param [in] writer The used XML writer. + * @param [in] parameters A list of the parameters to be written. + * @param [in] docRevision The document std revision. */ static void writeParameters(QXmlStreamWriter& writer, QSharedPointer > > parameters, @@ -100,8 +100,8 @@ class CommonItemsWriter /*! * Writes the vendor extensions of a given element into XML. * - * @param [in] writer The XML writer to use. - * @param [in] element The element whose vendor extensions to write. + * @param [in] writer The XML writer to use. + * @param [in] element The element whose vendor extensions to write. */ static void writeVendorExtensions(QXmlStreamWriter& writer, QSharedPointer element); @@ -117,16 +117,16 @@ class CommonItemsWriter /*! * Write the isPresent element. * - * @param [in] writer The XML writer to use. - * @param [in] isPresent The value for the isPresent element. + * @param [in] writer The XML writer to use. + * @param [in] isPresent The value for the isPresent element. */ static void writeIsPresent(QXmlStreamWriter& writer, QString const& isPresent); /*! * Write the configurable element values. * - * @param [in] writer The XML writer to use. - * @param [in] configurableElements The configurable elements. + * @param [in] writer The XML writer to use. + * @param [in] configurableElements The configurable elements. */ static void writeConfigurableElementValues(QXmlStreamWriter& writer, QSharedPointer > > configurableElements); @@ -134,11 +134,11 @@ class CommonItemsWriter /*! * Writes an XML element, if the provided value is not empty. * - * @param [in] writer The XML writer to use. - * @param [in] elementName The name of the element. - * @param [in] value The value of the element. + * @param [in] writer The XML writer to use. + * @param [in] elementName The name of the element. + * @param [in] value The value of the element. * - * @return + * @return */ static void writeNonEmptyElement(QXmlStreamWriter& writer, QString const& elementName, QString const& value); @@ -147,9 +147,9 @@ class CommonItemsWriter /*! * Writes an XML attribute, if the provided value is not empty. * - * @param [in] writer The XML writer to use. - * @param [in] elementName The name of the attribute. - * @param [in] value The value of the attribute. + * @param [in] writer The XML writer to use. + * @param [in] elementName The name of the attribute. + * @param [in] value The value of the attribute. */ static void writeNonEmptyAttribute(QXmlStreamWriter& writer, QString const& attributeName, QString const& value); @@ -158,8 +158,8 @@ class CommonItemsWriter /*! * Write a part select. * - * @param [in] writer The used XML writer. - * @param [in] partSelect The selected part select. + * @param [in] writer The used XML writer. + * @param [in] partSelect The selected part select. */ static void writePartSelect(QXmlStreamWriter& writer, QSharedPointer partSelect); @@ -168,8 +168,8 @@ class CommonItemsWriter /*! * Write mode references. * - * @param [in] writer The used XML writer. - * @param [in] modeReferences The mode references to write. + * @param [in] writer The used XML writer. + * @param [in] modeReferences The mode references to write. */ static void writeModeReferences(QXmlStreamWriter& writer, QSharedPointer > > modeReferences); @@ -177,9 +177,9 @@ class CommonItemsWriter /*! * Write file set references. * - * @param [in] writer The used XML writer. - * @param [in] fileSetRefs The file set references to write. - * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] writer The used XML writer. + * @param [in] fileSetRefs The file set references to write. + * @param [in] docRevision The IP-XACT standard revision in use. */ static void writeFileSetReferences(QXmlStreamWriter& writer, QSharedPointer > > fileSetRefs, diff --git a/IPXACTmodels/common/ConfigurableElementValue.h b/IPXACTmodels/common/ConfigurableElementValue.h index fef22de0e..c93e81aa7 100644 --- a/IPXACTmodels/common/ConfigurableElementValue.h +++ b/IPXACTmodels/common/ConfigurableElementValue.h @@ -32,8 +32,8 @@ class IPXACTMODELS_EXPORT ConfigurableElementValue /*! * The constructor. * - * @param [in] value The value of the configurable element. - * @param [in] referenceId The reference to the id of an element. + * @param [in] value The value of the configurable element. + * @param [in] referenceId The reference to the id of an element. */ ConfigurableElementValue(QString const& value, QString const& referenceId); @@ -50,43 +50,43 @@ class IPXACTMODELS_EXPORT ConfigurableElementValue /*! * Get the configurable value. * - * @return The configurable value. + * @return The configurable value. */ QString getConfigurableValue() const; /*! * Set the configurable value. * - * @param [in] newConfigurableValue The new value for the configurable element. + * @param [in] newConfigurableValue The new value for the configurable element. */ void setConfigurableValue(QString const& newConfigurableValue); /*! * Get the id of the referenced element. * - * @return The id of referenced element. + * @return The id of referenced element. */ QString getReferenceId() const; /*! * Set the id of the referenced element. * - * @param [in] newReferenceId The id of the new reference. + * @param [in] newReferenceId The id of the new reference. */ void setReferenceId(QString const& newReferenceId); /*! * Get the attributes associated with this configurable element value. * - * @return A map containing pairs of attribute names and values. + * @return A map containing pairs of attribute names and values. */ QMap getAttributes() const; /*! * Insert an attribute for the configurable element value. * - * @param [in] attributeKey The key for the attribute. - * @param [in] attributeValue The value for the attribute. + * @param [in] attributeKey The key for the attribute. + * @param [in] attributeValue The value for the attribute. */ void insertAttribute(QString attributeKey, QString attributeValue); diff --git a/IPXACTmodels/common/ConfigurableVLNVReference.h b/IPXACTmodels/common/ConfigurableVLNVReference.h index efe378114..91fff4730 100644 --- a/IPXACTmodels/common/ConfigurableVLNVReference.h +++ b/IPXACTmodels/common/ConfigurableVLNVReference.h @@ -39,11 +39,11 @@ class IPXACTMODELS_EXPORT ConfigurableVLNVReference : public VLNV /*! * The constructor. * - * @param [in] type The ipxact type. - * @param [in] vendor The vendor. - * @param [in] library The library. - * @param [in] name The name. - * @param [in] version The version. + * @param [in] type The ipxact type. + * @param [in] vendor The vendor. + * @param [in] library The library. + * @param [in] name The name. + * @param [in] version The version. */ ConfigurableVLNVReference(const IPXactType& type, const QString& vendor, const QString& library, const QString& name, const QString& version); @@ -51,7 +51,7 @@ class IPXACTMODELS_EXPORT ConfigurableVLNVReference : public VLNV /*! * Constructor with VLNV information. * - * @param [in] configurableVLNV The configurable VLNV. + * @param [in] configurableVLNV The configurable VLNV. */ ConfigurableVLNVReference(const VLNV& configurableVLNV); @@ -68,21 +68,21 @@ class IPXACTMODELS_EXPORT ConfigurableVLNVReference : public VLNV /*! * Sets the VLNV reference. * - * @param [in] vlnv The VLNV to set. + * @param [in] vlnv The VLNV to set. */ void setVLNV(VLNV const& vlnv); /*! * Get the list of configurable element values. * - * @return A pointer to the list of configurable element values. + * @return A pointer to the list of configurable element values. */ QSharedPointer > > getConfigurableElementValues(); /*! * Set the configurable element values. * - * @param [in] newConfigurableElementValues The new list of configurable element values. + * @param [in] newConfigurableElementValues The new list of configurable element values. */ void setConfigurableElementValues( QSharedPointer > > newConfigurableElementValues); @@ -90,18 +90,18 @@ class IPXACTMODELS_EXPORT ConfigurableVLNVReference : public VLNV /*! * Check if the configurable vlnv contains the given configurable element. * - * @param [in] referenceId The ID of the configurable element. + * @param [in] referenceId The ID of the configurable element. * - * @return True, if the configurable element is found, false otherwise. + * @return True, if the configurable element is found, false otherwise. */ bool hasConfigurableElementValue(QString const& referenceId) const; /*! * Get a single configurable element value. * - * @param [in] referenceId The id of the configurable element value. + * @param [in] referenceId The id of the configurable element value. * - * @return The value of the configurable element. + * @return The value of the configurable element. */ QString getSingleConfigurableElementValue(QString const& referenceId) const; diff --git a/IPXACTmodels/common/DirectionTypes.h b/IPXACTmodels/common/DirectionTypes.h index 540b7cd84..13cfc1b13 100644 --- a/IPXACTmodels/common/DirectionTypes.h +++ b/IPXACTmodels/common/DirectionTypes.h @@ -35,9 +35,9 @@ namespace DirectionTypes /*! * Convert the given direction to mirrored. * - * @param [in] originalDirection The direction to convert. + * @param [in] originalDirection The direction to convert. * - * @return The mirrored direction. + * @return The mirrored direction. */ IPXACTMODELS_EXPORT DirectionTypes::Direction convert2Mirrored( DirectionTypes::Direction originalDirection); @@ -45,10 +45,10 @@ namespace DirectionTypes /*! * Convert a given qstring to direction. * - * @param [in] str The string to be converted. - * @param [in] defaultValue The value that will be returned if no match is found. + * @param [in] str The string to be converted. + * @param [in] defaultValue The value that will be returned if no match is found. * - * @return Direction that matches the string or default value. + * @return Direction that matches the string or default value. */ IPXACTMODELS_EXPORT DirectionTypes::Direction str2Direction( QString const& str, DirectionTypes::Direction defaultValue = Direction::DIRECTION_INVALID); @@ -61,9 +61,9 @@ namespace DirectionTypes /*! * Convert a given direction to a qstring. * - * @param [in] direction Direction value to be converted to QString. + * @param [in] direction Direction value to be converted to QString. * - * @return QString matching the given direction. + * @return QString matching the given direction. */ IPXACTMODELS_EXPORT QString direction2Str(const DirectionTypes::Direction direction); diff --git a/IPXACTmodels/common/Document.h b/IPXACTmodels/common/Document.h index e4191823f..e03ffabb1 100644 --- a/IPXACTmodels/common/Document.h +++ b/IPXACTmodels/common/Document.h @@ -51,7 +51,7 @@ class IPXACTMODELS_EXPORT Document : public Extendable /*! * The constructor. * - * @param [in] vlnv The VLNV for the document. + * @param [in] vlnv The VLNV for the document. */ Document(VLNV const& vlnv, Revision revision = Revision::Unknown); @@ -67,120 +67,120 @@ class IPXACTMODELS_EXPORT Document : public Extendable /*! * Creates a perfect copy of the document. * - * @return Copy of the document. + * @return Copy of the document. */ virtual QSharedPointer clone() const = 0; /*! Get the vlnv of the element described in the document. * - * @return The vlnv element + * @return The vlnv element */ VLNV getVlnv() const; /*! Set the vlnv of the document. * - * @param [in] vlnv The vlnv to set. + * @param [in] vlnv The vlnv to set. */ virtual void setVlnv(const VLNV& vlnv); /*! Get the display name of the element described in the document. * - * @return The display name of the document. + * @return The display name of the document. */ QString getDisplayName() const; /*! Set the display name of the document. * - * @param [in] displayName The display name to set. + * @param [in] displayName The display name to set. */ void setDisplayName(const QString& displayName); /*! Get the short description of the element described in the document. * - * @return The short description of the document. + * @return The short description of the document. */ QString getShortDescription() const; /*! Set the short description of the document. * - * @param [in] shortDescription The short description to set. + * @param [in] shortDescription The short description to set. */ void setShortDescription(const QString& shortDescription); /*! Get the description of the document. * - * @return QString containing the description of the document. + * @return QString containing the description of the document. */ QString getDescription() const; /*! Set the description of this document. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description); /*! * Get the parameters for the document. * - * @return The parameters for the document. + * @return The parameters for the document. */ QSharedPointer > > getParameters() const; /*! * Check if the document contains any parameters. * - * @return True, if parameters are found, false otherwise. + * @return True, if parameters are found, false otherwise. */ bool hasParameters() const; /*! * Get the assertions. * - * @return The assertions for the document. + * @return The assertions for the document. */ QSharedPointer > > getAssertions() const; /*! * Sets the comments to display in the beginning of the XML file. * - * @param [in] comment The comments to set. + * @param [in] comment The comments to set. */ void setTopComments(const QString& comment); /*! * Sets the comments to display in the beginning of the XML file. * - * @param [in] comment The comments to set. + * @param [in] comment The comments to set. */ void setTopComments(QStringList const& comments); /*! * Gets the comments in the beginning of the XML file. * - * @return The comments if any. + * @return The comments if any. */ QStringList getTopComments() const; /*! * Adds a new XML processing instruction for the document. * - * @param [in] target The target for the instruction. - * @param [in] data The data in the instruction. + * @param [in] target The target for the instruction. + * @param [in] data The data in the instruction. */ void addXmlProcessingInstructions(QString const& target, QString const& data); /*! * Gets the XML processing instructions for the document. * - * @return The XML processing instructions as target-data pairs. + * @return The XML processing instructions as target-data pairs. */ QVector > getXmlProcessingInstructions() const; /*! * Adds a new XML namespace for the document, if it does not already exist within the document. * - * @param [in] nameSpace The name of the namespace. - * @param [in] uri The uri of the namespace. + * @param [in] nameSpace The name of the namespace. + * @param [in] uri The uri of the namespace. */ void addXmlNameSpace(QString const& nameSpace, QString const& uri); @@ -192,169 +192,169 @@ class IPXACTMODELS_EXPORT Document : public Extendable /*! * Set the XML schema location based on std revision. * - * @param [in] revision The document std revision. + * @param [in] revision The document std revision. */ void setSchemaLocation(Document::Revision revision); /*! * Get the XML schema location. * - * @return The schema location as a string. + * @return The schema location as a string. */ QString getSchemaLocation() const; /*! A pure virtual function to be implemented by subclasses. * - * @return QStringList containing the file dependencies of the document. + * @return QStringList containing the file dependencies of the document. */ virtual QStringList getDependentFiles() const = 0; /*! Get the dependent directories of the object. Default returns empty list. * - * @return empty list, re-implement in sub-classes. + * @return empty list, re-implement in sub-classes. */ virtual QStringList getDependentDirs() const; /*! A pure virtual function to be implemented by subclasses. * - * @return The VLNVs that are needed by this document. + * @return The VLNVs that are needed by this document. */ virtual QList getDependentVLNVs()const = 0; /*! * Set the version number kactus2 during creation of this document. * - * @param [in] versionNumber Version of Kactus2. + * @param [in] versionNumber Version of Kactus2. */ void setVersion(QString const& versionNumber); /*! * Get the version number of Kactus2 used for creating this document. * - * @return The used version of Kactus2. + * @return The used version of Kactus2. */ QString getVersion() const; /*! * Check if the document has Kactus attributes. * - * @return True, if the document has Kactus attributes, otherwise false. + * @return True, if the document has Kactus attributes, otherwise false. */ bool hasKactusAttributes() const; /*! * Check if the document contains an implementation Kactus attribute. * - * @return True, if an implementation attribute exists, otherwise false. + * @return True, if an implementation attribute exists, otherwise false. */ bool hasImplementation() const; /*! * Sets the implementation type for the document. * - * @param [in] implementation The new implementation type. + * @param [in] implementation The new implementation type. */ void setImplementation(KactusAttribute::Implementation implementation); /*! * Gets the implementation type for the document. * - * @return The implementation type for the document. + * @return The implementation type for the document. */ KactusAttribute::Implementation getImplementation() const; /*! * Check if the document has a determined product hierarchy. * - * @return True, if a product hierarchy exists, otherwise false. + * @return True, if a product hierarchy exists, otherwise false. */ bool hasProductHierarchy() const; /*! * Set a new product hierarchy. * - * @param [in] productHierarchy The new product hierarchy value. + * @param [in] productHierarchy The new product hierarchy value. */ void setHierarchy(KactusAttribute::ProductHierarchy productHierarchy); /*! * Get the product hierarhcy of the document. * - * @return The product hierarchy of the document. + * @return The product hierarchy of the document. */ KactusAttribute::ProductHierarchy getHierarchy() const; /*! * Check if the document has a firmness attribute. * - * @return True, if a firmness attribute exists, otherwise false. + * @return True, if a firmness attribute exists, otherwise false. */ bool hasFirmness() const; /*! * Get the firmness attribute. * - * @return The firmness value of the document. + * @return The firmness value of the document. */ KactusAttribute::Firmness getFirmness() const; /*! * Set the firmness attribute. * - * @param [in] firmness The new firmness value. + * @param [in] firmness The new firmness value. */ void setFirmness(KactusAttribute::Firmness firmness); /*! * Get the document license. * - * @return The license of the document, if any. + * @return The license of the document, if any. */ QString getLicense() const; /*! * Set a new license for the document. * - * @param [in] license The new license. + * @param [in] license The new license. */ void setLicense(QString const& license); /*! * Get the document tags. * - * @return The document tags. + * @return The document tags. */ QVector getTags() const; /*! * Set new tags for the document. * - * @param [in] newTags The new tags. + * @param [in] newTags The new tags. */ void setTags(QVector newTags) const; /*! * Get the IP-XACT document standard revision. * - * @return The document standard revision. + * @return The document standard revision. */ Document::Revision getRevision() const; /*! * Convert document revision to QString. * - * @param [in] revision The document revision. + * @param [in] revision The document revision. * - * @return The document standard revision as QString. + * @return The document standard revision as QString. */ static QString toString(Revision revision); /*! * Convert document revision to std::string. * - * @param [in] revision The document revision. + * @param [in] revision The document revision. * - * @return The document standard revision as std::string. + * @return The document standard revision as std::string. */ static std::string toStdString(Revision revision); @@ -370,34 +370,34 @@ class IPXACTMODELS_EXPORT Document : public Extendable /*! * Get the group container for document tags. * - * @return The group container for document tags. + * @return The group container for document tags. */ QSharedPointer getTagGroup() const; /*! * Get a tag container using a name. * - * @param [in] name The name of the selected tag. - * @param [in] tagGroup Tag group containing the document tags. + * @param [in] name The name of the selected tag. + * @param [in] tagGroup Tag group containing the document tags. * - * @return The selected tag container. + * @return The selected tag container. */ QSharedPointer getTagByName(QString const& name, QSharedPointer tagGroup) const; /*! * Remove old non-existing tags. * - * @param [in] tagContainer Extension container for tags. - * @param [in] newTags The new tags. + * @param [in] tagContainer Extension container for tags. + * @param [in] newTags The new tags. */ void removeNonExistingTags(QSharedPointer tagContainer, QVector const& newTags) const; /*! * Get the name of the selected tag. * - * @param [in] tagExtension The selected tag. + * @param [in] tagExtension The selected tag. * - * @return Name of the selected tag. + * @return Name of the selected tag. */ QString getTagName(QSharedPointer tagExtension) const; diff --git a/IPXACTmodels/common/DocumentReader.h b/IPXACTmodels/common/DocumentReader.h index 76331e6c7..a1081674b 100644 --- a/IPXACTmodels/common/DocumentReader.h +++ b/IPXACTmodels/common/DocumentReader.h @@ -43,23 +43,23 @@ class IPXACTMODELS_EXPORT DocumentReader : public CommonItemsReader /*! * Parses the document revision from XML. * - * @param [in] document The XML description of the document. + * @param [in] document The XML description of the document. */ static Document::Revision getXMLDocumentRevision(QDomNode const& document); /*! * Parses the document name group data. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document to insert the parsed data. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document to insert the parsed data. */ static void parseDocumentNameGroup(QDomNode const& documentNode, QSharedPointer document); /*! * Parses the comments preceding the document from XML. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document to insert the parsed comments. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document to insert the parsed comments. */ static void parseTopComments(QDomNode const& documentNode, QSharedPointer document); @@ -70,41 +70,41 @@ class IPXACTMODELS_EXPORT DocumentReader : public CommonItemsReader /*! * Parses the VLNV from XML to a document. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document in which the parsed VLNV is inserted. - * @param [in] type The type of the VLNV. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document in which the parsed VLNV is inserted. + * @param [in] type The type of the VLNV. */ static void parseVLNVElements(QDomNode const& documentNode, QSharedPointer document, VLNV::IPXactType type); /*! * Parses the description from XML to a document. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document in which the parsed description is inserted. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document in which the parsed description is inserted. */ static void parseDescription(QDomNode const& documentNode, QSharedPointer document); /*! * Parses the parameters from XLM to a document. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document in which the parsed parameters are inserted. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document in which the parsed parameters are inserted. */ static void parseParameters(QDomNode const& documentNode, QSharedPointer document); /*! * Parses the assertions from XML to a document. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document in which the parsed assertions are inserted. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document in which the parsed assertions are inserted. */ static void parseAssertions(QDomNode const& documentNode, QSharedPointer document); /*! * Parses Kactus2 specific vendor extensions before other vendor extensions from XML. * - * @param [in] documentNode The XML description of the document. - * @param [in] document The document in which the parsed extensions are stored. + * @param [in] documentNode The XML description of the document. + * @param [in] document The document in which the parsed extensions are stored. */ static void parseKactusAndVendorExtensions(QDomNode const& documentNode, QSharedPointer document); @@ -112,16 +112,16 @@ class IPXACTMODELS_EXPORT DocumentReader : public CommonItemsReader /*! * Parses Kactus2 attributes for classifying IP from XML. * - * @param [in] attributesNode The XML description of the attributes. - * @param [in] document The document in which the parsed attributes are stored. + * @param [in] attributesNode The XML description of the attributes. + * @param [in] document The document in which the parsed attributes are stored. */ static void parseKactusAttributes(QDomNode const& attributesNode, QSharedPointer document); /*! * Parses document tags from XML. * - * @param [in] tagsGroupNode XML description of the tags. - * @param [in] document The containing component. + * @param [in] tagsGroupNode XML description of the tags. + * @param [in] document The containing component. */ static void parseTags(QDomNode const& tagsGroupNode, QSharedPointer document); diff --git a/IPXACTmodels/common/DocumentUtils.h b/IPXACTmodels/common/DocumentUtils.h index 6800744b2..2650eb2af 100644 --- a/IPXACTmodels/common/DocumentUtils.h +++ b/IPXACTmodels/common/DocumentUtils.h @@ -25,9 +25,9 @@ namespace DocumentUtils /*! * Checks if two documents of same type are using the same IP-XACT standard revision. * - * @param [in] firstVlnv The VLNV of the first document to check. - * @param [in] secondVlnv The VLNV of the second document to check. - * @param [in] library The library handler. + * @param [in] firstVlnv The VLNV of the first document to check. + * @param [in] secondVlnv The VLNV of the second document to check. + * @param [in] library The library handler. * * @return True, if the revisions are the same, false if not or if either document couldn't be found. */ diff --git a/IPXACTmodels/common/DocumentWriter.h b/IPXACTmodels/common/DocumentWriter.h index e6989fdac..96b4e95b9 100644 --- a/IPXACTmodels/common/DocumentWriter.h +++ b/IPXACTmodels/common/DocumentWriter.h @@ -35,24 +35,24 @@ class DocumentWriter : public CommonItemsWriter /*! * Writes the comments preceding the document into XML. * - * @param [in] writer The writer to use. - * @param [in] document The document whose comments to write. + * @param [in] writer The writer to use. + * @param [in] document The document whose comments to write. */ static void writeTopComments(QXmlStreamWriter& writer, QSharedPointer document); /*! * Writes the xml processing instructions for IP-XACT 2014 documents. * - * @param [in] writer The writer to use. - * @param [in] document The document whose comments to write. + * @param [in] writer The writer to use. + * @param [in] document The document whose comments to write. */ static void writeXmlProcessingInstructions(QXmlStreamWriter& writer, QSharedPointer document); /*! * Writes the namespace declarations for IP-XACT 2014 documents. * - * @param [in] writer The writer to use. - * @param [in] document The document whose comments to write. + * @param [in] writer The writer to use. + * @param [in] document The document whose comments to write. */ static void writeNamespaceDeclarations(QXmlStreamWriter& writer, QSharedPointer document); @@ -61,16 +61,16 @@ class DocumentWriter : public CommonItemsWriter /*! * Writes the parameters of a given document into XML. * - * @param [in] writer The used XML writer. - * @param [in] document The document whose parameters to write. + * @param [in] writer The used XML writer. + * @param [in] document The document whose parameters to write. */ static void writeParameters(QXmlStreamWriter& writer, QSharedPointer document); /*! * Writes the assertions of a given document into XML. * - * @param [in] writer The used XML writer. - * @param [in] document The document whose assertions to write. + * @param [in] writer The used XML writer. + * @param [in] document The document whose assertions to write. */ static void writeAssertions(QXmlStreamWriter& writer, QSharedPointer document); diff --git a/IPXACTmodels/common/Enumeration.h b/IPXACTmodels/common/Enumeration.h index c8819dbe3..55130b34c 100644 --- a/IPXACTmodels/common/Enumeration.h +++ b/IPXACTmodels/common/Enumeration.h @@ -29,7 +29,7 @@ class IPXACTMODELS_EXPORT Enumeration /*! * The copy constructor. * - * @param [in] other The enumeration to copy. + * @param [in] other The enumeration to copy. */ Enumeration(Enumeration const& other); @@ -39,42 +39,42 @@ class IPXACTMODELS_EXPORT Enumeration /*! * Sets the enumeration value. * - * @param [in] value The value to set. + * @param [in] value The value to set. */ void setValue(QString const& value); /*! * Gets the enumeration value. * - * @return The enumeration value. + * @return The enumeration value. */ QString getValue() const; /*! * Sets the enumeration text to display instead of value. * - * @param [in] text The text to set. + * @param [in] text The text to set. */ void setText(QString const& text); /*! * Gets the enumeration text. * - * @return The enumeration text. + * @return The enumeration text. */ QString getText() const; /*! * Sets the clarifying help text. * - * @param [in] help The help text to set. + * @param [in] help The help text to set. */ void setHelp(QString const& help); /*! * Gets the clarifying help text. * - * @return The enumeration help text. + * @return The enumeration help text. */ QString getHelp() const; diff --git a/IPXACTmodels/common/Extendable.h b/IPXACTmodels/common/Extendable.h index 0a9167342..a1248239e 100644 --- a/IPXACTmodels/common/Extendable.h +++ b/IPXACTmodels/common/Extendable.h @@ -32,7 +32,7 @@ class IPXACTMODELS_EXPORT Extendable /*! * Gets the vendor extensions for the element. * - * @return The vendor extensions for the element. + * @return The vendor extensions for the element. */ QSharedPointer > > getVendorExtensions() const; @@ -50,17 +50,17 @@ class IPXACTMODELS_EXPORT Extendable /*! * Copies vendor extensions from another element. * - * @param [in] other The element to copy extensions from. + * @param [in] other The element to copy extensions from. */ void copyVendorExtensions(Extendable const& other); /*! * Get a list of grouped extensions. * - * @param [in] groupName Identifier of the extension group. - * @param [in] extensionType Identifier of the extension item. + * @param [in] groupName Identifier of the extension group. + * @param [in] extensionType Identifier of the extension item. * - * @return A list of extensions belonging to a group. + * @return A list of extensions belonging to a group. */ QList > getGroupedExtensionsByType(QString const& groupName, QString const& extensionType) const; @@ -69,17 +69,17 @@ class IPXACTMODELS_EXPORT Extendable * Creates a Kactus2 vendor extension with given type, if it does not exist already. * If value is false, the extension is removed. * - * @param [in] value The value to set. - * @param [in] extensionType The type of the vendor extension. + * @param [in] value The value to set. + * @param [in] extensionType The type of the vendor extension. */ void setPlaceholderExtension(bool value, QString const& extensionType); /*! * Find a vendor extension by given type. * - * @param [in] type The type of extension to find. + * @param [in] type The type of extension to find. * - * @return The first found extension with the given type. + * @return The first found extension with the given type. */ QSharedPointer findVendorExtension(QString const& type) const; diff --git a/IPXACTmodels/common/FileBuilder.h b/IPXACTmodels/common/FileBuilder.h index faf952343..c52299257 100644 --- a/IPXACTmodels/common/FileBuilder.h +++ b/IPXACTmodels/common/FileBuilder.h @@ -40,7 +40,7 @@ class IPXACTMODELS_EXPORT FileBuilder : public BuildModel, public Extendable /*! * The constructor. * - * @param [in] fileType The type of the file. + * @param [in] fileType The type of the file. */ FileBuilder(QString const& fileType); @@ -62,31 +62,31 @@ class IPXACTMODELS_EXPORT FileBuilder : public BuildModel, public Extendable /*! * Get the type of the file. * - * @return The type of the file. + * @return The type of the file. */ FileType getFileType() const; /*! * Set a file type. * - * @param [in] newFileType The new file type. - * @param [in] libext The new libext attribute for the type. + * @param [in] newFileType The new file type. + * @param [in] libext The new libext attribute for the type. */ void setFileType(QString const& newFileType, QString const& libext = QString()); /*! * Set a file type. * - * @param [in] fileType The new file type. + * @param [in] fileType The new file type. */ void setFileType(FileType const& fileType); /*! * Check if the file builde is meant for a given file type. * - * @param [in] fileType The file type to be searched for. + * @param [in] fileType The file type to be searched for. * - * @return True, if the file type is contained within the file builder, false otherwise. + * @return True, if the file type is contained within the file builder, false otherwise. */ bool hasFileType(QString const& fileType) const; diff --git a/IPXACTmodels/common/FileBuilderReader.h b/IPXACTmodels/common/FileBuilderReader.h index 92e39dccc..476791aad 100644 --- a/IPXACTmodels/common/FileBuilderReader.h +++ b/IPXACTmodels/common/FileBuilderReader.h @@ -30,10 +30,10 @@ namespace FileBuilderReader /*! * Reads the default file builder. * - * @param [in] fileBuilderNode XML description of the default file builder. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] fileBuilderNode XML description of the default file builder. + * @param [in] docRevision The applied IP-XACT standard revision. * - * @return The created default file builder. + * @return The created default file builder. */ IPXACTMODELS_EXPORT QSharedPointer createFileBuilderFrom(QDomNode const& fileBuilderNode, Document::Revision docRevision); @@ -43,9 +43,9 @@ namespace FileBuilderReader /*! * Reads the file builder file type. * - * @param [in] filebuilderNode XML description of the file builder. - * @param [in] newFileBuilder The selected file builder. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] filebuilderNode XML description of the file builder. + * @param [in] newFileBuilder The selected file builder. + * @param [in] docRevision The applied IP-XACT standard revision. */ void parseFileType(QDomNode const& filebuilderNode, QSharedPointer newFileBuilder, Document::Revision docRevision); @@ -53,8 +53,8 @@ namespace FileBuilderReader /*! * Reads the file builder command, flags and replace default flags value. * - * @param [in] filebuilderNode XML description of the file builder. - * @param [in] newFileBuilder The selected file builder. + * @param [in] filebuilderNode XML description of the file builder. + * @param [in] newFileBuilder The selected file builder. */ void parseBuildModel(QDomNode const& fileBuilderNode, QSharedPointer newFileBuilder); } diff --git a/IPXACTmodels/common/FileBuilderWriter.h b/IPXACTmodels/common/FileBuilderWriter.h index 1a2cf6b81..dfbb1b7f0 100644 --- a/IPXACTmodels/common/FileBuilderWriter.h +++ b/IPXACTmodels/common/FileBuilderWriter.h @@ -31,9 +31,9 @@ namespace FileBuilderWriter /*! * Write the default file builder. * - * @param [in] writer The used xml writer. - * @param [in] nameGroup The selected file builder. - * @param [in] docRevision The applied IP-XACT standard revision. + * @param [in] writer The used xml writer. + * @param [in] nameGroup The selected file builder. + * @param [in] docRevision The applied IP-XACT standard revision. */ void writeDefaultFileBuilder(QXmlStreamWriter& writer, QSharedPointer fileBuilder, Document::Revision docRevision); @@ -44,8 +44,8 @@ namespace FileBuilderWriter /*! * Write the build model of the file builder. * - * @param [in] writer Used XML writer. - * @param [in] fileBuilder The selected file builder. + * @param [in] writer Used XML writer. + * @param [in] fileBuilder The selected file builder. */ void writeBuildModel(QXmlStreamWriter& writer, QSharedPointer fileBuilder); } diff --git a/IPXACTmodels/common/FileType.h b/IPXACTmodels/common/FileType.h index bdce69f94..175aaaac4 100644 --- a/IPXACTmodels/common/FileType.h +++ b/IPXACTmodels/common/FileType.h @@ -103,29 +103,29 @@ namespace FileTypes /*! * Checks if the file type belongs to the specified file types. * - * @param [in] fileType The file type to check. + * @param [in] fileType The file type to check. * - * @return True if the file type is one of the specified ones, false otherwise. + * @return True if the file type is one of the specified ones, false otherwise. */ IPXACTMODELS_EXPORT bool isIpXactFileType(QString const& fileType, Document::Revision docRevision); /*! * Get the file types which are associated with the given file suffix. * - * @param [in] settings The settings instance used to manage Kactus2 settings. - * @param [in] fileSuffix The file suffix to identify the file type. + * @param [in] settings The settings instance used to manage Kactus2 settings. + * @param [in] fileSuffix The file suffix to identify the file type. * - * @return QStringlist containing the file types. + * @return QStringlist containing the file types. */ IPXACTMODELS_EXPORT QStringList getFileTypes(QSettings& settings, QString const& fileSuffix); /*! * Get the file types which are associated with the given file suffix. * - * @param [in] settings The settings instance used to manage the Kactus2 settings. - * @param [in] file Represents the file which file types are searched. + * @param [in] settings The settings instance used to manage the Kactus2 settings. + * @param [in] file Represents the file which file types are searched. * - * @return The file types. + * @return The file types. */ IPXACTMODELS_EXPORT QStringList getFileTypes(QSettings& settings, QFileInfo const& file); diff --git a/IPXACTmodels/common/GenericVendorExtension.h b/IPXACTmodels/common/GenericVendorExtension.h index 922742b0a..d34e219b4 100644 --- a/IPXACTmodels/common/GenericVendorExtension.h +++ b/IPXACTmodels/common/GenericVendorExtension.h @@ -37,38 +37,38 @@ class IPXACTMODELS_EXPORT GenericVendorExtension : public VendorExtension /*! * The constructor. * - * @param [in] extensionNode The DOM node representation of the vendor extension. - * @param [in] parent Parent extension. + * @param [in] extensionNode The DOM node representation of the vendor extension. + * @param [in] parent Parent extension. */ GenericVendorExtension(QDomNode const& extensionNode, GenericVendorExtension* parent = nullptr); /*! * Copy constructor. * - * @param [in] other The copied generic vendor extension. + * @param [in] other The copied generic vendor extension. */ GenericVendorExtension(GenericVendorExtension const& other); /*! * Assignment operator. * - * @param [in] rhs The assigned generic vendor extension. + * @param [in] rhs The assigned generic vendor extension. */ GenericVendorExtension& operator=(GenericVendorExtension const& rhs); /*! * Check whether this is the selected generic vendor extension. * - * @param [in] otherItem The selected generic vendor extension. + * @param [in] otherItem The selected generic vendor extension. * - * @return True, if the selected generic vendor extension is this, false otherwise. + * @return True, if the selected generic vendor extension is this, false otherwise. */ bool isSame(const GenericVendorExtension& otherItem) const; /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual GenericVendorExtension* clone() const; @@ -80,144 +80,144 @@ class IPXACTMODELS_EXPORT GenericVendorExtension : public VendorExtension /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Get the name space. * - * @return The name space. + * @return The name space. */ QString nameSpace() const; /*! * Set a new name space. * - * @param [in] newNameSpace The new name space. + * @param [in] newNameSpace The new name space. */ void setNameSpace(QString const& newNameSpace); /*! * Get the name. * - * @return The name. + * @return The name. */ QString name() const; /*! * Set a new name. * - * @param [in] name The new name. + * @param [in] name The new name. */ void setName(QString const& name); /*! * Get the value. * - * @return The value. + * @return The value. */ QString value() const; /*! * Set a new value. * - * @param [in] value The new value. + * @param [in] value The new value. */ void setValue(QString const& value); /*! * Get the value of the selected attribute. * - * @param [in] attributeName Name of the selected attribute. + * @param [in] attributeName Name of the selected attribute. * - * @return Value of the selected attribute. + * @return Value of the selected attribute. */ QString attributeValue(QString const& attributeName) const; /*! * Set a new value for the selected attribute. * - * @param [in] attributeName Name of the selected attribute. - * @param [in] attributeValue New value for the selected attribute. + * @param [in] attributeName Name of the selected attribute. + * @param [in] attributeValue New value for the selected attribute. */ void setAttributeValue(QString const& attributeName, QString const& attributeValue); /*! * Get extension description. * - * @return Extension description. + * @return Extension description. */ QString getDescription() const; /*! * Set a new description for the extension. * - * @param [in] newDescription The new description. + * @param [in] newDescription The new description. */ void setDescription(QString const& newDescription); /*! * Check if this extension has a description child element. * - * @return True, if a description is found, false otherwise. + * @return True, if a description is found, false otherwise. */ bool hasDescription() const; /*! * Get the index of the description child element.. * - * @return Index of the description child element. + * @return Index of the description child element. */ int getDescriptionIndex() const; /*! * Get a list of the contained child generic extensions. * - * @return Reference to the list of child generic extensions. + * @return Reference to the list of child generic extensions. */ QVector& getChildExtensions(); /*! * Remove the selected indexed child extensions. * - * @param [in] startIndex The first index to be removed. - * @param [in] endIndex The last index to be removed. + * @param [in] startIndex The first index to be removed. + * @param [in] endIndex The last index to be removed. */ void removeIndexedChildExtensions(int const& startIndex, int const& endIndex); /*! * Get the parent vendor extension. * - * @return The parent vendor extension. + * @return The parent vendor extension. */ GenericVendorExtension* getParent() const; /*! * Set a new parent vendor extension. * - * @param [in] newParent The new parent vendor extension. + * @param [in] newParent The new parent vendor extension. */ void setParent(GenericVendorExtension* newParent); /*! * Get a list of the attributes. * - * @return List of attribute type / value pairs. + * @return List of attribute type / value pairs. */ QVector > getAttributes() const; /*! * Set new attributes. * - * @param [in] newAttributes List of new attributes. + * @param [in] newAttributes List of new attributes. */ void setNewAttributes(QVector > newAttributes); @@ -226,24 +226,24 @@ class IPXACTMODELS_EXPORT GenericVendorExtension : public VendorExtension /*! * Writes a DOM node to XML using a given XML writer. * - * @param [in] node The DOM node to write. - * @param [in] writer The XML writer to use. + * @param [in] node The DOM node to write. + * @param [in] writer The XML writer to use. */ void writeNode(GenericVendorExtension const& node, QXmlStreamWriter& writer) const; /*! * Writes all child noted of a DOM node to XML using a given XML writer. * - * @param [in] node The DOM node to write. - * @param [in] writer The XML writer to use. + * @param [in] node The DOM node to write. + * @param [in] writer The XML writer to use. */ void writeChildNodes(GenericVendorExtension const& node, QXmlStreamWriter& writer) const; /*! * Writes all the attributes of a DOM node to XML using a given XML writer. * - * @param [in] node The DOM node to write. - * @param [in] writer The XML writer to use. + * @param [in] node The DOM node to write. + * @param [in] writer The XML writer to use. */ void writeAttributes(GenericVendorExtension const& node, QXmlStreamWriter& writer) const; diff --git a/IPXACTmodels/common/ModuleParameter.h b/IPXACTmodels/common/ModuleParameter.h index b16b85637..2d0384188 100644 --- a/IPXACTmodels/common/ModuleParameter.h +++ b/IPXACTmodels/common/ModuleParameter.h @@ -40,56 +40,56 @@ class IPXACTMODELS_EXPORT ModuleParameter : public Parameter /*! * Get the data type attribute. * - * @return The data type. + * @return The data type. */ QString getDataType() const; /*! * Set the data type attribute. * - * @param [in] newDataType The new data type. + * @param [in] newDataType The new data type. */ void setDataType(QString const& newDataType); /*! * Get the usage type attribute. * - * @return The usage type. + * @return The usage type. */ QString getUsageType() const; /*! * Set the usage type attribute. * - * @param [in] newUsageType The new usaget type. + * @param [in] newUsageType The new usaget type. */ void setUsageType(QString const& newUsageType); /*! * Get the data type definition attribute. * - * @return The data type definition. + * @return The data type definition. */ QString getDataTypeDefinition() const; /*! * Set the data type definition attribute. * - * @param [in] dataTypeDef The new data type definition. + * @param [in] dataTypeDef The new data type definition. */ void setDataTypeDefinition(QString const& dataTypeDef); /*! * Get the presence. * - * @return The presence. + * @return The presence. */ QString getIsPresent() const; /*! * Set the presence. * - * @param [in] newIsPresent The new presence expression. + * @param [in] newIsPresent The new presence expression. */ void setIsPresent(QString const& newIsPresent); diff --git a/IPXACTmodels/common/ModuleParameterReader.h b/IPXACTmodels/common/ModuleParameterReader.h index 74ebe9d2a..628a63f77 100644 --- a/IPXACTmodels/common/ModuleParameterReader.h +++ b/IPXACTmodels/common/ModuleParameterReader.h @@ -28,10 +28,10 @@ namespace ModuleParameterReader /*! * Creates a module parameter from XML description. * - * @param [in] moduleParameterNode The XML description of the module parameter. - * @param [in] docRevision The IP-XACT standard to comply to. + * @param [in] moduleParameterNode The XML description of the module parameter. + * @param [in] docRevision The IP-XACT standard to comply to. - * @return The created module parameter. + * @return The created module parameter. */ IPXACTMODELS_EXPORT QSharedPointer createModuleParameterFrom(QDomNode const& moduleParameterNode, Document::Revision docRevision); @@ -42,9 +42,9 @@ namespace ModuleParameterReader /*! * Reads the presence of the module parameter. * - * @param [in] moduleParameterNode XML description of the module parameter. - * @param [in] moduleParameter The module parameter whose presence is being read. - * @param [in] docRevision The IP-XACT standard to comply to. + * @param [in] moduleParameterNode XML description of the module parameter. + * @param [in] moduleParameter The module parameter whose presence is being read. + * @param [in] docRevision The IP-XACT standard to comply to. */ void parseIsPresent(QDomNode const& moduleParameterNode, QSharedPointer moduleParameter, Document::Revision docRevision); diff --git a/IPXACTmodels/common/ModuleParameterWriter.h b/IPXACTmodels/common/ModuleParameterWriter.h index fbdc90f5e..270e03abc 100644 --- a/IPXACTmodels/common/ModuleParameterWriter.h +++ b/IPXACTmodels/common/ModuleParameterWriter.h @@ -27,9 +27,9 @@ namespace ModuleParameterWriter /*! * Writes the given module parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The module parameter to write. - * @param [in] docRevision The document std revision. + * @param [in] writer The xml writer to use. + * @param [in] parameter The module parameter to write. + * @param [in] docRevision The document std revision. */ void writeModuleParameter(QXmlStreamWriter& writer, QSharedPointer moduleParameter, Document::Revision docRevision = Document::Revision::Std14); diff --git a/IPXACTmodels/common/NameGroup.h b/IPXACTmodels/common/NameGroup.h index d18eae49b..03c5bb249 100644 --- a/IPXACTmodels/common/NameGroup.h +++ b/IPXACTmodels/common/NameGroup.h @@ -30,15 +30,15 @@ class IPXACTMODELS_EXPORT NameGroup /*! The constructor * - * @param [in] name The initial name. - * @param [in] displayName The initial displayName. - * @param [in] description The initial description. + * @param [in] name The initial name. + * @param [in] displayName The initial displayName. + * @param [in] description The initial description. */ NameGroup(QString const& name, QString const& displayName = QString(), QString const& description = QString()); /*! The copy constructor * - * @param [in] other Reference to the NameGroup to copy. + * @param [in] other Reference to the NameGroup to copy. */ NameGroup(const NameGroup& other) = default; @@ -47,65 +47,65 @@ class IPXACTMODELS_EXPORT NameGroup /*! The assignment operator * - * @param [in] other Reference to the NameGroup to assign. + * @param [in] other Reference to the NameGroup to assign. * - * @return Reference to this NameGroup. + * @return Reference to this NameGroup. */ NameGroup& operator=(const NameGroup& other); /*! * Gets the name element in the name group. * - * @return The name element. + * @return The name element. */ QString name() const; /*! * Sets the name element in the group. * - * @param [in] name The name to set. + * @param [in] name The name to set. */ void setName(QString const& name); /*! * Gets the displayName element in the name group. * - * @return The displayName element. + * @return The displayName element. */ QString displayName() const; /*! * Sets the displayName element in the group. * - * @param [in] displayName The display name to set. + * @param [in] displayName The display name to set. */ void setDisplayName(QString const& displayName); /*! * Gets the short description element in the name group. * - * @return The short description element. + * @return The short description element. */ QString shortDescription() const; /*! * Sets the short description element in the group. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setShortDescription(QString const& description); /*! * Gets the description element in the name group. * - * @return The description element. + * @return The description element. */ QString description() const; /*! * Sets the description element in the group. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description); diff --git a/IPXACTmodels/common/NameGroupReader.h b/IPXACTmodels/common/NameGroupReader.h index 5a590c7dc..5d2e9398f 100644 --- a/IPXACTmodels/common/NameGroupReader.h +++ b/IPXACTmodels/common/NameGroupReader.h @@ -28,8 +28,8 @@ namespace NameGroupReader /*! * Reads the name group. * - * @param [in] nameGroupNode XML description of the name group. - * @param [in] nameGroup The new name group. + * @param [in] nameGroupNode XML description of the name group. + * @param [in] nameGroup The new name group. */ void parseNameGroup(QDomNode const& nameGroupNode, QSharedPointer nameGroup); @@ -38,36 +38,36 @@ namespace NameGroupReader /*! * Reads and creates a name for name group. * - * @param [in] nameGroupNode XML description of the name group. + * @param [in] nameGroupNode XML description of the name group. * - * @return The name of the name group. + * @return The name of the name group. */ QString parseName(QDomNode const& nameGroupNode); /*! * Reads and creates a display name for name group. * - * @param [in] nameGroupNode XML description of the name group. + * @param [in] nameGroupNode XML description of the name group. * - * @return The display name of the name group. + * @return The display name of the name group. */ QString parseDisplayName(QDomNode const& nameGroupNode); /*! * Reads and creates a short description for name group. * - * @param [in] nameGroupNode XML description of the name group. + * @param [in] nameGroupNode XML description of the name group. * - * @return The short description of the name group. + * @return The short description of the name group. */ QString parseShortDescription(QDomNode const& nameGroupNode); /*! * Reads and creates a description for name group. * - * @param [in] nameGroupNode XML description of the name group. + * @param [in] nameGroupNode XML description of the name group. * - * @return The description of the name group. + * @return The description of the name group. */ QString parseDescription(QDomNode const& nameGroupNode); } diff --git a/IPXACTmodels/common/NameGroupWriter.h b/IPXACTmodels/common/NameGroupWriter.h index b11020a89..7332f6bfd 100644 --- a/IPXACTmodels/common/NameGroupWriter.h +++ b/IPXACTmodels/common/NameGroupWriter.h @@ -28,9 +28,9 @@ namespace NameGroupWriter /*! * Write the name group. * - * @param [in] writer The used xml writer. - * @param [in] nameGroup The selected name group. - * @param [in] revision The IP-XACT standard to comply to. + * @param [in] writer The used xml writer. + * @param [in] nameGroup The selected name group. + * @param [in] revision The IP-XACT standard to comply to. */ void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer nameGroup, Document::Revision revision = Document::Revision::Std14); diff --git a/IPXACTmodels/common/NameValuePair.h b/IPXACTmodels/common/NameValuePair.h index 488260efa..e27f722c7 100644 --- a/IPXACTmodels/common/NameValuePair.h +++ b/IPXACTmodels/common/NameValuePair.h @@ -28,8 +28,8 @@ class IPXACTMODELS_EXPORT NameValuePair : public NameGroup, public Extendable /*! * The constructor. * - * @param [in] name Name of the pair. - * @param [in] value Value of the pair. + * @param [in] name Name of the pair. + * @param [in] value Value of the pair. */ NameValuePair(QString const& name = QString(), QString const& value = QString()); @@ -45,14 +45,14 @@ class IPXACTMODELS_EXPORT NameValuePair : public NameGroup, public Extendable /*! * Get the contained value. * - * @return The value. + * @return The value. */ QString getValue() const; /*! * Set a value. * - * @param [in] newValue The new value. + * @param [in] newValue The new value. */ void setValue(QString const& newValue); diff --git a/IPXACTmodels/common/Parameter.h b/IPXACTmodels/common/Parameter.h index 478e4dc81..1cf9a070f 100644 --- a/IPXACTmodels/common/Parameter.h +++ b/IPXACTmodels/common/Parameter.h @@ -53,27 +53,27 @@ class IPXACTMODELS_EXPORT Parameter : public NameGroup, public Extendable /*! Get the value of the parameter * - * @return QString containing the value + * @return QString containing the value */ QString getValue() const; /*! Set the value for the parameter * - * @param [in] value QString containing the value + * @param [in] value QString containing the value */ void setValue(QString const& value); /*! * Gets the choice referenced by the parameter value. * - * @return The choice name referenced by the value or an empty string, if no choice is referenced. + * @return The choice name referenced by the value or an empty string, if no choice is referenced. */ QString getChoiceRef() const; /*! * Sets the choice to reference by the parameter value. * - * @param [in] choiceRef The choice name to reference. + * @param [in] choiceRef The choice name to reference. */ void setChoiceRef(QString const& choiceRef); @@ -85,77 +85,77 @@ class IPXACTMODELS_EXPORT Parameter : public NameGroup, public Extendable /*! * Sets the IP-Xact format type. * - * @param [in] type The format type. + * @param [in] type The format type. */ void setType(QString const& type); /*! * Gets the minimum value for the parameter value. * - * @return The minimum value. + * @return The minimum value. */ QString getMinimumValue() const; /*! * Sets the minimum value for the parameter value * - * @param [in] minimum The minimum value. + * @param [in] minimum The minimum value. */ void setMinimumValue(QString const& minimum); /*! * Gets the maximum value for the parameter value. * - * @return The maximum value. + * @return The maximum value. */ QString getMaximumValue() const; /*! * Sets the maximum value for the parameter value * - * @param [in] maximum The maximum value. + * @param [in] maximum The maximum value. */ void setMaximumValue(QString const& maximum); /*! * Gets the resolve type for the parameter value. * - * @return The resolve type for the value. + * @return The resolve type for the value. */ QString getValueResolve() const; /*! * Sets the resolve type for the parameter value * - * @param [in] resolve The resolve type. + * @param [in] resolve The resolve type. */ void setValueResolve(QString const& resolve); /*! * Gets the unique id for the parameter value. * - * @return The unique id for the value. + * @return The unique id for the value. */ QString getValueId() const; /*! * Sets the unique id for referencing the parameter value * - * @param [in] id The id to set. + * @param [in] id The id to set. */ void setValueId(QString const& id); /*! * Get the amount of times the parameter has been referenced. * - * @return The amount of times the parameter has been referenced. + * @return The amount of times the parameter has been referenced. */ int getUsageCount() const; /*! * Set a new reference count. * - * @param [in] newUsageCount The new reference count. + * @param [in] newUsageCount The new reference count. */ void setUsageCount(int const& newUsageCount); @@ -172,99 +172,99 @@ class IPXACTMODELS_EXPORT Parameter : public NameGroup, public Extendable /*! * Checks if the parameter has an attribute with the given name. * - * @param [in] attributeName The name of the attribute to find. + * @param [in] attributeName The name of the attribute to find. * - * @return True, if an attribute with the given name exists, otherwise false. + * @return True, if an attribute with the given name exists, otherwise false. */ bool hasAttribute(QString const& attributeName) const; /*! * Gets the value of an attribute. * - * @param [in] attributeName The name of the attribute to get. + * @param [in] attributeName The name of the attribute to get. * - * @return The attribute value. + * @return The attribute value. */ QString getAttribute(QString const& attributeName) const; /*! * Sets an attribute. * - * @param [in] attributeName The name of the attribute to set. - * @param [in] attributeValue The value of the attribute. + * @param [in] attributeName The name of the attribute to set. + * @param [in] attributeValue The value of the attribute. */ void setAttribute(QString const& attributeName, QString const& attributeValue); /*! * Gets the value of an attribute of the paraemter value. * - * @param [in] attributeName The name of the attribute to get. + * @param [in] attributeName The name of the attribute to get. * - * @return The value attribute value. + * @return The value attribute value. */ QString getValueAttribute(QString const& attributeName) const; /*! * Sets an attribute for the value. * - * @param [in] attributeName The name of the attribute to set. - * @param [in] attributeValue The value of the attribute. + * @param [in] attributeName The name of the attribute to set. + * @param [in] attributeValue The value of the attribute. */ void setValueAttribute(QString const& attributeName, QString const& attributeValue); /*! * Gets the names of the parameter attributes. * - * @return The parameter attribute names. + * @return The parameter attribute names. */ QStringList getAttributeNames() const; /*! * Gets the names of the parameter value attributes. * - * @return The parameter value attribute names. + * @return The parameter value attribute names. */ QStringList getValueAttributeNames() const; /*! * Gets the vectors for the parameter. * - * @return The parameter vectors. + * @return The parameter vectors. */ QSharedPointer > > getVectors() const; /*! * Gets the left index of the parameter vector. * - * @return The left index of the vector. + * @return The left index of the vector. */ QString getVectorLeft() const; /*! * Gets the right index of the parameter vector. * - * @return The right index of the vector. + * @return The right index of the vector. */ QString getVectorRight() const; /*! * Sets the left index of the parameter vector. * - * @param [in] leftExpression The left index to set. + * @param [in] leftExpression The left index to set. */ void setVectorLeft(QString const& leftExpression); /*! * Sets the right index of the parameter vector. * - * @param [in] leftExpression The right index to set. + * @param [in] leftExpression The right index to set. */ void setVectorRight(QString const& rightExpression); /*! * Sets the vector id. * - * @param [in] id The id to set. + * @param [in] id The id to set. */ void setVectorId(QString const& id); @@ -278,35 +278,35 @@ class IPXACTMODELS_EXPORT Parameter : public NameGroup, public Extendable /*! * Gets the arrays for the parameter. * - * @return The parameter arrays. + * @return The parameter arrays. */ QSharedPointer > > getArrays() const; /*! * Gets the left index of the parameter array. * - * @return The left index of the array. + * @return The left index of the array. */ QString getArrayLeft() const; /*! * Gets the right index of the parameter array. * - * @return The right index of the array. + * @return The right index of the array. */ QString getArrayRight() const; /*! * Sets the left index of the parameter array. * - * @param [in] leftExpression The left index to set. + * @param [in] leftExpression The left index to set. */ void setArrayLeft(QString const& leftExpression); /*! * Sets the right index of the parameter array. * - * @param [in] leftExpression The left index to set. + * @param [in] leftExpression The left index to set. */ void setArrayRight(QString const& rightExpression); diff --git a/IPXACTmodels/common/ParameterReader.h b/IPXACTmodels/common/ParameterReader.h index 11461fb0c..d59bea4da 100644 --- a/IPXACTmodels/common/ParameterReader.h +++ b/IPXACTmodels/common/ParameterReader.h @@ -28,10 +28,10 @@ namespace ParameterReader /*! * Creates a parameter from XML description. * - * @param [in] parameterNode The XML description of the parameter. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] parameterNode The XML description of the parameter. + * @param [in] revision The standard revision of the XML document being read. * - * @return The created parameter. + * @return The created parameter. */ IPXACTMODELS_EXPORT QSharedPointer createParameterFrom(QDomNode const& parameterNode, Document::Revision revision = Document::Revision::Std14); @@ -42,17 +42,17 @@ namespace ParameterReader /*! * Reads the attributes from XML to a parameter. * - * @param [in] parameterNode The XML description of the parameter. - * @param [in/out] parameter The parameter to insert the attributes into. + * @param [in] parameterNode The XML description of the parameter. + * @param [in/out] parameter The parameter to insert the attributes into. */ void parseAttributes(QDomNode const& parameterNode, QSharedPointer parameter); /*! * Reads the vectors from XML to a parameter. * - * @param [in] parameterNode The XML description of the parameter. - * @param [in/out] parameter The parameter to insert the vectors into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] parameterNode The XML description of the parameter. + * @param [in/out] parameter The parameter to insert the vectors into. + * @param [in] revision The standard revision of the XML document being read. */ void parseVectors(QDomNode const& parameterNode, QSharedPointer parameter, Document::Revision revision = Document::Revision::Std14); @@ -60,9 +60,9 @@ namespace ParameterReader /*! * Reads the arrays from XML to a parameter. * - * @param [in] parameterNode The XML description of the parameter. - * @param [in/out] parameter The parameter to insert the arrays into. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] parameterNode The XML description of the parameter. + * @param [in/out] parameter The parameter to insert the arrays into. + * @param [in] revision The standard revision of the XML document being read. */ void parseArrays(QDomNode const& parameterNode, QSharedPointer parameter, Document::Revision revision = Document::Revision::Std14); @@ -70,8 +70,8 @@ namespace ParameterReader /*! * Reads the parameter value from XML to a parameter. * - * @param [in] parameterNode The XML description of the parameter. - * @param [in/out] parameter The parameter to insert the value into. + * @param [in] parameterNode The XML description of the parameter. + * @param [in/out] parameter The parameter to insert the value into. */ void parseValue(QDomNode const& parameterNode, QSharedPointer parameter); } diff --git a/IPXACTmodels/common/ParameterWriter.h b/IPXACTmodels/common/ParameterWriter.h index 91a98572f..216b63a28 100644 --- a/IPXACTmodels/common/ParameterWriter.h +++ b/IPXACTmodels/common/ParameterWriter.h @@ -31,9 +31,9 @@ namespace ParameterWriter /*! * Writes the given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter to write. - * @param [in] docRevision The document std revision. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter to write. + * @param [in] docRevision The document std revision. */ IPXACTMODELS_EXPORT void writeParameter(QXmlStreamWriter& writer, QSharedPointer parameter, Document::Revision docRevision); @@ -44,17 +44,17 @@ namespace ParameterWriter /*! * Writes the attributes of a given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter whose attributes to write. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter whose attributes to write. */ void writeAttributes(QXmlStreamWriter& writer, QSharedPointer parameter); /*! * Writes the name group of a given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter whose name group to write. - * @param [in] docRevision The document std revision. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter whose name group to write. + * @param [in] docRevision The document std revision. */ void writeNameGroup(QXmlStreamWriter& writer, QSharedPointer parameter, Document::Revision docRevision); @@ -62,9 +62,9 @@ namespace ParameterWriter /*! * Writes the vectors of a given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter whose vectors to write. - * @param [in] docRevision The document std revision. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter whose vectors to write. + * @param [in] docRevision The document std revision. */ void writeVectors(QXmlStreamWriter& writer, QSharedPointer parameter, Document::Revision docRevision); @@ -72,9 +72,9 @@ namespace ParameterWriter /*! * Writes the arrays of a given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter whose arrays to write. - * @param [in] docRevision The document std revision. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter whose arrays to write. + * @param [in] docRevision The document std revision. */ void writeArrays(QXmlStreamWriter& writer, QSharedPointer parameter, Document::Revision docRevision); @@ -82,8 +82,8 @@ namespace ParameterWriter /*! * Writes the value of a given parameter into xml. * - * @param [in] writer The xml writer to use. - * @param [in] parameter The parameter whose value to write. + * @param [in] writer The xml writer to use. + * @param [in] parameter The parameter whose value to write. */ void writeValue(QXmlStreamWriter& writer, QSharedPointer parameter); } diff --git a/IPXACTmodels/common/PartSelect.h b/IPXACTmodels/common/PartSelect.h index e8e7a1f4f..a81eb3fee 100644 --- a/IPXACTmodels/common/PartSelect.h +++ b/IPXACTmodels/common/PartSelect.h @@ -34,8 +34,8 @@ class IPXACTMODELS_EXPORT PartSelect /*! * The constructor. * - * @param [in] leftRange The left value for the range. - * @param [in] rightRange The right value for the range. + * @param [in] leftRange The left value for the range. + * @param [in] rightRange The right value for the range. */ PartSelect(QString const& leftRange = QString(), QString const& rightRange = QString()); @@ -52,7 +52,7 @@ class IPXACTMODELS_EXPORT PartSelect /*! * Create a copy of the PartSelect. * - * @return A PartSelect identical to this. + * @return A PartSelect identical to this. */ PartSelect* clone() const; @@ -64,14 +64,14 @@ class IPXACTMODELS_EXPORT PartSelect /*! * Get the left value of the range. * - * @return The left value of the range. + * @return The left value of the range. */ QString getLeftRange() const; /*! * Get the right value of the range. * - * @return The right value of the range. + * @return The right value of the range. */ QString getRightRange() const; @@ -80,28 +80,28 @@ class IPXACTMODELS_EXPORT PartSelect /*! * Set the left value for the range. * - * @param [in] newLeftRange The new value for the left value of the range. + * @param [in] newLeftRange The new value for the left value of the range. */ void setLeftRange(QString const& newLeftRange); /*! * Set the right value for the range. * - * @param [in] newRightRange The new value for the right value of the range. + * @param [in] newRightRange The new value for the right value of the range. */ void setRightRange(QString const& newRightRange); /*! * Get the list of indexes. * - * @return Pointer to a list of indexes, + * @return Pointer to a list of indexes, */ QSharedPointer getIndices() const; /*! * Set the list of indexes. * - * @param [in] newIndices A new list of indexes. + * @param [in] newIndices A new list of indexes. */ void setIndices(QSharedPointer newIndices); diff --git a/IPXACTmodels/common/PortAlignment.h b/IPXACTmodels/common/PortAlignment.h index 683b27267..c22205d84 100644 --- a/IPXACTmodels/common/PortAlignment.h +++ b/IPXACTmodels/common/PortAlignment.h @@ -26,8 +26,8 @@ class IPXACTMODELS_EXPORT PortAlignment /*! * The constructor. * - * @param [in] leftAlignment The higher alignment of the port. - * @param [in] right The lower alignment of the port. + * @param [in] leftAlignment The higher alignment of the port. + * @param [in] right The lower alignment of the port. */ PortAlignment(int leftAlignment = 0, int rightAlignment = 0); @@ -42,42 +42,42 @@ class IPXACTMODELS_EXPORT PortAlignment /*! * Get the higher (left) alignment of the port. * - * @return The higher (left) alignment of the port. + * @return The higher (left) alignment of the port. */ int getLeftAlignment() const; /*! * Set the higher (left) alignment of the port. * - * @param [in] newLeftAlignment The new higher (left) alignment. + * @param [in] newLeftAlignment The new higher (left) alignment. */ void setLeftAlignment(int newLeftAlignment); /*! * Get the lower (right) alignment of the port. * - * @return The lower (right) alignment of the port. + * @return The lower (right) alignment of the port. */ int getRightAlignment() const; /*! * Set the lower (right) alignment of the port. * - * @param [in] newRightAlignment The new lower (right) alignment. + * @param [in] newRightAlignment The new lower (right) alignment. */ void setRightAlignment(int newRightAlignment); /*! * Check if the port alignment is valid. * - * @return True, if the alignment is valid, false otherwise. + * @return True, if the alignment is valid, false otherwise. */ bool isValid() const; /*! * Set the validity of the port alignment. * - * @param [in] validity The new validity of the port alignment. + * @param [in] validity The new validity of the port alignment. */ void setAlignmentValidity(bool validity); diff --git a/IPXACTmodels/common/PresenceTypes.h b/IPXACTmodels/common/PresenceTypes.h index a5028aa8f..ab5e20d14 100644 --- a/IPXACTmodels/common/PresenceTypes.h +++ b/IPXACTmodels/common/PresenceTypes.h @@ -36,18 +36,18 @@ namespace PresenceTypes * if The str does not match any of the enum values the default value * specifies as parameter will be returned * - * @param [in] str QString containing the string to be converted - * @param [in] defaultValue The value that will be returned if no match is found + * @param [in] str QString containing the string to be converted + * @param [in] defaultValue The value that will be returned if no match is found * - * @return General::Presence that matches the str or default value. + * @return General::Presence that matches the str or default value. */ IPXACTMODELS_EXPORT Presence str2Presence(QString str, Presence defaultValue); /*! Convert the enum presence to QString. * - * @param [in] presence The enum value to be converted + * @param [in] presence The enum value to be converted * - * @return QString matching the enum value. + * @return QString matching the enum value. */ IPXACTMODELS_EXPORT QString presence2Str(Presence presence); } diff --git a/IPXACTmodels/common/Protocol.h b/IPXACTmodels/common/Protocol.h index 5f3100690..ae6878c9b 100644 --- a/IPXACTmodels/common/Protocol.h +++ b/IPXACTmodels/common/Protocol.h @@ -31,21 +31,21 @@ class IPXACTMODELS_EXPORT Protocol : public Extendable /*! * Create a copy of the Protocol. * - * @return A Protocol identical to this. + * @return A Protocol identical to this. */ Protocol* clone() const; /*! * Sets the protocol type. * - * @param [in] type The type to set. + * @param [in] type The type to set. */ void setProtocolType(QString const& type); /*! * Gets the protocol type. * - * @return The protocol type. + * @return The protocol type. */ QString getProtocolType() const; @@ -54,57 +54,57 @@ class IPXACTMODELS_EXPORT Protocol : public Extendable /*! * Checks if the protocol has payload defined. * - * @return True, if payload is defined, otherwise false. + * @return True, if payload is defined, otherwise false. */ bool hasPayload() const; /*! * Sets the name for the payload. * - * @param [in] payloadName The name to set. + * @param [in] payloadName The name to set. */ void setPayloadName(QString const& payloadName); /*! * Gets the name of the payload. * - * @return The name of the payload. + * @return The name of the payload. */ QString getPayloadName() const; /*! * Sets the type for the payload. * - * @param [in] payloadType The type to set. + * @param [in] payloadType The type to set. */ void setPayloadType(QString const& payloadType); /*! * Gets the payload type. * - * @return The payload type. + * @return The payload type. */ QString getPayloadType() const; /*! * Sets the extension for the payload. * - * @param [in] extension The extension to set. - * @param [in] mandatory Specifies if the extension is mandatory or not. + * @param [in] extension The extension to set. + * @param [in] mandatory Specifies if the extension is mandatory or not. */ void setPayloadExtension(QString const& extension, bool mandatory); /*! * Gets the payload extension. * - * @return The payload extension. + * @return The payload extension. */ QString getPayloadExtension() const; /*! * Checks if the payload extension is mandatory or not. * - * @return True, if the extension is mandatory, otherwise false. + * @return True, if the extension is mandatory, otherwise false. */ bool hasMandatoryPayloadExtension() const; diff --git a/IPXACTmodels/common/ProtocolReader.h b/IPXACTmodels/common/ProtocolReader.h index 62b571be5..1dba148c6 100644 --- a/IPXACTmodels/common/ProtocolReader.h +++ b/IPXACTmodels/common/ProtocolReader.h @@ -27,7 +27,7 @@ class ProtocolReader /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ProtocolReader(); @@ -41,7 +41,7 @@ class ProtocolReader /*! * Creates a protocol from XML description. * - * @param [in] protocolNode The XML description of the protocol. + * @param [in] protocolNode The XML description of the protocol. */ QSharedPointer createProtocolFrom(QDomNode const& protocolNode) const; diff --git a/IPXACTmodels/common/ProtocolWriter.h b/IPXACTmodels/common/ProtocolWriter.h index 44a204aa6..902876f90 100644 --- a/IPXACTmodels/common/ProtocolWriter.h +++ b/IPXACTmodels/common/ProtocolWriter.h @@ -37,8 +37,8 @@ class ProtocolWriter /*! * Writes the given protocol description into XML. * - * @param [in] writer The XML writer to use. - * @param [in] protocol The protocol to write. + * @param [in] writer The XML writer to use. + * @param [in] protocol The protocol to write. */ void writeProtocol(QXmlStreamWriter& writer, QSharedPointer protocol) const; @@ -48,16 +48,16 @@ class ProtocolWriter /*! * Writes the transactional port protocol type on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] portProtocol The protocol whose type to write. + * @param [in] writer The XML writer to use. + * @param [in] portProtocol The protocol whose type to write. */ void writeProtocolType(QXmlStreamWriter& writer, QSharedPointer portProtocol) const; /*! * Writes the transactional port protocol payload on system/master/slave into XML. * - * @param [in] writer The XML writer to use. - * @param [in] portProtocol The protocol whose payload to write. + * @param [in] writer The XML writer to use. + * @param [in] portProtocol The protocol whose payload to write. */ void writePayload(QXmlStreamWriter& writer, QSharedPointer portProtocol) const; diff --git a/IPXACTmodels/common/Qualifier.h b/IPXACTmodels/common/Qualifier.h index 265c23a4b..854bd071a 100644 --- a/IPXACTmodels/common/Qualifier.h +++ b/IPXACTmodels/common/Qualifier.h @@ -60,7 +60,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Create a copy of the Qualifier. * - * @return A Qualifier identical to this. + * @return A Qualifier identical to this. */ Qualifier* clone() const; @@ -79,7 +79,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Checks if the qualifier has a specific type set. * - * @param [in] type The type to check. + * @param [in] type The type to check. * * @return True, if the type is set, otherwise false. */ @@ -88,7 +88,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Sets the qualifier type. * - * @param [in] type The type to set. + * @param [in] type The type to set. */ void setType(Type type); @@ -108,7 +108,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Get a selected attribute. * - * @param [in] attributeName The attribute name. + * @param [in] attributeName The attribute name. * * @return The attribute as a string. */ @@ -117,8 +117,8 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Sets a given qualifier attribute. * - * @param [in] attributeName The attribute name to set. - * @param [in] attributeValue The attribute value to set. + * @param [in] attributeName The attribute name to set. + * @param [in] attributeValue The attribute value to set. */ void setAttribute(Attribute attribute, QString const& attributeValue); @@ -129,7 +129,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Gets a qualifier type as string. * - * @param [in] type Type to convert to string. + * @param [in] type Type to convert to string. * * @return Type as string. */ @@ -138,7 +138,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Converts a qualifier type from string to type. * - * @param [in] typeString Type as a string to convert to type. + * @param [in] typeString Type as a string to convert to type. * * @return Qualifier type. */ @@ -147,7 +147,7 @@ class IPXACTMODELS_EXPORT Qualifier /*! * Converts a qualifier attribute name string to attribute. * - * @param [in] attributeName The attribute as string. + * @param [in] attributeName The attribute as string. * * @return The converted attribute. */ diff --git a/IPXACTmodels/common/QualifierReader.h b/IPXACTmodels/common/QualifierReader.h index e5f4b96f9..448984073 100644 --- a/IPXACTmodels/common/QualifierReader.h +++ b/IPXACTmodels/common/QualifierReader.h @@ -27,9 +27,9 @@ namespace QualifierReader /*! * Parses a qualifier. * - * @param [in] qualifierNode XML description of the IP-XACT element. - * @param [in] qualifier The qualifier to read to. - * @param [in] revision The standard revision of the XML document being read. + * @param [in] qualifierNode XML description of the IP-XACT element. + * @param [in] qualifier The qualifier to read to. + * @param [in] revision The standard revision of the XML document being read. */ void parseQualifier(QDomNode const& qualifierNode, QSharedPointer qualifier, diff --git a/IPXACTmodels/common/QualifierWriter.h b/IPXACTmodels/common/QualifierWriter.h index 7498cf863..bcf71903d 100644 --- a/IPXACTmodels/common/QualifierWriter.h +++ b/IPXACTmodels/common/QualifierWriter.h @@ -28,8 +28,8 @@ class QualifierWriter /*! * Writes the given protocol description into XML. * - * @param [in] writer The XML writer to use. - * @param [in] protocol The protocol to write. + * @param [in] writer The XML writer to use. + * @param [in] protocol The protocol to write. */ static void writeQualifier(QXmlStreamWriter& writer, QSharedPointer qualifier); diff --git a/IPXACTmodels/common/Range.h b/IPXACTmodels/common/Range.h index 2ffcd8f23..6b00daa66 100644 --- a/IPXACTmodels/common/Range.h +++ b/IPXACTmodels/common/Range.h @@ -34,28 +34,28 @@ class IPXACTMODELS_EXPORT Range /*! * Gets the left value of the range. * - * @return The left value of the Vector. + * @return The left value of the Vector. */ QString getLeft() const; /*! * Gets the right value of the range. * - * @return The right value of the Vector. + * @return The right value of the Vector. */ QString getRight() const; /*! * Sets the left value for the range. * - * @param [in] newLeft The value to be set as left. + * @param [in] newLeft The value to be set as left. */ void setLeft(QString const& newLeft); /*! * Sets the right value for the range. * - * @param [in] newright The value to be set as right. + * @param [in] newright The value to be set as right. */ void setRight(QString const& newright); diff --git a/IPXACTmodels/common/TimingConstraint.h b/IPXACTmodels/common/TimingConstraint.h index cf7c9f033..edd5ff277 100644 --- a/IPXACTmodels/common/TimingConstraint.h +++ b/IPXACTmodels/common/TimingConstraint.h @@ -51,56 +51,56 @@ class IPXACTMODELS_EXPORT TimingConstraint /*! * Sets the constraint value. * - * @param [in] delayPercentage The value percentage. + * @param [in] delayPercentage The value percentage. */ void setValue(double delayPercentage); /*! * Gets the constraint value. * - * @return The constraint value. + * @return The constraint value. */ double getValue() const; /*! * Sets the clock edge for the constraint. * - * @param [in] edge The edge to set. + * @param [in] edge The edge to set. */ void setClockEdge(TimingConstraint::ClockEdgeType edge); /*! * Gets the clock edge. * - * @return The clock edge type. + * @return The clock edge type. */ ClockEdgeType getClockEdge() const; /*! * Sets the delay type for the constraint. * - * @param [in] delayType The delay type to set. + * @param [in] delayType The delay type to set. */ void setDelayType(TimingConstraint::DelayType delayType); /*! * Gets the delay type. * - * @return The delay type. + * @return The delay type. */ DelayType getDelayType() const; /*! * Sets the clock name for the constraint. * - * @param [in] clockPort The clock name to set. + * @param [in] clockPort The clock name to set. */ void setClockName(QString const& clockPort); /*! * Gets the clock name for the constraint. * - * @return The clock name. + * @return The clock name. */ QString getClockName() const; diff --git a/IPXACTmodels/common/TransactionalTypes.h b/IPXACTmodels/common/TransactionalTypes.h index ecf2ce4b1..9fc4246c6 100644 --- a/IPXACTmodels/common/TransactionalTypes.h +++ b/IPXACTmodels/common/TransactionalTypes.h @@ -50,36 +50,36 @@ namespace TransactionalTypes /*! * Change the selected initiative value to string. * - * @param [in] initiative The selected initiative value. + * @param [in] initiative The selected initiative value. * - * @return The selected initiative in string format. + * @return The selected initiative in string format. */ IPXACTMODELS_EXPORT QString initiativeToString(TransactionalTypes::Initiative const& initiative); /*! * Change the selected string to initiative value. * - * @param [in] str The selected initiative string. + * @param [in] str The selected initiative string. * - * @return The selected initiative in initiative format. + * @return The selected initiative in initiative format. */ IPXACTMODELS_EXPORT TransactionalTypes::Initiative strToInitiative(QString const& str); /*! * Checks if the file type belongs to the specified file types. * - * @param [in] fileType The file type to check. + * @param [in] fileType The file type to check. * - * @return True if the file type is one of the specified ones, false otherwise. + * @return True if the file type is one of the specified ones, false otherwise. */ IPXACTMODELS_EXPORT bool isIpXactInitiativeType(QString const& initiativeType); /*! * Convert the selected initiative to mirrored initiative. * - * @param [in] initiative The selected initiative. + * @param [in] initiative The selected initiative. * - * @return The mirrored initiative. + * @return The mirrored initiative. */ IPXACTMODELS_EXPORT TransactionalTypes::Initiative convertToMirrored(QString const& initiative); @@ -95,9 +95,9 @@ namespace TransactionalTypes /*! * Checks if the kind type belongs to the specified kind types. * - * @param [in] kindType The kind type to check. + * @param [in] kindType The kind type to check. * - * @return True if the kind type is one of the specified ones, false otherwise. + * @return True if the kind type is one of the specified ones, false otherwise. */ IPXACTMODELS_EXPORT bool isIpXactKindType(QString const& kindType); } diff --git a/IPXACTmodels/common/VLNV.h b/IPXACTmodels/common/VLNV.h index a1e88d5a7..166344451 100644 --- a/IPXACTmodels/common/VLNV.h +++ b/IPXACTmodels/common/VLNV.h @@ -51,11 +51,11 @@ class IPXACTMODELS_EXPORT VLNV /*! The Constructor. * - * @param [in] type The type of the VLNV document (design, component...). - * @param [in] vendor The name of the vendor. - * @param [in] library The name of the library. - * @param [in] name The name of the item. - * @param [in] version The version number of the item. + * @param [in] type The type of the VLNV document (design, component...). + * @param [in] vendor The name of the vendor. + * @param [in] library The name of the library. + * @param [in] name The name of the item. + * @param [in] version The version number of the item. */ VLNV(QString const& type, QString const& vendor, QString const& library, QString const& name, QString const& version); @@ -64,27 +64,27 @@ class IPXACTMODELS_EXPORT VLNV * * This constructor uses enum IPXactType to define the type of the document. * - * @param [in] type IPXactType type parameter defining document type - * @param [in] vendor The name of the vendor. - * @param [in] library The name of the library. - * @param [in] name The name of the item. - * @param [in] version The version number of the item. + * @param [in] type IPXactType type parameter defining document type + * @param [in] vendor The name of the vendor. + * @param [in] library The name of the library. + * @param [in] name The name of the item. + * @param [in] version The version number of the item. */ VLNV(IPXactType const& type, QString const& vendor, QString const& library, QString const& name, QString const& version); /*! The constructor. * - * @param [in] type The document type for the vlnv. - * @param [in] parseStr The string which is parsed to find the different vlnv fields. - * @param [in] separator The character used to separate the different vlnv fields in the string. + * @param [in] type The document type for the vlnv. + * @param [in] parseStr The string which is parsed to find the different vlnv fields. + * @param [in] separator The character used to separate the different vlnv fields in the string. * */ VLNV(IPXactType const& type, QString const& parseStr, QString const& separator = QLatin1String(":")); /*! Copy constructor * - * @param [in] other The VLNV to be copied. + * @param [in] other The VLNV to be copied. */ VLNV(VLNV const& other) = default; @@ -93,74 +93,74 @@ class IPXACTMODELS_EXPORT VLNV /*! Get the vendor of the VLNV. * - * @return The name of the vendor. + * @return The name of the vendor. */ QString getVendor() const; /*! Set the vendor for the vlnv. * - * @param [in] vendor The vendor name to set. + * @param [in] vendor The vendor name to set. */ void setVendor(QString const& vendor); /*! Get the library of the VLNV. * - * @return The name of the library + * @return The name of the library */ QString getLibrary() const; /*! Set the library for the vlnv. * - * @param [in] library The library name + * @param [in] library The library name */ void setLibrary(QString const& library); /*! Get the name of the IP item in VLNV. * - * @return The name of the IP item in VLNV. + * @return The name of the IP item in VLNV. */ QString getName() const; /*! Set the name for the VLNV. * - * @param [in] name The new name. + * @param [in] name The new name. */ void setName(QString const& name); /*! Get the version of the VLNV. * - * @return the The version of the VLNV. + * @return the The version of the VLNV. */ QString getVersion() const; /*! Set the version of the VLNV. * - * @param [in] version The new version. + * @param [in] version The new version. */ void setVersion(QString const& version); /*! Get the type of the document the VLNV belongs to. * - * @return IPXactType which tells the document type. + * @return IPXactType which tells the document type. */ IPXactType getType() const; /*! Set the document type for the vlnv. * - * @param [in] type Specifies the type to set. + * @param [in] type Specifies the type to set. */ void setType(IPXactType type); /*! Get the type the VLNV belongs to in a QString. * - * @return The XML document element type. + * @return The XML document element type. */ QString getTypestr() const; /*! * Checks if the VLNV is empty. * - * @returns True if all VLNV fields are empty, otherwise false. + * @returns True if all VLNV fields are empty, otherwise false. */ bool isEmpty() const; @@ -171,24 +171,24 @@ class IPXACTMODELS_EXPORT VLNV /*! Checks if the vlnv is valid or not. * - * @return True, if the VLNV tag is valid, otherwise false. + * @return True, if the VLNV tag is valid, otherwise false. */ bool isValid() const; /*! Check if the vlnv is valid. * - * @param [in] errorList The list to add the possible error messages to. - * @param [in] parentIdentifier String from parent to help to identify the location of the error. + * @param [in] errorList The list to add the possible error messages to. + * @param [in] parentIdentifier String from parent to help to identify the location of the error. * - * @return bool True if the state is valid and writing is possible. + * @return bool True if the state is valid and writing is possible. */ bool isValid(QVector& errors, QString const& parentIdentifier) const; /*! Create a QString that contains the vlnv. * - * @param [in] separator The separator that is placed between each vlnv field + * @param [in] separator The separator that is placed between each vlnv field * - * @return QString contains the vlnv in one string. + * @return QString contains the vlnv in one string. */ QString toString(QString const& separator = QLatin1String(":")) const; @@ -197,48 +197,48 @@ class IPXACTMODELS_EXPORT VLNV /*! The < operator for comparison of the VLNV info * - * @param [in] other the instance to compare + * @param [in] other the instance to compare * - * @return boolean value of the comparison + * @return boolean value of the comparison */ bool operator<(const VLNV &other) const; /*! The > operator for comparison of the VLNV info * - * @param [in] other the instance to compare + * @param [in] other the instance to compare * - * @return the boolean value of the comparison + * @return the boolean value of the comparison */ bool operator>(const VLNV &other) const; /*! The == comparison operator * - * @param [in] other The other VLNV instance to be compared + * @param [in] other The other VLNV instance to be compared * - * @return boolean value of the comparison operation + * @return boolean value of the comparison operation */ bool operator==(const VLNV &other) const; /*! The != operator * - * @param [in] other the instance to compare + * @param [in] other the instance to compare * - * @return boolean value of the comparison operation + * @return boolean value of the comparison operation */ bool operator!=(const VLNV &other) const; /*! Static function. Convert QString formatted type to enum Type * - * @param [in] type QString that holds the type to get - * @return IPXactType that corresponds to the given string + * @param [in] type QString that holds the type to get + * @return IPXactType that corresponds to the given string */ static VLNV::IPXactType string2Type(QString const& type); /*! Static function. Converts type to QString. * - * @param [in] type QString that holds the type to get + * @param [in] type QString that holds the type to get * - * @return IPXactType that corresponds to the given string + * @return IPXactType that corresponds to the given string */ static QString IPXactType2String(IPXactType const& type); diff --git a/IPXACTmodels/common/Vector.h b/IPXACTmodels/common/Vector.h index 11c83c8d4..b9be927a1 100644 --- a/IPXACTmodels/common/Vector.h +++ b/IPXACTmodels/common/Vector.h @@ -33,8 +33,8 @@ class IPXACTMODELS_EXPORT Vector : public Range /*! * The constructor. * - * @param [in] left The left side of the vector. - * @param [in] right The right side of the vector. + * @param [in] left The left side of the vector. + * @param [in] right The right side of the vector. */ Vector(QString const& left, QString const& right); @@ -44,14 +44,14 @@ class IPXACTMODELS_EXPORT Vector : public Range /*! * Create a copy of the Vector. * - * @return A Vector identical to this. + * @return A Vector identical to this. */ Vector* clone() const; /*! * Sets the vector id. * - * @param [in] id Description + * @param [in] id Description */ void setId(QString const& id); diff --git a/IPXACTmodels/common/VendorExtension.h b/IPXACTmodels/common/VendorExtension.h index c8517f239..028cda7b0 100644 --- a/IPXACTmodels/common/VendorExtension.h +++ b/IPXACTmodels/common/VendorExtension.h @@ -30,21 +30,21 @@ class IPXACTMODELS_EXPORT VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual VendorExtension* clone() const = 0; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const = 0; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const = 0; diff --git a/IPXACTmodels/common/validators/AssertionValidator.h b/IPXACTmodels/common/validators/AssertionValidator.h index 960cdb6f6..7dec3933d 100644 --- a/IPXACTmodels/common/validators/AssertionValidator.h +++ b/IPXACTmodels/common/validators/AssertionValidator.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT AssertionValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] expressionParser The parser to use for solving expressions. */ AssertionValidator(QSharedPointer expressionParser); @@ -40,36 +40,36 @@ class IPXACTMODELS_EXPORT AssertionValidator /*! * Validates the given assertion. * - * @param [in] assertion The selected assertion. + * @param [in] assertion The selected assertion. * - * @return True, if the assertion is valid IP-XACT, otherwise false. + * @return True, if the assertion is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer assertion) const; /*! * Check if the name is valid. * - * @param [in] assertion The selected assertion. + * @param [in] assertion The selected assertion. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer assertion) const; /*! * Check if the assert value is valid. * - * @param [in] assertion The selected assertion. + * @param [in] assertion The selected assertion. * - * @return True, if the assert value is valid, otherwise false. + * @return True, if the assert value is valid, otherwise false. */ bool hasValidAssert(QSharedPointer assertion) const; /*! * Locate errors within an assertion. * - * @param [in] errors List of found errors. - * @param [in] assertion The selected assertion. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] assertion The selected assertion. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer assertion, QString const& context) const; @@ -83,9 +83,9 @@ class IPXACTMODELS_EXPORT AssertionValidator /*! * Find errors within name. * - * @param [in] errors List of found errors. - * @param [in] assertion The selected assertion. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] assertion The selected assertion. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer assertion, QString const& context) const; @@ -93,9 +93,9 @@ class IPXACTMODELS_EXPORT AssertionValidator /*! * Find errors within assert value. * - * @param [in] errors List of found errors. - * @param [in] assertion The selected assertion. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] assertion The selected assertion. + * @param [in] context Context to help locate the error. */ void findErrorsInAssert(QVector& errors, QSharedPointer assertion, QString const& context) const; diff --git a/IPXACTmodels/common/validators/CellSpecificationValidator.h b/IPXACTmodels/common/validators/CellSpecificationValidator.h index 75966a5b3..17560a205 100644 --- a/IPXACTmodels/common/validators/CellSpecificationValidator.h +++ b/IPXACTmodels/common/validators/CellSpecificationValidator.h @@ -39,18 +39,18 @@ class IPXACTMODELS_EXPORT CellSpecificationValidator /*! * Validates the given CellSpecification. * - * @param [in] CellSpecification The CellSpecification to validate. + * @param [in] CellSpecification The CellSpecification to validate. * - * @return True, if the CellSpecification is valid IP-XACT, otherwise false. + * @return True, if the CellSpecification is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer cellSpecification) const; /*! * Finds possible errors in a CellSpecification and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] CellSpecification The CellSpecification whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] CellSpecification The CellSpecification whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsIn(QVector& errors, QSharedPointer cellSpecification, QString const& context) const; diff --git a/IPXACTmodels/common/validators/ChoiceValidator.h b/IPXACTmodels/common/validators/ChoiceValidator.h index e21861135..e65d327f3 100644 --- a/IPXACTmodels/common/validators/ChoiceValidator.h +++ b/IPXACTmodels/common/validators/ChoiceValidator.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT ChoiceValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] expressionParser The parser to use for solving expressions. */ ChoiceValidator(QSharedPointer expressionParser); @@ -44,36 +44,36 @@ class IPXACTMODELS_EXPORT ChoiceValidator /*! * Validates the given choice. * - * @param [in] choice The selected choice. + * @param [in] choice The selected choice. * - * @return True, if the choice is valid IP-XACT, otherwise false. + * @return True, if the choice is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer choice) const; /*! * Check if the name is valid. * - * @param [in] choice The selected choice. + * @param [in] choice The selected choice. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QSharedPointer choice) const; /*! * Check if the enumerations are valid. * - * @param [in] choice The selected choice. + * @param [in] choice The selected choice. * - * @return True, if the enumerations are valid, otherwise false. + * @return True, if the enumerations are valid, otherwise false. */ bool hasValidEnumerations(QSharedPointer choice) const; /*! * Locate errors within a choice. * - * @param [in] errors List of found errors. - * @param [in] choice The selected choice. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] choice The selected choice. + * @param [in] context Context to help locate the error. */ void findErrorsIn(QVector& errors, QSharedPointer choice, QString const& context) const; @@ -82,18 +82,18 @@ class IPXACTMODELS_EXPORT ChoiceValidator /*! * Find errors within name. * - * @param [in] errors List of found errors. - * @param [in] choice The selected choice. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] choice The selected choice. + * @param [in] context Context to help locate the error. */ void findErrorsInName(QVector& errors, QSharedPointer choice, QString const& context) const; /*! * Find errors within enumerations. * - * @param [in] errors List of found errors. - * @param [in] choice The selected choice. - * @param [in] context Context to help locate the error. + * @param [in] errors List of found errors. + * @param [in] choice The selected choice. + * @param [in] context Context to help locate the error. */ void findErrorsInEnumerations(QVector& errors, QSharedPointer choice, QString const& context) const; diff --git a/IPXACTmodels/common/validators/CommonItemsValidator.h b/IPXACTmodels/common/validators/CommonItemsValidator.h index 52c16cec2..55ff65a44 100644 --- a/IPXACTmodels/common/validators/CommonItemsValidator.h +++ b/IPXACTmodels/common/validators/CommonItemsValidator.h @@ -28,19 +28,19 @@ namespace CommonItemsValidator /*! * Validates the given name. * - * @param [in] name The name to validate. + * @param [in] name The name to validate. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name); /*! * Validates the given isPresent expression. * - * @param [in] isPresent The expression to validate. - * @param [in] parser The expression parser to use. + * @param [in] isPresent The expression to validate. + * @param [in] parser The expression parser to use. * - * @return True, if the isPresent is valid, otherwise false. + * @return True, if the isPresent is valid, otherwise false. */ bool hasValidIsPresent(QString const& isPresent, QSharedPointer parser); @@ -50,8 +50,8 @@ namespace CommonItemsValidator * Check if given mode references are valid. Also look for duplicate values when compared with * previously checked references. * - * @param [in] modeRefs The mode references to check. - * @param [in] availableModes The available component modes. + * @param [in] modeRefs The mode references to check. + * @param [in] availableModes The available component modes. * * @return True, if the given mode references are valid, otherwise false. */ @@ -61,9 +61,9 @@ namespace CommonItemsValidator * Check if given mode references are valid. Compare with other mode references in the containing element. * Used for validating mode references of single item, for UI purposes. * - * @param [in] modeRefsToCheck The mode references to check. - * @param [in] otherModeReferencesInUse The other mode references in the containing item. - * @param [in] availableModes The available component modes. + * @param [in] modeRefsToCheck The mode references to check. + * @param [in] otherModeReferencesInUse The other mode references in the containing item. + * @param [in] availableModes The available component modes. * * @return True, if mode references were valid, otherwise false. */ @@ -76,13 +76,13 @@ namespace CommonItemsValidator * be unique not only within the mode references of the parent element, but also the parent's sibling elements. * For instance, all mode references inside access policy elements of a register must be unique. * - * @param [in] errors The list of found errors. - * @param [in] modeRefs The mode references to check. - * @param [in] context Context to help locate the error. - * @param [in] checkedRefs Already checked mode reference values. - * @param [in] checkedPriorities Already checked mode reference priorities. - * @param [in] duplicateRefErrorIssued Flag indicating if an error for duplicate references has been issued. - * @param [in] duplicatePriorityErrorIssued Flag indicating if an error for duplicate priorities has been issued. + * @param [in] errors The list of found errors. + * @param [in] modeRefs The mode references to check. + * @param [in] context Context to help locate the error. + * @param [in] checkedRefs Already checked mode reference values. + * @param [in] checkedPriorities Already checked mode reference priorities. + * @param [in] duplicateRefErrorIssued Flag indicating if an error for duplicate references has been issued. + * @param [in] duplicatePriorityErrorIssued Flag indicating if an error for duplicate priorities has been issued. */ void findErrorsInModeRefs(QStringList& errors, QSharedPointer > > modeRefs, QString const& context, QStringList& checkedRefs, QList& checkedPriorities, @@ -92,9 +92,9 @@ namespace CommonItemsValidator * Check if a single mode reference is valid. Provide all mode references in containing element to check * against for duplicates. * - * @param [in] modeRefsInContainingElem All other mode references in the containing element. - * @param [in] modeReferenceToCheck The mode reference to check. - * @param [in] isRemap Flag indicating if given mode ref is within a remap or not. + * @param [in] modeRefsInContainingElem All other mode references in the containing element. + * @param [in] modeReferenceToCheck The mode reference to check. + * @param [in] isRemap Flag indicating if given mode ref is within a remap or not. * * @return True, if mode reference is valid, otherwise false. */ @@ -105,9 +105,9 @@ namespace CommonItemsValidator * Check if the priority of a single mode reference is valid. Provide all other mode reference priorities in * containing element to check against for duplicates (if not within memory remap). * - * @param [in] modeRefPrioritiesInContainingElem All other mode references in the containing element. - * @param [in] modeReferencePriorityToCheck The mode reference whose priority to check. - * @param [in] isRemap Flag indicating mode ref priority being checked is + * @param [in] modeRefPrioritiesInContainingElem All other mode references in the containing element. + * @param [in] modeReferencePriorityToCheck The mode reference whose priority to check. + * @param [in] isRemap Flag indicating mode ref priority being checked is * within a remap or not. * * @return True, if the mode reference priority is valid, otherwise false. @@ -119,9 +119,9 @@ namespace CommonItemsValidator * Check if the reference value of a single mode reference is valid. Provide all other mode references in * containing element to check against for duplicates. * - * @param [in] modeRefsInContainingElem All other mode references in the containing element. - * @param [in] modeReferenceToCheck The mode reference whose reference value to check. - * @param [in] availableModes The available component modes. + * @param [in] modeRefsInContainingElem All other mode references in the containing element. + * @param [in] modeReferenceToCheck The mode reference whose reference value to check. + * @param [in] availableModes The available component modes. * * @return True, if the mode reference value is valid, otherwise false. */ @@ -131,7 +131,7 @@ namespace CommonItemsValidator /*! * Validate given access policies. * - * @param [in] accessPolicies The access policies to validate. + * @param [in] accessPolicies The access policies to validate. * * @return True, if the access policies are valid, otherwise false. */ @@ -140,10 +140,10 @@ namespace CommonItemsValidator /*! * Find errors in given access policies. * - * @param [in] errors The list of found errors. - * @param [in] accessPolicies List of access policies to check. - * @param [in] componentModes List of available component modes. - * @param [in] context + * @param [in] errors The list of found errors. + * @param [in] accessPolicies List of access policies to check. + * @param [in] componentModes List of available component modes. + * @param [in] context */ IPXACTMODELS_EXPORT void findErrorsInAccessPolicies(QStringList& errors, QSharedPointer > > accessPolicies, diff --git a/IPXACTmodels/common/validators/HierarchicalValidator.h b/IPXACTmodels/common/validators/HierarchicalValidator.h index 4ec6a9278..27c5b6e34 100644 --- a/IPXACTmodels/common/validators/HierarchicalValidator.h +++ b/IPXACTmodels/common/validators/HierarchicalValidator.h @@ -28,7 +28,7 @@ class IPXACTMODELS_EXPORT HierarchicalValidator /*! * Check and mark validity of child/sibling items. Checks for name uniqueness. * - * @param [in] children The items to be validated. + * @param [in] children The items to be validated. * * @return True, if all child items are valid amongst themselves, false otherwise. */ @@ -37,7 +37,7 @@ class IPXACTMODELS_EXPORT HierarchicalValidator /*! * Set the validator to be used when validating child/sibling items. * - * @param [in] childValidator The validator to set. + * @param [in] childValidator The validator to set. */ void setChildValidator(QSharedPointer childValidator); @@ -45,7 +45,7 @@ class IPXACTMODELS_EXPORT HierarchicalValidator * Checks if the item is valid amongst its siblings. The item validity can be set by the parent validator * on a higher level in the hierarchy and is stored in the childItemValidities map. * - * @param [in] currentChildItem The item to check. + * @param [in] currentChildItem The item to check. * * @return True, if the item is valid, otherwise false. */ @@ -54,8 +54,8 @@ class IPXACTMODELS_EXPORT HierarchicalValidator /*! * Set the validitiy of an item. Called by a higher level validator. * - * @param [in] childItem The item whose validity to set. - * @param [in] isValid The validity status to set. + * @param [in] childItem The item whose validity to set. + * @param [in] isValid The validity status to set. */ void setChildItemValidity(QSharedPointer childItem, bool isValid); diff --git a/IPXACTmodels/common/validators/NMTokenValidator.h b/IPXACTmodels/common/validators/NMTokenValidator.h index 55a0c599b..67b528dd6 100644 --- a/IPXACTmodels/common/validators/NMTokenValidator.h +++ b/IPXACTmodels/common/validators/NMTokenValidator.h @@ -28,7 +28,7 @@ class IPXACTMODELS_EXPORT NMTokenValidator : public QRegularExpressionValidator /*! * Constructor for the validator. * - * @param [in] parent Parent of the validator. + * @param [in] parent Parent of the validator. */ explicit NMTokenValidator(QObject* parent); diff --git a/IPXACTmodels/common/validators/ParameterValidator.h b/IPXACTmodels/common/validators/ParameterValidator.h index e750c72a8..fa549003b 100644 --- a/IPXACTmodels/common/validators/ParameterValidator.h +++ b/IPXACTmodels/common/validators/ParameterValidator.h @@ -33,9 +33,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * The constructor. * - * @param [in] expressionParser The parser to use for solving expressions. - * @param [in] availavleChocies The currently available choices. - * @param [in] revision The IP-XACT standard revision of the element being checked. + * @param [in] expressionParser The parser to use for solving expressions. + * @param [in] availavleChocies The currently available choices. + * @param [in] revision The IP-XACT standard revision of the element being checked. */ ParameterValidator(QSharedPointer expressionParser, QSharedPointer > > availableChoices, Document::Revision docRevision); @@ -50,7 +50,7 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Change the available choices. * - * @param [in] newChoices The new choices. + * @param [in] newChoices The new choices. */ void componentChange(QSharedPointer > > newChoices, Document::Revision docRevision); @@ -59,134 +59,134 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Validates the given parameter. * - * @param [in] parameter The parameter to validate. + * @param [in] parameter The parameter to validate. * - * @return True, if the parameter is valid IP-XACT, otherwise false. + * @return True, if the parameter is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer parameter) const; /*! * Check if the parameter has a valid name. * - * @param [in] parameter The parameter being checked. + * @param [in] parameter The parameter being checked. */ bool hasValidName(QSharedPointer parameter) const; /*! * Validates the value of the given parameter. * - * @param [in] parameter The parameter whose value to validate. + * @param [in] parameter The parameter whose value to validate. * - * @return True, if the parameter value is valid, otherwise false. + * @return True, if the parameter value is valid, otherwise false. */ virtual bool hasValidValue(QSharedPointer parameter) const; /*! * Validates the value type of the given parameter. * - * @param [in] parameter The parameter whose type to validate. + * @param [in] parameter The parameter whose type to validate. * - * @return True, if the parameter type is valid, otherwise false. + * @return True, if the parameter type is valid, otherwise false. */ virtual bool hasValidType(QSharedPointer parameter) const; /*! * Checks if the given value is valid for the given type. * - * @param [in] value The value to validate. - * @param [in] type The type to which resolve the value. + * @param [in] value The value to validate. + * @param [in] type The type to which resolve the value. * - * @return True, if the value is valid for the given type, otherwise false. + * @return True, if the value is valid for the given type, otherwise false. */ virtual bool hasValidValueForType(QString const& value, QString const& type) const; /*! * Checks if the value of the given parameter is valid for the given type. * - * @param [in] parameter The parameter whose value to validate. + * @param [in] parameter The parameter whose value to validate. * - * @return True, if the value is valid for the given type, otherwise false. + * @return True, if the value is valid for the given type, otherwise false. */ virtual bool hasValidValueForType(QSharedPointer parameter) const; /*! * Validates the minimum value of the given parameter. * - * @param [in] parameter The parameter whose minimum value to validate. + * @param [in] parameter The parameter whose minimum value to validate. * - * @return True, if the minimum value is valid, otherwise false. + * @return True, if the minimum value is valid, otherwise false. */ virtual bool hasValidMinimumValue(QSharedPointer parameter) const; /*! * Validates the maximum value of the given parameter. * - * @param [in] parameter The parameter whose maximum value to validate. + * @param [in] parameter The parameter whose maximum value to validate. * - * @return True, if the maximum value is valid, otherwise false. + * @return True, if the maximum value is valid, otherwise false. */ virtual bool hasValidMaximumValue(QSharedPointer parameter) const; /*! * Check if the parameter has a valid choice. * - * @param [in] parameter The selected parameter. + * @param [in] parameter The selected parameter. * - * @return True, if the choice is valid, otherwise false. + * @return True, if the choice is valid, otherwise false. */ bool hasValidChoice(QSharedPointer parameter) const; /*! * Check if the parameter has a valid value for a choice. * - * @param [in] parameter The selected parameter. + * @param [in] parameter The selected parameter. * - * @return True if the value is valid for a choice, otherwise false. + * @return True if the value is valid for a choice, otherwise false. */ bool hasValidValueForChoice(QSharedPointer parameter) const; /*! * Check if the parameter has a valid resolve value. * - * @param [in] parameter The selected parameter. + * @param [in] parameter The selected parameter. * - * @return True, if the parameter has a valid resolve, otherwise false. + * @return True, if the parameter has a valid resolve, otherwise false. */ bool hasValidResolve(QSharedPointer parameter) const; /*! * Check if the parameter has a valid ID. * - * @param [in] parameter The selected parameter. + * @param [in] parameter The selected parameter. * - * @return True, if the ID is valid, otherwise false. + * @return True, if the ID is valid, otherwise false. */ bool hasValidValueId(QSharedPointer parameter) const; /*! * Checks if the value of the given parameter is less than the specified minimum value. * - * @param [in] parameter The parameter whose value to compare to minimum. + * @param [in] parameter The parameter whose value to compare to minimum. * - * @return True, if the value is less than minimum, otherwise false. + * @return True, if the value is less than minimum, otherwise false. */ virtual bool valueIsLessThanMinimum(QSharedPointer parameter) const; /*! * Checks if the value of the given parameter is greater than the specified maximum value. * - * @param [in] parameter The parameter whose value to compare to maximum. + * @param [in] parameter The parameter whose value to compare to maximum. * - * @return True, if the value is greater than maximum, otherwise false. + * @return True, if the value is greater than maximum, otherwise false. */ virtual bool valueIsGreaterThanMaximum(QSharedPointer parameter) const; /*! * Finds possible errors in a parameter and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsIn(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -194,26 +194,26 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Check if the given array is valid. * - * @param [in] arrayLeft The left value of the array. - * @param [in] arrayRight The right value of the array. + * @param [in] arrayLeft The left value of the array. + * @param [in] arrayRight The right value of the array. * - * @return True, if the array has valid values, false otherwise. + * @return True, if the array has valid values, false otherwise. */ bool validateArrayValues(QString const& arrayLeft, QString const& arrayRight) const; /*! * Check if the given parameter vector is valid. * - * @param [in] parameter The parameter being examined. + * @param [in] parameter The parameter being examined. * - * @return True, if the vector is valid, false otherwise. + * @return True, if the vector is valid, false otherwise. */ virtual bool hasValidVector(QSharedPointer parameter) const; /*! * Check if any vector of the parameter has a vector ID. * - * @param [in] parameter The parameter to check. + * @param [in] parameter The parameter to check. * * @return True, if vector id is set, otherwise false. */ @@ -224,29 +224,29 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Checks if the parameter value and the given boundary value, minimum or maximum, should be compared. * - * @param [in] boundaryValue The boundary value. - * @param [in] type The type format of the parameter. + * @param [in] boundaryValue The boundary value. + * @param [in] type The type format of the parameter. * - * @return True, if the value and boundary should be compared, otherwise false. + * @return True, if the value and boundary should be compared, otherwise false. */ virtual bool shouldCompareValueAndBoundary(QString const& boundaryValue, QString const& type) const; /*! * Evaluates the value of the given value for the given format. * - * @param [in] value The value to evaluate. - * @param [in] type The type to use for evaluation. Obsolete. + * @param [in] value The value to evaluate. + * @param [in] type The type to use for evaluation. Obsolete. * - * @return The evaluated value. + * @return The evaluated value. */ virtual qreal valueOf(QString const& value, QString const& type) const; /*! * Finds possible errors in a parameter name. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInName(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -254,9 +254,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds possible errors in a parameter value. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInValue(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -264,9 +264,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds the errors in minimum value. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInMinimumValue(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -274,9 +274,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds the errors in maximum value. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInMaximumValue(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -284,9 +284,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds the errors in choice value. * - * @param [in] errors List of found errors - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInChoice(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -294,9 +294,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds the errors in resolve value. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInResolve(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -304,9 +304,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds the errors in value identifier. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInValueId(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -314,9 +314,9 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Finds possible errors in a parameter value type. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInType(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -324,19 +324,19 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Check if the values in the array are valid for the given type. * - * @param [in] arrayExpression The array. - * @param [in] type The type of the parameter. + * @param [in] arrayExpression The array. + * @param [in] type The type of the parameter. * - * @return True, if the contents of the array are valid for type, otherwise false. + * @return True, if the contents of the array are valid for type, otherwise false. */ bool isArrayValidForType(QString const& arrayExpression, QString const& type) const; /*! * Finds possible errors in a bit vector. * - * @param [in] errors List of found errors. - * @param [in] parameter The parameter whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] parameter The parameter whose errors to find. + * @param [in] context Context to help locate the errors. */ void findErrorsInVector(QVector& errors, QSharedPointer parameter, QString const& context) const; @@ -346,11 +346,11 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Checks if the value of the given parameter is less than the specified minimum value. * - * @param [in] parameter The parameter whose value to compare to minimum. - * @param [in] solvedValue The resolved parameter value. - * @param [in] type The parameter type. + * @param [in] parameter The parameter whose value to compare to minimum. + * @param [in] solvedValue The resolved parameter value. + * @param [in] type The parameter type. * - * @return True, if the value is less than minimum, otherwise false. + * @return True, if the value is less than minimum, otherwise false. */ bool valueIsLessThanMinimum(QSharedPointer parameter, QString const& solvedValue, QString const& type) const; @@ -358,11 +358,11 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Checks if the value of the given parameter is greater than the specified maximum value. * - * @param [in] parameter The parameter whose value to compare to maximum. - * @param [in] solvedValue The resolved parameter value. - * @param [in] type The parameter type. + * @param [in] parameter The parameter whose value to compare to maximum. + * @param [in] solvedValue The resolved parameter value. + * @param [in] type The parameter type. * - * @return True, if the value is greater than maximum, otherwise false. + * @return True, if the value is greater than maximum, otherwise false. */ bool valueIsGreaterThanMaximum(QSharedPointer parameter, QString const& solvedValue, QString const& type) const; @@ -370,26 +370,26 @@ class IPXACTMODELS_EXPORT ParameterValidator /*! * Split the given array to a list. * - * @param [in] arrayValue The given array. + * @param [in] arrayValue The given array. * - * @return The list of values in the array. + * @return The list of values in the array. */ QStringList splitArrayToList(QString const& arrayValue) const; /*! * Check if all the values in the array are of the same size. * - * @param [in] bitArray The array to check. - * @param [in] type The given type of the array. + * @param [in] bitArray The array to check. + * @param [in] type The given type of the array. * - * @return True, if the array values are of the same size, otherwise false. + * @return True, if the array values are of the same size, otherwise false. */ bool arrayValuesAreSameSize(QStringList const& bitArray, QString const& type) const; /*! * Finds the choice. * - * @param [in] choiceName The name of the choice to be found. + * @param [in] choiceName The name of the choice to be found. */ QSharedPointer findChoiceByName(QString const& choiceName) const; diff --git a/IPXACTmodels/common/validators/ProtocolValidator.h b/IPXACTmodels/common/validators/ProtocolValidator.h index 32a4392f4..71642cf64 100644 --- a/IPXACTmodels/common/validators/ProtocolValidator.h +++ b/IPXACTmodels/common/validators/ProtocolValidator.h @@ -42,18 +42,18 @@ class IPXACTMODELS_EXPORT ProtocolValidator /*! * Validates the given Protocol. * - * @param [in] Protocol The Protocol to validate. + * @param [in] Protocol The Protocol to validate. * - * @return True, if the Protocol is valid IP-XACT, otherwise false. + * @return True, if the Protocol is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer Protocol) const; /*! * Finds possible errors in a Protocol and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] Protocol The Protocol whose errors to find. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] Protocol The Protocol whose errors to find. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsIn(QVector& errors, QSharedPointer Protocol, QString const& contex) const; @@ -63,9 +63,9 @@ class IPXACTMODELS_EXPORT ProtocolValidator /*! * Check if the name is valid. * - * @param [in] name The name to be evaluated. + * @param [in] name The name to be evaluated. * - * @return True, if the name is valid, otherwise false. + * @return True, if the name is valid, otherwise false. */ bool hasValidName(QString const& name) const; diff --git a/IPXACTmodels/common/validators/QualifierValidator.h b/IPXACTmodels/common/validators/QualifierValidator.h index f75444e7b..ccac82aa1 100644 --- a/IPXACTmodels/common/validators/QualifierValidator.h +++ b/IPXACTmodels/common/validators/QualifierValidator.h @@ -28,17 +28,17 @@ namespace QualifierValidator /*! * Validates the given Qualifier. * - * @param [in] AbstractionDefinition The Qualifier to validate. + * @param [in] AbstractionDefinition The Qualifier to validate. * - * @return True, if the Qualifier is valid IP-XACT, otherwise false. + * @return True, if the Qualifier is valid IP-XACT, otherwise false. */ IPXACTMODELS_EXPORT bool validate(QSharedPointer qualifier, Document::Revision revision); /*! * Finds possible errors in a Qualifier and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] AbstractionDefinition The AbstractionDefinition whose errors to find. + * @param [in] errors List of found errors. + * @param [in] AbstractionDefinition The AbstractionDefinition whose errors to find. */ IPXACTMODELS_EXPORT void findErrorsIn(QStringList& errors, QSharedPointer qualifier, QString const& context, Document::Revision revision); @@ -49,7 +49,7 @@ namespace QualifierValidator /*! * Validates the attributes of a qualifier. * - * @param [in] qualifier The qualifier whose attributes are validated. + * @param [in] qualifier The qualifier whose attributes are validated. * * @return True, if attributes are valid, otherwise false. */ @@ -58,9 +58,9 @@ namespace QualifierValidator /*! * Finds possible errors in a Qualifier's attributes and creates a list of them. * - * @param [in] errorList List of found errors. - * @param [in] qualifier The qualifier whose attributes are checked. - * @param [in] context The context to help locate the error. + * @param [in] errorList List of found errors. + * @param [in] qualifier The qualifier whose attributes are checked. + * @param [in] context The context to help locate the error. */ void findErrorsInAttributes(QVector& errorList, QSharedPointer qualifier, QString const& context); diff --git a/IPXACTmodels/common/validators/TimingConstraintValidator.h b/IPXACTmodels/common/validators/TimingConstraintValidator.h index 11117308c..b873f2d93 100644 --- a/IPXACTmodels/common/validators/TimingConstraintValidator.h +++ b/IPXACTmodels/common/validators/TimingConstraintValidator.h @@ -40,10 +40,10 @@ class IPXACTMODELS_EXPORT TimingConstraintValidator /*! * Validates the given TimingConstraint. * - * @param [in] TimingConstraint The TimingConstraint to validate. - * @param [in] ports Collection ports where the constraint belongs to. + * @param [in] TimingConstraint The TimingConstraint to validate. + * @param [in] ports Collection ports where the constraint belongs to. * - * @return True, if the TimingConstraint is valid IP-XACT, otherwise false. + * @return True, if the TimingConstraint is valid IP-XACT, otherwise false. */ bool validate(QSharedPointer timingConstraint, QSharedPointer > > ports) const; @@ -51,10 +51,10 @@ class IPXACTMODELS_EXPORT TimingConstraintValidator /*! * Finds possible errors in a TimingConstraint and creates a list of them. * - * @param [in] errors List of found errors. - * @param [in] TimingConstraint The TimingConstraint whose errors to find. - * @param [in] context Context to help locate the errors. - * @param [in] ports Collection ports where the constraint belongs to. + * @param [in] errors List of found errors. + * @param [in] TimingConstraint The TimingConstraint whose errors to find. + * @param [in] context Context to help locate the errors. + * @param [in] ports Collection ports where the constraint belongs to. */ void findErrorsIn(QVector& errors, QSharedPointer timingConstraint, @@ -65,18 +65,18 @@ class IPXACTMODELS_EXPORT TimingConstraintValidator /*! * Returns true, if value of parameter timingConstraint is valid. * - * @param [in] timingConstraint The inspected timing constraint. + * @param [in] timingConstraint The inspected timing constraint. * - * @return See above. + * @return See above. */ bool hasValidValue(QSharedPointer timingConstraint) const; /*! * Returns true, if edge of parameter timingConstraint is valid. * - * @param [in] timingConstraint The inspected timing constraint. + * @param [in] timingConstraint The inspected timing constraint. * - * @return See above. + * @return See above. */ bool hasValidEdge(QSharedPointer timingConstraint) const; diff --git a/IPXACTmodels/common/validators/ValueFormatter.h b/IPXACTmodels/common/validators/ValueFormatter.h index f71cc8262..82f5c02eb 100644 --- a/IPXACTmodels/common/validators/ValueFormatter.h +++ b/IPXACTmodels/common/validators/ValueFormatter.h @@ -29,10 +29,10 @@ class IPXACTMODELS_EXPORT ValueFormatter /*! * Formats the given value. * - * @param [in] value The value to format. - * @param [in] base The base to use in formatting. + * @param [in] value The value to format. + * @param [in] base The base to use in formatting. * - * @return The formatted value. + * @return The formatted value. */ virtual QString format(QString const& value, int base) const; @@ -45,8 +45,8 @@ class IPXACTMODELS_EXPORT ValueFormatter /*! * Format the given array. * - * @param [in] arrayValue The array to be formatted. - * @param [in] base The base to use in formatting. + * @param [in] arrayValue The array to be formatted. + * @param [in] base The base to use in formatting. */ QString formatArray(QString const& arrayValue, int& base) const; }; diff --git a/IPXACTmodels/common/validators/namevalidator.h b/IPXACTmodels/common/validators/namevalidator.h index 968320b35..027955323 100644 --- a/IPXACTmodels/common/validators/namevalidator.h +++ b/IPXACTmodels/common/validators/namevalidator.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT NameValidator : public QRegularExpressionValidator /*! * Constructor for the name validator. * - * @param [in] parent Owner of this validator. + * @param [in] parent Owner of this validator. */ explicit NameValidator(QObject* parent = 0); diff --git a/IPXACTmodels/generaldeclarations.h b/IPXACTmodels/generaldeclarations.h index b657e17b3..eacd40627 100644 --- a/IPXACTmodels/generaldeclarations.h +++ b/IPXACTmodels/generaldeclarations.h @@ -65,26 +65,26 @@ namespace General /*! * Check if the selected bus interface mode is compatible with IP-XACT revision 1685-2022. * - * @param [in] mode The selected bus interface mode. + * @param [in] mode The selected bus interface mode. * - * @return True, if the mode is compatible with revision 1685-2022, false otherwise. + * @return True, if the mode is compatible with revision 1685-2022, false otherwise. */ IPXACTMODELS_EXPORT bool modeIsRevision2022(General::InterfaceMode mode); /*! Convert QString into boolean value * - * @param [in] str QString containing the string to be converted - * @param [in] defaultValue InterfaceMode value that is returned if str is none of the defined values + * @param [in] str QString containing the string to be converted + * @param [in] defaultValue InterfaceMode value that is returned if str is none of the defined values * - * @return InterfaceMode matching the str or default value + * @return InterfaceMode matching the str or default value */ IPXACTMODELS_EXPORT InterfaceMode str2Interfacemode(const QString& str, InterfaceMode defaultValue); /*! Convert InterfaceMode to QString * - * @param [in] mode InterfaceMode value that is converted to QString + * @param [in] mode InterfaceMode value that is converted to QString * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString interfaceMode2Str(const General::InterfaceMode mode); @@ -96,9 +96,9 @@ namespace General /*! * Get the compatible active bus interface modes for the selected bus interface mode. * - * @param [in] mode The selected bus interface mode. + * @param [in] mode The selected bus interface mode. * - * @return List of compatible bus interface modes. + * @return List of compatible bus interface modes. */ IPXACTMODELS_EXPORT QVector getCompatibleInterfaceModesForActiveInterface( General::InterfaceMode mode); @@ -106,9 +106,9 @@ namespace General /*! * Get the compatible hierarchical bus interface modes for the selected bus interface mode. * - * @param [in] mode The selected bus interface mode. + * @param [in] mode The selected bus interface mode. * - * @return The connectible bus interface modes. + * @return The connectible bus interface modes. */ IPXACTMODELS_EXPORT QVector getCompatibleInterfaceModeForHierarchicalInterface( General::InterfaceMode mode); @@ -128,17 +128,17 @@ namespace General * if The str does not match any of the enum values the default value * specifies as parameter will be returned * - * @param [in] str QString containing the string to be converted - * @param [in] defaultValue The value that will be returned if no match is found - * @return General::DriverType that matches the str or default value. + * @param [in] str QString containing the string to be converted + * @param [in] defaultValue The value that will be returned if no match is found + * @return General::DriverType that matches the str or default value. */ IPXACTMODELS_EXPORT General::DriverType str2DriverType(QString str, General::DriverType defaultValue); /*! Convert the value of the DriverType into QString. * - * @param [in] type The DriverType to be converted. + * @param [in] type The DriverType to be converted. * - * @return QString matching the driver type. + * @return QString matching the driver type. */ IPXACTMODELS_EXPORT QString driverType2Str(General::DriverType type); @@ -159,17 +159,17 @@ namespace General * if The str does not match any of the enum values the default value * specifies as parameter will be returned * - * @param [in] str QString containing the string to be converted - * @param [in] defaultValue The value that will be returned if no match is found - * @return General::Usage that matches the str or default value. + * @param [in] str QString containing the string to be converted + * @param [in] defaultValue The value that will be returned if no match is found + * @return General::Usage that matches the str or default value. */ IPXACTMODELS_EXPORT General::Usage str2Usage(QString str, General::Usage defaultValue); /*! Convert the Usage value to QString * - * @param [in] usage Usage value to be converted to QString. + * @param [in] usage Usage value to be converted to QString. * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString usage2Str(const General::Usage usage); @@ -209,17 +209,17 @@ namespace General * If the string does not match any of the enum values then General::MODIFIED_WRITE_COUNT * is returned. * - * @param [in] str contains the string to be converted. + * @param [in] str contains the string to be converted. * - * @return The enum value that matches the string. + * @return The enum value that matches the string. */ IPXACTMODELS_EXPORT General::ModifiedWrite str2ModifiedWrite(const QString& str); /*! Convert the enum value to a matching string. * - * @param [in] modWrite The enum value to be converted to a string. + * @param [in] modWrite The enum value to be converted to a string. * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString modifiedWrite2Str(const General::ModifiedWrite modWrite); @@ -244,9 +244,9 @@ namespace General /*! Convert the enum value to a matching string. * - * @param [in] readAction The enum value to be converted to a string. + * @param [in] readAction The enum value to be converted to a string. * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString readAction2Str(const General::ReadAction readAction); @@ -255,9 +255,9 @@ namespace General * If the string does not match any of the defined enum values then * General::READ_ACTION_COUNT is returned. * - * @param [in] str Contains the string to be converted. + * @param [in] str Contains the string to be converted. * - * @return The enum value that matches the string. + * @return The enum value that matches the string. */ IPXACTMODELS_EXPORT General::ReadAction str2ReadAction(const QString& str); @@ -284,9 +284,9 @@ namespace General /*! Convert the enum value to a matching string. * - * @param [in] testConstraint The enum value to be converted to a string. + * @param [in] testConstraint The enum value to be converted to a string. * - * @return QString that matches the enum value. + * @return QString that matches the enum value. */ IPXACTMODELS_EXPORT QString testConstraint2Str(const General::TestConstraint testConstraint); @@ -295,9 +295,9 @@ namespace General * If the string does not match any of the defined enum values then * General::TESTCONSTRAINT_COUNT is returned. * - * @param [in] str Contains the string to be converted. + * @param [in] str Contains the string to be converted. * - * @return The enum value that matches the string. + * @return The enum value that matches the string. */ IPXACTMODELS_EXPORT General::TestConstraint str2TestConstraint(const QString& str); @@ -323,9 +323,9 @@ namespace General /*! The constructor * - * @param [in] portName The name of the port. - * @param [in] left The left bound of the port. - * @param [in] right The right bound of the port. + * @param [in] portName The name of the port. + * @param [in] left The left bound of the port. + * @param [in] right The right bound of the port. * */ PortBounds(const QString& portName, const int left = 0, const int right = 0); @@ -379,19 +379,19 @@ namespace General /*! Convert a boolean value into QString * - * @param [in] value The variable to convert into QString - * @return if value = true, returns "true" + * @param [in] value The variable to convert into QString + * @return if value = true, returns "true" * if value = false, returns "false" */ IPXACTMODELS_EXPORT QString bool2Str(bool value); /*! Convert QString into boolean value * - * @param [in] str QString containing the string to be converted - * @param [in] defaultValue boolean value that is returned if str is neither + * @param [in] str QString containing the string to be converted + * @param [in] defaultValue boolean value that is returned if str is neither * "true" or "false" * - * @return if str = "true" returns true + * @return if str = "true" returns true * if str = "false" returns false * if str is something else returns defaultValue */ @@ -411,8 +411,8 @@ namespace General /*! The constructor for the struct * - * @param [in] filePath the path of the file - * @param [in] libraryName Name of the library + * @param [in] filePath the path of the file + * @param [in] libraryName Name of the library */ LibraryFilePair(const QString filePath, const QString libraryName); @@ -421,24 +421,24 @@ namespace General /*! The == operator * - * @param [in] other The other LibaryFilePair to check + * @param [in] other The other LibaryFilePair to check * - * @return bool True if they have the same file path and library name. + * @return bool True if they have the same file path and library name. */ bool operator==(const LibraryFilePair& other) const; /*! The copy constructor * - * @param [in] other Reference to the LibraryFilePair to copy + * @param [in] other Reference to the LibraryFilePair to copy * */ LibraryFilePair(const LibraryFilePair& other) = default; /*! The assignment operator * - * @param [in] other Reference to the LibraryFilePair to assign + * @param [in] other Reference to the LibraryFilePair to assign * - * @return Reference to this LibraryFilePair. + * @return Reference to this LibraryFilePair. */ LibraryFilePair& operator=(const LibraryFilePair& other) = default; }; @@ -449,12 +449,12 @@ namespace General * file path from a directory to a single file. If either of the parameters * doesn't exist in the file system a null string is returned. * - * @param [in] from Path to the directory that is the base where the path is + * @param [in] from Path to the directory that is the base where the path is * generated to. - * @param [in] to The path to a file which is the target of the generated relative + * @param [in] to The path to a file which is the target of the generated relative * path. * - * @return QString containing the relative path. + * @return QString containing the relative path. */ IPXACTMODELS_EXPORT QString getRelativePath(QString from, QString to); @@ -464,12 +464,12 @@ namespace General * file path from a directory to a single file. This function can be used to get * relative path to a file that does not exist. The source file must exist. * - * @param [in] from Path to the directory that is the base where the path is + * @param [in] from Path to the directory that is the base where the path is * generated to. - * @param [in] to The path to a file which is the target of the generated relative + * @param [in] to The path to a file which is the target of the generated relative * path. * - * @return QString containing the relative path. + * @return QString containing the relative path. */ IPXACTMODELS_EXPORT QString getRelativeSavePath(const QString& from, const QString& to); @@ -481,11 +481,11 @@ namespace General * file but it is not found null string is returned. Original path may contain * a file path or only a directory path but only directory path is used. * - * @param [in] originalPath The absolute path that is used as base for relative path - * @param [in] relativePath The relative path that is used to find the file or + * @param [in] originalPath The absolute path that is used as base for relative path + * @param [in] relativePath The relative path that is used to find the file or * directory. * - * @return The absolute path of the target directory/file + * @return The absolute path of the target directory/file */ IPXACTMODELS_EXPORT QString getAbsolutePath(const QString& originalPath, const QString& relativePath); diff --git a/IPXACTmodels/kactusExtensions/ApiDefinition.h b/IPXACTmodels/kactusExtensions/ApiDefinition.h index ad7732652..39f79d34d 100644 --- a/IPXACTmodels/kactusExtensions/ApiDefinition.h +++ b/IPXACTmodels/kactusExtensions/ApiDefinition.h @@ -31,7 +31,7 @@ class IPXACTMODELS_EXPORT ApiDefinition : public Document /*! * Constructor which creates an empty API definition. * - * @param [in] vlnv The VLNV of the API definition. + * @param [in] vlnv The VLNV of the API definition. */ ApiDefinition(VLNV const& vlnv, Document::Revision revision); @@ -48,7 +48,7 @@ class IPXACTMODELS_EXPORT ApiDefinition : public Document /*! * Makes a copy of the document. * - * @return The created copy of the API definition. + * @return The created copy of the API definition. */ virtual QSharedPointer clone() const; @@ -65,35 +65,35 @@ class IPXACTMODELS_EXPORT ApiDefinition : public Document /*! * Sets the API programming language. * - * @param [in] language The name of the programming language. + * @param [in] language The name of the programming language. */ void setLanguage(QString const& language); /*! * Sets the COM definition reference. * - * @param [in] vlnv The VLNV of the COM definition to reference. + * @param [in] vlnv The VLNV of the COM definition to reference. */ void setComDefinitionRef(VLNV const& vlnv); /*! * Adds a new data type to the API definition. * - * @param [in] type The name of the data type to add. + * @param [in] type The name of the data type to add. */ void addDataType(QString const& type); /*! * Removes a data type from the API definition. * - * @param [in] type The name of the data type to remove. + * @param [in] type The name of the data type to remove. */ void removeDataType(QString const& type); /*! * Sets the API's data types. * - * @param [in] types A list of data type names. + * @param [in] types A list of data type names. */ void setDataTypes(QStringList const& types); diff --git a/IPXACTmodels/kactusExtensions/ApiDefinitionReader.h b/IPXACTmodels/kactusExtensions/ApiDefinitionReader.h index c7787923d..a0f4c939e 100644 --- a/IPXACTmodels/kactusExtensions/ApiDefinitionReader.h +++ b/IPXACTmodels/kactusExtensions/ApiDefinitionReader.h @@ -28,9 +28,9 @@ namespace ApiDefinitionReader /*! * Creates a Api definition from XML description. * - * @param [in] document The XML document to create the Api definition from. + * @param [in] document The XML document to create the Api definition from. * - * @return The created Api definition. + * @return The created Api definition. */ IPXACTMODELS_EXPORT QSharedPointer createApiDefinitionFrom(QDomNode const& document); @@ -41,14 +41,14 @@ namespace ApiDefinitionReader /*! * Parses all found data types from the given XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ void parseDataTypes(QDomNode& node, QSharedPointer apiDefinition); /*! * Parses all found API functions from the given XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ void parseFunctions(QDomNode& node, QSharedPointer apiDefinition); } diff --git a/IPXACTmodels/kactusExtensions/ApiDefinitionWriter.h b/IPXACTmodels/kactusExtensions/ApiDefinitionWriter.h index e9e426ec3..d2c7e87c0 100644 --- a/IPXACTmodels/kactusExtensions/ApiDefinitionWriter.h +++ b/IPXACTmodels/kactusExtensions/ApiDefinitionWriter.h @@ -28,8 +28,8 @@ namespace ApiDefinitionWriter /*! * Write a view to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] ApiDefinition The ApiDefinition to be written. + * @param [in] writer The used xml writer. + * @param [in] ApiDefinition The ApiDefinition to be written. */ IPXACTMODELS_EXPORT void writeApiDefinition(QXmlStreamWriter& writer, QSharedPointer apiDefinition); diff --git a/IPXACTmodels/kactusExtensions/ApiFunction.h b/IPXACTmodels/kactusExtensions/ApiFunction.h index 0583ead8a..92c9d2fd7 100644 --- a/IPXACTmodels/kactusExtensions/ApiFunction.h +++ b/IPXACTmodels/kactusExtensions/ApiFunction.h @@ -40,7 +40,7 @@ class IPXACTMODELS_EXPORT ApiFunction /*! * Constructor which reads the function from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ ApiFunction(QDomNode& node); @@ -52,15 +52,15 @@ class IPXACTMODELS_EXPORT ApiFunction /*! * Writes the contents to an XML stream. * - * @param [in] writer The XML stream writer. + * @param [in] writer The XML stream writer. */ void write(QXmlStreamWriter& writer); /*! * Returns true if the function contents are valid. * - * @param [out] errorList The list of errors found in the contents. - * @param [in] parentId The identifier of the containing API definition. + * @param [out] errorList The list of errors found in the contents. + * @param [in] parentId The identifier of the containing API definition. */ void findErrors(QVector& errorList, QString const& parentId) const; @@ -72,43 +72,43 @@ class IPXACTMODELS_EXPORT ApiFunction /*! * Sets the name of the function. * - * @param [in] name The name to set. + * @param [in] name The name to set. */ void setName(QString const& name); /*! * Sets the return value type. * - * @param [in] type The name of the return value type. + * @param [in] type The name of the return value type. */ void setReturnValueType(QString const& type); /*! * Sets the return value description. * - * @param [in] desc The return value description to set. + * @param [in] desc The return value description to set. */ void setReturnValueDescription(QString const& desc); /*! * Sets the function description. * - * @param [in] desc The description. + * @param [in] desc The description. */ void setDescription(QString const& desc); /*! * Adds a new parameter to the function. * - * @param [in] param The parameter object. - * @param [in] index The index of the parameter. If -1, the parameter is added as the last one. + * @param [in] param The parameter object. + * @param [in] index The index of the parameter. If -1, the parameter is added as the last one. */ void addParam(QSharedPointer param, int index = -1); /*! * Removes a parameter from the function. * - * @param [in] index The index of the parameter. + * @param [in] index The index of the parameter. */ void removeParam(int index); @@ -135,14 +135,14 @@ class IPXACTMODELS_EXPORT ApiFunction /*! * Returns the parameter at the given index. * - * @param [in] index The parameter index. + * @param [in] index The parameter index. */ QSharedPointer getParam(int index); /*! * Returns the parameter at the given index. * - * @param [in] index The parameter index. + * @param [in] index The parameter index. */ QSharedPointer getParam(int index) const; @@ -154,8 +154,8 @@ class IPXACTMODELS_EXPORT ApiFunction /*! * Generates a tooltip text for the function prototype. * - * @param [in] paramIndex The index of the parameter to highlight. - * @param [out] text The tool tip text. + * @param [in] paramIndex The index of the parameter to highlight. + * @param [out] text The tool tip text. */ void generateToolTipText(int paramIndex, QString& text) const; diff --git a/IPXACTmodels/kactusExtensions/ApiFunctionParameter.h b/IPXACTmodels/kactusExtensions/ApiFunctionParameter.h index 2723c7a2b..13bb58e25 100644 --- a/IPXACTmodels/kactusExtensions/ApiFunctionParameter.h +++ b/IPXACTmodels/kactusExtensions/ApiFunctionParameter.h @@ -39,7 +39,7 @@ class IPXACTMODELS_EXPORT ApiFunctionParameter /*! * Constructor which read the function parameter from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ ApiFunctionParameter(QDomNode& node); @@ -51,15 +51,15 @@ class IPXACTMODELS_EXPORT ApiFunctionParameter /*! * Writes the function parameter to an XML stream. * - * @param [in] writer The XML stream writer. + * @param [in] writer The XML stream writer. */ void write(QXmlStreamWriter& writer); /*! * Returns true if the function parameter is valid. * - * @param [out] errorList The list of errors found in the contents. - * @param [in] parentId The identifier of the containing API function. + * @param [out] errorList The list of errors found in the contents. + * @param [in] parentId The identifier of the containing API function. */ void findErrors(QVector& errorList, QString const& parentId) const; @@ -71,35 +71,35 @@ class IPXACTMODELS_EXPORT ApiFunctionParameter /*! * Sets the name of the parameter. * - * @param [in] name The name to set. + * @param [in] name The name to set. */ void setName(QString const& name); /*! * Sets the type of the parameter. * - * @param [in] type The type name to set. + * @param [in] type The type name to set. */ void setType(QString const& type); /*! * Sets the allowed COM transfer type. * - * @param [in] comTransferType The COM transfer type to set. + * @param [in] comTransferType The COM transfer type to set. */ void setComTransferType(QString const& comTransferType); /*! * Sets the allowed COM direction. * - * @param [in] comDirection The COM direction to set. + * @param [in] comDirection The COM direction to set. */ void setComDirection(DirectionTypes::Direction comDirection); /*! * Sets the COM content source. * - * @param [in] contentSource The name of the content source. + * @param [in] contentSource The name of the content source. * "name" = name of a COM interface, otherwise any name of a COM property */ void setContentSource(QString const& contentSource); @@ -107,14 +107,14 @@ class IPXACTMODELS_EXPORT ApiFunctionParameter /*! * Sets the dependent parameter index. * - * @param [in] index The dependent parameter index. -1 if not set. + * @param [in] index The dependent parameter index. -1 if not set. */ void setDependentParameterIndex(int index); /*! * Sets the parameter description. * - * @param [in] desc The description. + * @param [in] desc The description. */ void setDescription(QString const& desc); diff --git a/IPXACTmodels/kactusExtensions/ApiInterconnection.h b/IPXACTmodels/kactusExtensions/ApiInterconnection.h index 0fdbe9a9c..9b27f94ab 100644 --- a/IPXACTmodels/kactusExtensions/ApiInterconnection.h +++ b/IPXACTmodels/kactusExtensions/ApiInterconnection.h @@ -32,12 +32,12 @@ class IPXACTMODELS_EXPORT ApiInterconnection : public Interconnection, public Ve /*! * Constructor which sets all the values as given. * - * @param [in] name The name to set. - * @param [in] displayName The display name to set. - * @param [in] description The description to set. - * @param [in] ref1 The first interface reference. - * @param [in] ref2 The second interface reference. - * @param [in] imported If true, the connection is an imported one. + * @param [in] name The name to set. + * @param [in] displayName The display name to set. + * @param [in] description The description to set. + * @param [in] ref1 The first interface reference. + * @param [in] ref2 The second interface reference. + * @param [in] imported If true, the connection is an imported one. */ ApiInterconnection(QString const& name, QString const& displayName, QString const& description, QSharedPointer ref1, QSharedPointer ref2, @@ -51,7 +51,7 @@ class IPXACTMODELS_EXPORT ApiInterconnection : public Interconnection, public Ve /*! * QDomNode constructor. * - * @param [in] node The node containing the api interconnection. + * @param [in] node The node containing the api interconnection. */ ApiInterconnection(QDomNode& node); @@ -68,35 +68,35 @@ class IPXACTMODELS_EXPORT ApiInterconnection : public Interconnection, public Ve /*! * Gets the type of the extension. * - * @return The type of the extension. + * @return The type of the extension. */ virtual QString type() const; /*! * Writes the contents to an XML stream. * - * @param [in] writer The selected XML stream. + * @param [in] writer The selected XML stream. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Set an interface. First active interface is set as the start interface. * - * @param [in] interfaceReference The selected interface. + * @param [in] interfaceReference The selected interface. */ void setInterface(QSharedPointer interfaceReference); /*! * Sets the flag whether the connection is an imported one and should be auto-synced. * - * @param [in] imported If true, the connection is set as imported. + * @param [in] imported If true, the connection is set as imported. */ void setImported(bool imported); /*! * Get the end interface. * - * @return The end interface. + * @return The end interface. */ QSharedPointer getEndInterface() const; @@ -115,7 +115,7 @@ class IPXACTMODELS_EXPORT ApiInterconnection : public Interconnection, public Ve /*! * Write the end interface. * - * @param [in] writer The writer used to write. + * @param [in] writer The writer used to write. */ void writeEndInterface(QXmlStreamWriter& writer) const; diff --git a/IPXACTmodels/kactusExtensions/ApiInterface.h b/IPXACTmodels/kactusExtensions/ApiInterface.h index 3a6ebaaea..f416b3234 100644 --- a/IPXACTmodels/kactusExtensions/ApiInterface.h +++ b/IPXACTmodels/kactusExtensions/ApiInterface.h @@ -44,9 +44,9 @@ IPXACTMODELS_EXPORT DependencyDirection str2DependencyDirection(QString const& s /*! * Converts the enumeration value to an equivalent string. * - * @param [in] dir The dependency direction enum value. + * @param [in] dir The dependency direction enum value. * - * @return The equivalent string. + * @return The equivalent string. */ IPXACTMODELS_EXPORT QString dependencyDirection2Str(DependencyDirection dir); @@ -71,7 +71,7 @@ class IPXACTMODELS_EXPORT ApiInterface : public NameGroup, public VendorExtensio /*! * Constructor which reads the API interface from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ ApiInterface(QDomNode& node); @@ -83,14 +83,14 @@ class IPXACTMODELS_EXPORT ApiInterface : public NameGroup, public VendorExtensio /*! * Clones the api interface. * - * @return A cloned api interface. + * @return A cloned api interface. */ ApiInterface* clone() const final; /*! * Gets the api interface type. * - * @return The type of the api interface. + * @return The type of the api interface. */ QString type() const final; @@ -102,8 +102,8 @@ class IPXACTMODELS_EXPORT ApiInterface : public NameGroup, public VendorExtensio /*! * Returns true if the contents of the API interface are valid. * - * @param [out] errorList Error list which is appended with errors if found while validating. - * @param [in] parentId The identifier of the containing component. + * @param [out] errorList Error list which is appended with errors if found while validating. + * @param [in] parentId The identifier of the containing component. */ bool isValid(QStringList& errorList, QString const& parentId) const; @@ -115,21 +115,21 @@ class IPXACTMODELS_EXPORT ApiInterface : public NameGroup, public VendorExtensio /*! * Sets the API type. * - * @param [in] vlnv The API definition VLNV. + * @param [in] vlnv The API definition VLNV. */ void setApiType(VLNV const& vlnv); /*! * Sets the dependency direction. * - * @param [in] dir The dependency direction. + * @param [in] dir The dependency direction. */ void setDependencyDirection(DependencyDirection dir); /*! * Sets the default position in the parent component's graphical representation. * - * @param [in] pos The position to set. + * @param [in] pos The position to set. */ void setDefaultPos(QPointF const& pos); diff --git a/IPXACTmodels/kactusExtensions/ColumnDesc.h b/IPXACTmodels/kactusExtensions/ColumnDesc.h index 09a040a0e..0c2fdbb37 100644 --- a/IPXACTmodels/kactusExtensions/ColumnDesc.h +++ b/IPXACTmodels/kactusExtensions/ColumnDesc.h @@ -46,7 +46,7 @@ class IPXACTMODELS_EXPORT ColumnDesc : public VendorExtension /*! * Get the type of the extension. * - * @return The type of the extension. + * @return The type of the extension. */ virtual QString type() const; @@ -58,28 +58,28 @@ class IPXACTMODELS_EXPORT ColumnDesc : public VendorExtension /*! * Sets the name of the column. * - * @param [in] name The name of the column. + * @param [in] name The name of the column. */ void setName(QString const& name); /*! * Sets the content type. * - * @param [in] contentType The content type. + * @param [in] contentType The content type. */ void setContentType(ColumnTypes::ColumnContentType contentType); /*! * Sets the allowed items. * - * @param [in] allowedItems The allowed items as bit flags. + * @param [in] allowedItems The allowed items as bit flags. */ void setAllowedItems(unsigned int allowedItems); /*! * Sets the width of the column. * - * @param [in] width The width of the column. + * @param [in] width The width of the column. */ void setWidth(unsigned int width); diff --git a/IPXACTmodels/kactusExtensions/ComDefinition.h b/IPXACTmodels/kactusExtensions/ComDefinition.h index 8ef6c4e61..a9d21bd3c 100644 --- a/IPXACTmodels/kactusExtensions/ComDefinition.h +++ b/IPXACTmodels/kactusExtensions/ComDefinition.h @@ -27,7 +27,7 @@ class IPXACTMODELS_EXPORT ComDefinition : public Document /*! * Constructor which creates an empty communication definition. * - * @param [in] vlnv The VLNV of the communication definition. + * @param [in] vlnv The VLNV of the communication definition. */ ComDefinition(VLNV const& vlnv, Document::Revision revision); @@ -44,7 +44,7 @@ class IPXACTMODELS_EXPORT ComDefinition : public Document /*! * Makes a copy of the document. * - * @return The created copy of the COM definition. + * @return The created copy of the COM definition. */ virtual QSharedPointer clone() const; @@ -61,42 +61,42 @@ class IPXACTMODELS_EXPORT ComDefinition : public Document /*! * Adds a new transfer type to the communication definition. * - * @param [in] type The name of the transfer type to add. + * @param [in] type The name of the transfer type to add. */ void addTransferType(QString const& type); /*! * Removes a transfer type from the communication definition. * - * @param [in] type The name of the transfer type to remove. + * @param [in] type The name of the transfer type to remove. */ void removeTransferType(QString const& type); /*! * Sets the supported transfer types. * - * @param [in] types A list of transfer type names. + * @param [in] types A list of transfer type names. */ void setTransferTypes(QStringList const& types); /*! * Adds a property to the definition. * - * @param [in] prop The property to add. + * @param [in] prop The property to add. */ void addProperty(QSharedPointer prop); /*! * Removes a property from the definition. * - * @param [in] name The name of the property to remove. + * @param [in] name The name of the property to remove. */ void removeProperty(QString const& name); /*! * Sets the properties. * - * @param [in] properties A list of properties to set. + * @param [in] properties A list of properties to set. */ void setProperties(QList< QSharedPointer > const& properties); diff --git a/IPXACTmodels/kactusExtensions/ComDefinitionReader.h b/IPXACTmodels/kactusExtensions/ComDefinitionReader.h index 7a6164695..1cd3925fb 100644 --- a/IPXACTmodels/kactusExtensions/ComDefinitionReader.h +++ b/IPXACTmodels/kactusExtensions/ComDefinitionReader.h @@ -29,9 +29,9 @@ namespace ComDefinitionReader /*! * Creates a Com definition from XML description. * - * @param [in] document The XML document to create the Com definition from. + * @param [in] document The XML document to create the Com definition from. * - * @return The created Com definition. + * @return The created Com definition. */ IPXACTMODELS_EXPORT QSharedPointer createComDefinitionFrom(QDomNode const& document); @@ -40,14 +40,14 @@ namespace ComDefinitionReader /*! * Parses all found transfer types from the given XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ void parseTransferTypes(QDomNode const& node, QSharedPointer comDefinition); /*! * Parses all found properties from the given XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ void parseProperties(QDomNode const& node, QSharedPointer comDefinition); } diff --git a/IPXACTmodels/kactusExtensions/ComDefinitionWriter.h b/IPXACTmodels/kactusExtensions/ComDefinitionWriter.h index bc9a397be..c913e4b22 100644 --- a/IPXACTmodels/kactusExtensions/ComDefinitionWriter.h +++ b/IPXACTmodels/kactusExtensions/ComDefinitionWriter.h @@ -29,8 +29,8 @@ namespace ComDefinitionWriter /*! * Write a view to an XML file. * - * @param [in] writer The used xml writer. - * @param [in] ComDefinition The ComDefinition to be written. + * @param [in] writer The used xml writer. + * @param [in] ComDefinition The ComDefinition to be written. */ IPXACTMODELS_EXPORT void writeComDefinition(QXmlStreamWriter& writer, QSharedPointer ComDefinition); diff --git a/IPXACTmodels/kactusExtensions/ComInterconnection.h b/IPXACTmodels/kactusExtensions/ComInterconnection.h index 54877fa98..fa4dbface 100644 --- a/IPXACTmodels/kactusExtensions/ComInterconnection.h +++ b/IPXACTmodels/kactusExtensions/ComInterconnection.h @@ -32,11 +32,11 @@ class IPXACTMODELS_EXPORT ComInterconnection : public Interconnection, public Ve /*! * Constructor which sets all the values as given. * - * @param [in] name The name to set. - * @param [in] displayName The display name to set. - * @param [in] description The description to set. - * @param [in] ref1 A reference to the first COM interface. - * @param [in] ref2 A reference to the second COM interface. + * @param [in] name The name to set. + * @param [in] displayName The display name to set. + * @param [in] description The description to set. + * @param [in] ref1 A reference to the first COM interface. + * @param [in] ref2 A reference to the second COM interface. */ ComInterconnection(QString const& name, QString const& displayName, QString const& description, QSharedPointer ref1, QSharedPointer ref2); @@ -49,7 +49,7 @@ class IPXACTMODELS_EXPORT ComInterconnection : public Interconnection, public Ve /*! * QDomNode constructor. * - * @param [in] connectionNode The node containing the com connection. + * @param [in] connectionNode The node containing the com connection. */ ComInterconnection(QDomNode& connectionNode); @@ -66,7 +66,7 @@ class IPXACTMODELS_EXPORT ComInterconnection : public Interconnection, public Ve /*! * Gets the type of the extension. * - * @return The type of the extension. + * @return The type of the extension. */ virtual QString type() const; @@ -78,14 +78,14 @@ class IPXACTMODELS_EXPORT ComInterconnection : public Interconnection, public Ve /*! * Set an interface. First active interface is set as the start interface. * - * @param [in] interfaceReference The selected interface. + * @param [in] interfaceReference The selected interface. */ void setInterface(QSharedPointer interfaceReference); /*! * Returns the end interface. * - * @return Pointer to the end interface. + * @return Pointer to the end interface. */ QSharedPointer getEndInterface() const; @@ -94,7 +94,7 @@ class IPXACTMODELS_EXPORT ComInterconnection : public Interconnection, public Ve /*! * Write the end interface. * - * @param [in] writer The writer used to write the end interface. + * @param [in] writer The writer used to write the end interface. */ void writeEndInterface(QXmlStreamWriter& writer) const; }; diff --git a/IPXACTmodels/kactusExtensions/ComInterface.h b/IPXACTmodels/kactusExtensions/ComInterface.h index 2f99faf66..cfbbbdbab 100644 --- a/IPXACTmodels/kactusExtensions/ComInterface.h +++ b/IPXACTmodels/kactusExtensions/ComInterface.h @@ -51,7 +51,7 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Constructor which reads the COM interface from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ ComInterface(QDomNode& node); @@ -63,14 +63,14 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Copies the com interface. * - * @return The copied com interface. + * @return The copied com interface. */ virtual ComInterface* clone() const; /*! * Get the type of the com interface. * - * @return The com interface type. + * @return The com interface type. */ virtual QString type() const; @@ -82,8 +82,8 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Returns true if the contents of the COM interface are valid. * - * @param [out] errorList Error list which is appended with errors if found while validating. - * @param [in] parentId The identifier of the containing component. + * @param [out] errorList Error list which is appended with errors if found while validating. + * @param [in] parentId The identifier of the containing component. */ bool isValid(QStringList& errorList, QString const& parentId) const; @@ -95,35 +95,35 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Sets the COM type. * - * @param [in] vlnv The COM definition VLNV. + * @param [in] vlnv The COM definition VLNV. */ void setComType(VLNV const& vlnv, QList< QSharedPointer > const* properties = NULL); /*! * Sets the transfer type. * - * @param [in] transferType The transfer type to set. + * @param [in] transferType The transfer type to set. */ void setTransferType(QString const& transferType); /*! * Sets the direction. * - * @param [in] dir The direction. + * @param [in] dir The direction. */ void setDirection(DirectionTypes::Direction dir); /*! * Sets the property values. * - * @param [in] values The property values. + * @param [in] values The property values. */ void setPropertyValues(QMap const& values); /*! * Sets the default position in the parent component's graphical representation. * - * @param [in] pos The position to set. + * @param [in] pos The position to set. */ void setDefaultPos(QPointF const& pos); @@ -160,14 +160,14 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Get reference to the COM interface implementation driver. * - * @return VLNV identifying the implementation driver. + * @return VLNV identifying the implementation driver. */ const VLNV& getComImplementation() const; /*! * Set the COM interface implementation driver. * - * @param [in] implementationVLNV Reference to the driver which implements the COM interface. + * @param [in] implementationVLNV Reference to the driver which implements the COM interface. */ void setComImplementation(const VLNV& implementationVLNV); @@ -175,7 +175,7 @@ class IPXACTMODELS_EXPORT ComInterface : public NameGroup, public VendorExtensio /*! * Parses the property values from the given XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ void parsePropertyValues(QDomNode& node); diff --git a/IPXACTmodels/kactusExtensions/ComProperty.h b/IPXACTmodels/kactusExtensions/ComProperty.h index 14fcde064..3728be9ad 100644 --- a/IPXACTmodels/kactusExtensions/ComProperty.h +++ b/IPXACTmodels/kactusExtensions/ComProperty.h @@ -48,29 +48,29 @@ class IPXACTMODELS_EXPORT ComProperty : public VendorExtension /*! * Copy the com property. * - * @return The copied com property. + * @return The copied com property. */ virtual ComProperty* clone() const; /*! * Get the type of the com property extension. * - * @return The type of this extension. + * @return The type of this extension. */ virtual QString type() const; /*! * Writes the contents of the property to an XML stream. * - * @param [in] write The XML stream writer. + * @param [in] write The XML stream writer. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Returns true if the property contents are valid. * - * @param [out] errorList The list of errors found in the contents. - * @param [in] parentId The identifier of the containing COM definition. + * @param [out] errorList The list of errors found in the contents. + * @param [in] parentId The identifier of the containing COM definition. */ void findErrors(QVector& errorList, QString const& parentId) const; @@ -87,28 +87,28 @@ class IPXACTMODELS_EXPORT ComProperty : public VendorExtension /*! * Sets the property required/optional. * - * @param [in] required If true, the property is a required one; otherwise it is optional. + * @param [in] required If true, the property is a required one; otherwise it is optional. */ void setRequired(bool required); /*! * Sets the property type. * - * @param [in] type The property type as a string. + * @param [in] type The property type as a string. */ void setType(QString const& type); /*! * Sets the default value for the property. * - * @param [in] defaultValue The default value to set. + * @param [in] defaultValue The default value to set. */ void setDefaultValue(QString const& defaultValue); /*! * Sets the description of the property. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description); diff --git a/IPXACTmodels/kactusExtensions/ConnectionRoute.h b/IPXACTmodels/kactusExtensions/ConnectionRoute.h index d11299c1e..153e0ea44 100644 --- a/IPXACTmodels/kactusExtensions/ConnectionRoute.h +++ b/IPXACTmodels/kactusExtensions/ConnectionRoute.h @@ -39,70 +39,70 @@ class IPXACTMODELS_EXPORT ConnectionRoute : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual VendorExtension* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Sets the connection name. * - * @param [in] name The name of the connection. + * @param [in] name The name of the connection. */ void setName(QString const& name); /*! * Gets the name of the connection the route is stored for. * - * @return The name of the route represented by the item. + * @return The name of the route represented by the item. */ QString name() const; /*! * Sets the connection to offpage mode or normal mode. * - * @param [in] offpage Offpage mode to set. + * @param [in] offpage Offpage mode to set. */ void setOffpage(bool offpage); /*! * Checks if the connection is set for offpage mode. * - * @return True, if the connection is in offpage mode, otherwise false. + * @return True, if the connection is in offpage mode, otherwise false. */ bool isOffpage() const; /*! * Adds a route point in the connection. * - * @param [in] point The point to add. + * @param [in] point The point to add. */ void addPoint(QPointF const& point); /*! * Sets the route points for the connection. * - * @param [in] route The route points to set. + * @param [in] route The route points to set. */ void setRoute(QList const& route); /*! * Gets the route points for the connection. * - * @return The route points. + * @return The route points. */ QList getRoute() const; diff --git a/IPXACTmodels/kactusExtensions/FileDependency.h b/IPXACTmodels/kactusExtensions/FileDependency.h index f7d1436a0..14ad4387b 100644 --- a/IPXACTmodels/kactusExtensions/FileDependency.h +++ b/IPXACTmodels/kactusExtensions/FileDependency.h @@ -48,7 +48,7 @@ class IPXACTMODELS_EXPORT FileDependency : public VendorExtension /*! * Constructor which reads the file dependency from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ FileDependency(QDomNode const& node); @@ -60,21 +60,21 @@ class IPXACTMODELS_EXPORT FileDependency : public VendorExtension /*! * Clone the file dependency. * - * @return The cloned file dependency. + * @return The cloned file dependency. */ virtual FileDependency* clone() const; /*! * Get the type of this extension. * - * @return The type of this extension. + * @return The type of this extension. */ virtual QString type() const; /*! * Writes the contents of the file dependency to an XML stream. * - * @param [in] write The XML stream writer. + * @param [in] write The XML stream writer. */ virtual void write(QXmlStreamWriter& writer) const; @@ -86,35 +86,35 @@ class IPXACTMODELS_EXPORT FileDependency : public VendorExtension /*! * Sets the 'from' file. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. */ void setFile1(QString const& filename); /*! * Sets the 'to' file. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. */ void setFile2(QString const& filename); /*! * Sets the description. * - * @param [in] desc The description to set. + * @param [in] desc The description to set. */ void setDescription(QString const& desc); /*! * Sets the dependency locked/unlocked. * - * @param [in] locked If true, the dependency is set locked; false for unlocked. + * @param [in] locked If true, the dependency is set locked; false for unlocked. */ void setLocked(bool locked); /*! * Sets the dependency bidirectional. * - * @param [in] bidiretional If true, the dependency is set as bidirectional (two-way); + * @param [in] bidiretional If true, the dependency is set as bidirectional (two-way); * false for one-way dependency. */ void setBidirectional(bool bidirectional); @@ -122,7 +122,7 @@ class IPXACTMODELS_EXPORT FileDependency : public VendorExtension /*! * Sets the dependency manual. * - * @param [in] manual If true, the dependency is treated as a manual dependency; + * @param [in] manual If true, the dependency is treated as a manual dependency; * otherwise it is treated as an automatic (generated) one. */ void setManual(bool manual); @@ -130,7 +130,7 @@ class IPXACTMODELS_EXPORT FileDependency : public VendorExtension /*! * Sets the status of the dependency. * - * @param [in] status The status to set. + * @param [in] status The status to set. */ void setStatus(Status status); diff --git a/IPXACTmodels/kactusExtensions/HierApiInterconnection.h b/IPXACTmodels/kactusExtensions/HierApiInterconnection.h index c5aaf5a11..43f48f7ee 100644 --- a/IPXACTmodels/kactusExtensions/HierApiInterconnection.h +++ b/IPXACTmodels/kactusExtensions/HierApiInterconnection.h @@ -34,14 +34,14 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Constructor which sets all the values as given. * - * @param [in] name The name to set. - * @param [in] displayName The display name to set. - * @param [in] description The description to set. - * @param [in] interfaceRef Name reference to an API interface in the top-level component. - * @param [in] ref The interface reference to a contained SW component instance. - * @param [in] position The position of the top-level interface in the design diagram. - * @param [in] direction The direction of the top-level interface in the design diagram. - * @param [in] route The connection route. + * @param [in] name The name to set. + * @param [in] displayName The display name to set. + * @param [in] description The description to set. + * @param [in] interfaceRef Name reference to an API interface in the top-level component. + * @param [in] ref The interface reference to a contained SW component instance. + * @param [in] position The position of the top-level interface in the design diagram. + * @param [in] direction The direction of the top-level interface in the design diagram. + * @param [in] route The connection route. */ HierApiInterconnection(QString const& name, QString const& displayName, QString const& description, QString const& interfaceRef, @@ -57,7 +57,7 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * QDomNode constructor. * - * @param [in] connectionNode The node containing the connection. + * @param [in] connectionNode The node containing the connection. */ HierApiInterconnection(QDomNode& connectionNode); @@ -74,7 +74,7 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Get the type of the extension. * - * @return The type of the extension. + * @return The type of the extension. */ virtual QString type() const; @@ -105,28 +105,28 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Sets the top-level API interface reference. * - * @param [in] interfaceRef Name reference to an API interface in the top-level component. + * @param [in] interfaceRef Name reference to an API interface in the top-level component. */ void setTopInterfaceRef(QString const& interfaceRef); /*! * Sets the interface reference to an API interface in a contained SW component instance. * - * @param [in] ref The interface reference. + * @param [in] ref The interface reference. */ void setInterface(QSharedPointer ref); /*! * Returns the name reference to an API interface in the top-level component. * - * @return The name of the referenced API interface in the top-level component. + * @return The name of the referenced API interface in the top-level component. */ QString const& getTopInterfaceRef() const; /*! * Returns the interface reference to an API interface in a contained SW component instance. * - * @return The used interface. + * @return The used interface. */ QSharedPointer getInterface() const; @@ -143,14 +143,14 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Set the position of the interface. * - * @param [in] newPosition The new position for the interface. + * @param [in] newPosition The new position for the interface. */ void setPosition(QPointF const& newPosition); /*! * Set the direction of the interface. * - * @param [in] newDirection The new direction of the interface. + * @param [in] newDirection The new direction of the interface. */ void setDirection(QVector2D const& newDirection); @@ -162,14 +162,14 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Set a route for the connection. * - * @param [in] newRoute The new route. + * @param [in] newRoute The new route. */ void setRoute(QList newRoute); /*! * Get the route for the connection. * - * @return A list of positions determining the route. + * @return A list of positions determining the route. */ QList getRoute() const; @@ -178,14 +178,14 @@ class IPXACTMODELS_EXPORT HierApiInterconnection : public Interconnection, publi /*! * Writes the position of the hierarchical interface. * - * @param [in] writer The selected XML writer. + * @param [in] writer The selected XML writer. */ void writePosition(QXmlStreamWriter& writer) const; /*! * Writes the direction of the hierarchical interface. * - * @param [in] writer [Description]. + * @param [in] writer [Description]. */ void writeVectorDirection(QXmlStreamWriter& writer) const; diff --git a/IPXACTmodels/kactusExtensions/HierComInterconnection.h b/IPXACTmodels/kactusExtensions/HierComInterconnection.h index a1a035092..aafd55af3 100644 --- a/IPXACTmodels/kactusExtensions/HierComInterconnection.h +++ b/IPXACTmodels/kactusExtensions/HierComInterconnection.h @@ -33,14 +33,14 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Constructor which sets all the values as given. * - * @param [in] name The name to set. - * @param [in] displayName The display name to set. - * @param [in] description The description to set. - * @param [in] interfaceRef Name reference to an COM interface in the top-level component. - * @param [in] ref The interface reference to a contained SW component instance. - * @param [in] position The position of the top-level interface in the design diagram. - * @param [in] direction The direction of the top-level interface in the design diagram. - * @param [in] route The connection route. + * @param [in] name The name to set. + * @param [in] displayName The display name to set. + * @param [in] description The description to set. + * @param [in] interfaceRef Name reference to an COM interface in the top-level component. + * @param [in] ref The interface reference to a contained SW component instance. + * @param [in] position The position of the top-level interface in the design diagram. + * @param [in] direction The direction of the top-level interface in the design diagram. + * @param [in] route The connection route. */ HierComInterconnection(QString const& name, QString const& displayName, QString const& description, QString const& interfaceRef, @@ -56,7 +56,7 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * The QDomNode constructor. * - * @param [in] connectionNode The node containing the hierarchical com connection. + * @param [in] connectionNode The node containing the hierarchical com connection. */ HierComInterconnection(QDomNode& connectionNode); @@ -73,7 +73,7 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Get the type of the extension. * - * @return The type of the extension. + * @return The type of the extension. */ virtual QString type() const; @@ -104,14 +104,14 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Sets the top-level COM interface reference. * - * @param [in] interfaceRef Name reference to an COM interface in the top-level component. + * @param [in] interfaceRef Name reference to an COM interface in the top-level component. */ void setTopInterfaceRef(QString const& interfaceRef); /*! * Sets the interface reference to an COM interface in a contained SW component instance. * - * @param [in] ref The interface reference. + * @param [in] ref The interface reference. */ void setInterface(QSharedPointer ref); @@ -138,14 +138,14 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Set the position of the interface. * - * @param [in] newPosition The new position for the interface. + * @param [in] newPosition The new position for the interface. */ void setPosition(QPointF const& newPosition); /*! * Set the direction of the interface. * - * @param [in] newDirection The new direction for the interface. + * @param [in] newDirection The new direction for the interface. */ void setDirection(QVector2D const& newDirection); @@ -157,14 +157,14 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Set a route for the connection. * - * @param [in] newRoute The new route. + * @param [in] newRoute The new route. */ void setRoute(QList newRoute); /*! * Get the route for the connection. * - * @return A list of positions determining the route. + * @return A list of positions determining the route. */ QList getRoute() const; @@ -173,14 +173,14 @@ class IPXACTMODELS_EXPORT HierComInterconnection: public Interconnection, public /*! * Write the position of the hierarchical com interface. * - * @param [in] xmlWriter The used XML writer. + * @param [in] xmlWriter The used XML writer. */ void writePosition(QXmlStreamWriter& xmlWriter) const; /*! * Write the direction of the hierarchical com interface. * - * @param [in] xmlWriter The used XML writer. + * @param [in] xmlWriter The used XML writer. */ void writeVectorDirection(QXmlStreamWriter& xmlWriter) const; diff --git a/IPXACTmodels/kactusExtensions/InterfaceGraphicsData.h b/IPXACTmodels/kactusExtensions/InterfaceGraphicsData.h index 22ff75b1f..da9ae255f 100644 --- a/IPXACTmodels/kactusExtensions/InterfaceGraphicsData.h +++ b/IPXACTmodels/kactusExtensions/InterfaceGraphicsData.h @@ -35,9 +35,9 @@ class IPXACTMODELS_EXPORT InterfaceGraphicsData : public VendorExtension /*! * The constructor. * - * @param [in] name Name of the interface. - * @param [in] position Position of the interface. - * @param [in] direction Direction of the interface. + * @param [in] name Name of the interface. + * @param [in] position Position of the interface. + * @param [in] direction Direction of the interface. */ InterfaceGraphicsData(QString const& name, QPointF position = QPointF(), QVector2D direction = QVector2D()); @@ -49,7 +49,7 @@ class IPXACTMODELS_EXPORT InterfaceGraphicsData : public VendorExtension /*! * Constructor which reads the interface graphics data from an XML node. * - * @param [in] node The source XML node. + * @param [in] node The source XML node. */ InterfaceGraphicsData(QDomNode& node); @@ -61,7 +61,7 @@ class IPXACTMODELS_EXPORT InterfaceGraphicsData : public VendorExtension /*! * Clones the interface graphics data. * - * @return Cloned interface graphics data. + * @return Cloned interface graphics data. */ virtual InterfaceGraphicsData* clone() const; @@ -73,7 +73,7 @@ class IPXACTMODELS_EXPORT InterfaceGraphicsData : public VendorExtension /*! * Gets the interface graphics data type. * - * @return The type of the interface graphics data. + * @return The type of the interface graphics data. */ virtual QString type() const; @@ -85,56 +85,56 @@ class IPXACTMODELS_EXPORT InterfaceGraphicsData : public VendorExtension /*! * Set a name. * - * @param [in] newName The new name. + * @param [in] newName The new name. */ void setName(QString const& newName); /*! * Get the name. * - * @return The name of the interface. + * @return The name of the interface. */ QString getName() const; /*! * Set the position for the interface. * - * @param [in] newPosition The new position. + * @param [in] newPosition The new position. */ void setPosition(QPointF const& newPosition); /*! * Get the position. * - * @return The position of the interface. + * @return The position of the interface. */ QPointF getPosition() const; /*! * Check if the interface has been given a position. * - * @return True, if the interface has a position, false otherwise. + * @return True, if the interface has a position, false otherwise. */ bool hasPosition() const; /*! * Set a direction for the interface. * - * @param [in] newDirection The new interface direction. + * @param [in] newDirection The new interface direction. */ void setDirection(QVector2D const& newDirection); /*! * Get the direction of the interface. * - * @return The direction of the interface. + * @return The direction of the interface. */ QVector2D getDirection() const; /*! * Check if the interface has been given a direction. * - * @return True, if the interface has been given a direction, otherwise false. + * @return True, if the interface has been given a direction, otherwise false. */ bool hasDirection() const; diff --git a/IPXACTmodels/kactusExtensions/Kactus2Group.h b/IPXACTmodels/kactusExtensions/Kactus2Group.h index e5f3d429d..7ba985e62 100644 --- a/IPXACTmodels/kactusExtensions/Kactus2Group.h +++ b/IPXACTmodels/kactusExtensions/Kactus2Group.h @@ -26,7 +26,7 @@ class IPXACTMODELS_EXPORT Kactus2Group : public VendorExtension /*! * The constructor. * - * @param [in] name The name of the placeholder. + * @param [in] name The name of the placeholder. */ Kactus2Group(QString name); @@ -41,44 +41,44 @@ class IPXACTMODELS_EXPORT Kactus2Group : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual Kactus2Group* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Adds a vendor extension to the group. * - * @param [in] extension The extension to add. + * @param [in] extension The extension to add. */ void addToGroup(QSharedPointer extension); /*! * Removes a vendor extension from the group. * - * @param [in] extension The extension to remove. + * @param [in] extension The extension to remove. */ void removeFromGroup(QSharedPointer extension); /*! * Gets all the extensions with the given type. * - * @param [in] type The type to search for. + * @param [in] type The type to search for. * - * @return The vendor extensions with the given type. + * @return The vendor extensions with the given type. */ QList > getByType(QString const& type) const; diff --git a/IPXACTmodels/kactusExtensions/Kactus2Placeholder.h b/IPXACTmodels/kactusExtensions/Kactus2Placeholder.h index d1dab5212..6c228fe23 100644 --- a/IPXACTmodels/kactusExtensions/Kactus2Placeholder.h +++ b/IPXACTmodels/kactusExtensions/Kactus2Placeholder.h @@ -26,7 +26,7 @@ class IPXACTMODELS_EXPORT Kactus2Placeholder : public VendorExtension /*! * The constructor. * - * @param [in] name The name of the placeholder. + * @param [in] name The name of the placeholder. */ Kactus2Placeholder(QString name); @@ -41,38 +41,38 @@ class IPXACTMODELS_EXPORT Kactus2Placeholder : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual Kactus2Placeholder* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Sets a value of an attribute. If the attribute does not exist, it is created. * - * @param [in] attributeName The name of the attribute. - * @param [in] attributeValue The value to set. + * @param [in] attributeName The name of the attribute. + * @param [in] attributeValue The value to set. */ void setAttribute(QString const& attributeName, QString const& attributeValue); /*! * Gets the value of a given attribute. * - * @param [in] attributeName The name of the attribute whose value to get. + * @param [in] attributeName The name of the attribute whose value to get. * - * @return The value of the attribute or empty string if the given attribute is not found. + * @return The value of the attribute or empty string if the given attribute is not found. */ QString getAttributeValue(QString const& attributeName); diff --git a/IPXACTmodels/kactusExtensions/Kactus2Position.h b/IPXACTmodels/kactusExtensions/Kactus2Position.h index d7f066ecc..fa39dea17 100644 --- a/IPXACTmodels/kactusExtensions/Kactus2Position.h +++ b/IPXACTmodels/kactusExtensions/Kactus2Position.h @@ -27,7 +27,7 @@ class IPXACTMODELS_EXPORT Kactus2Position : public VendorExtension /*! * The constructor. * - * @param [in] position The initial position of represented by the extension. + * @param [in] position The initial position of represented by the extension. */ Kactus2Position(QPointF position); @@ -45,21 +45,21 @@ class IPXACTMODELS_EXPORT Kactus2Position : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual Kactus2Position* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; @@ -68,14 +68,14 @@ class IPXACTMODELS_EXPORT Kactus2Position : public VendorExtension /*! * Gets the position. * - * @return The position represented by the extension. + * @return The position represented by the extension. */ QPointF position() const; /*! * Sets the position. * - * @param [in] pos The position to set. + * @param [in] pos The position to set. */ void setPosition(QPointF const& pos); diff --git a/IPXACTmodels/kactusExtensions/Kactus2Value.h b/IPXACTmodels/kactusExtensions/Kactus2Value.h index 9703ca20c..76187eaa0 100644 --- a/IPXACTmodels/kactusExtensions/Kactus2Value.h +++ b/IPXACTmodels/kactusExtensions/Kactus2Value.h @@ -25,8 +25,8 @@ class IPXACTMODELS_EXPORT Kactus2Value : public VendorExtension /*! * The constructor. * - * @param [in] name Corresponds name of XML element. - * @param [in] value Corresponds the value of XML element. + * @param [in] name Corresponds name of XML element. + * @param [in] value Corresponds the value of XML element. */ Kactus2Value(QString name, QString value); @@ -38,35 +38,35 @@ class IPXACTMODELS_EXPORT Kactus2Value : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual Kactus2Value* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Gets the value of the vendor extension. * - * @return The stored value. + * @return The stored value. */ QString value() const; /*! * Sets the value of the vendor extension. * - * @param [in] newValue The value to set. + * @param [in] newValue The value to set. */ void setValue(QString const& newValue); diff --git a/IPXACTmodels/kactusExtensions/KactusAttribute.h b/IPXACTmodels/kactusExtensions/KactusAttribute.h index 9d104a2d9..d95545963 100644 --- a/IPXACTmodels/kactusExtensions/KactusAttribute.h +++ b/IPXACTmodels/kactusExtensions/KactusAttribute.h @@ -68,117 +68,117 @@ class IPXACTMODELS_EXPORT KactusAttribute : public VendorExtension /*! * Clones the vendor extension. * - * @return The clone copy of the vendor extension. + * @return The clone copy of the vendor extension. */ virtual VendorExtension* clone() const; /*! * Returns a type identifier for the vendor extension. * - * @return A type identifier of the vendor extension. + * @return A type identifier of the vendor extension. */ virtual QString type() const; /*! * Writes the vendor extension to XML. * - * @param [in] writer The writer used for writing the XML. + * @param [in] writer The writer used for writing the XML. */ virtual void write(QXmlStreamWriter& writer) const; /*! * Sets the product hierarchy in the attributes. * - * @param [in] hierarchy The hierarchy level to set. + * @param [in] hierarchy The hierarchy level to set. */ void setHierarchy(KactusAttribute::ProductHierarchy hierarchy); /*! * Gets the product hierarchy in the attributes. * - * @return The product hierarchy. + * @return The product hierarchy. */ KactusAttribute::ProductHierarchy getHierarchy() const; /*! * Sets the product implementation in the attributes. * - * @param [in] implementation The implementation type to set. + * @param [in] implementation The implementation type to set. */ void setImplementation(KactusAttribute::Implementation implementation); /*! * Gets the product implementation in the attributes. * - * @return The implementation. + * @return The implementation. */ KactusAttribute::Implementation getImplementation() const; /*! * Sets the product firmness in the attributes. * - * @param [in] firmness The firmness to set. + * @param [in] firmness The firmness to set. */ void setFirmness(KactusAttribute::Firmness firmness); /*! * Gets the product firmness in the attributes. * - * @return The firmness. + * @return The firmness. */ KactusAttribute::Firmness getFirmness() const; /*! * Converts the given string to a product hierarchy. * - * @param [in] string The string to convert. + * @param [in] string The string to convert. * - * @return The equivalent hierarchy level. + * @return The equivalent hierarchy level. */ static ProductHierarchy hierarchyFrom(QString const& string); /*! * Converts the given string to a product implementation. * - * @param [in] string The string to convert. + * @param [in] string The string to convert. * - * @return The equivalent implementation type. + * @return The equivalent implementation type. */ static Implementation implementationFrom(QString const& string); /*! * Converts the given string to a firmness type. * - * @param [in] string The string to convert. + * @param [in] string The string to convert. * - * @return The equivalent firmness type. + * @return The equivalent firmness type. */ static Firmness firmnessFrom(QString const& string); /*! * Converts the given product hierarchy to a string. * - * @param [in] prodHier The product hierarchy. + * @param [in] prodHier The product hierarchy. * - * @return The equivalent string. + * @return The equivalent string. */ static QString hierarchyToString(ProductHierarchy prodHier); /*! * Converts the given firmness to a string. * - * @param [in] firmness specifies the firmness. + * @param [in] firmness specifies the firmness. * - * @return The equivalent string. + * @return The equivalent string. */ static QString firmnessToString(Firmness firmness); /*! * Converts the given firmness to a string. * - * @param [in] firmness The firmness. + * @param [in] firmness The firmness. * - * @return The equivalent string. + * @return The equivalent string. */ static QString implementationToString(Implementation implementation); diff --git a/IPXACTmodels/kactusExtensions/SystemView.h b/IPXACTmodels/kactusExtensions/SystemView.h index 73d58f7e1..2726186d8 100644 --- a/IPXACTmodels/kactusExtensions/SystemView.h +++ b/IPXACTmodels/kactusExtensions/SystemView.h @@ -32,14 +32,14 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension /*! * Constructor. * - * @param [in] viewNode A reference to a QDomNode to parse the information from. + * @param [in] viewNode A reference to a QDomNode to parse the information from. */ SystemView(QDomNode &viewNode); /*! * The constructor * - * @param [in] name The name of the view. + * @param [in] name The name of the view. */ SystemView(QString const& name = QString()); @@ -58,14 +58,14 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension /*! * Clone this system view. * - * @return The cloned system view. + * @return The cloned system view. */ virtual SystemView* clone() const; /*! * Get the type of this extension. * - * @return The type of this extension. + * @return The type of this extension. */ virtual QString type() const; @@ -74,7 +74,7 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension * * Uses the specified writer to write the class contents into file as valid IP-Xact. * - * @param [in] writer A QXmlStreamWriter instance that is used to write the document into file. + * @param [in] writer A QXmlStreamWriter instance that is used to write the document into file. */ virtual void write(QXmlStreamWriter& writer) const; @@ -83,10 +83,10 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension * * @param [in] fileSetNames File set names of the containing component. * @param [in] HWViewNames Names of the HW views in the containing component. - * @param [in] errorList The list to add the possible error messages to. - * @param [in] parentIdentifier String from parent to help to identify the location of the error. + * @param [in] errorList The list to add the possible error messages to. + * @param [in] parentIdentifier String from parent to help to identify the location of the error. * - * @return True if contents are valid. + * @return True if contents are valid. */ bool isValid(QStringList const& fileSetNames, QStringList const& HWViewNames, QVector& errorList, QString const& parentIdentifier) const; @@ -97,28 +97,28 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension * @param [in] fileSetNames File set names of the containing component. * @param [in] HWViewNames Names of the HW views in the containing component. * - * @return True if contents are valid. + * @return True if contents are valid. */ bool isValid(QStringList const& fileSetNames, QStringList const& HWViewNames) const; /*! * Set the hierarchyRef for this view. * - * @param [in] hierarchyRef The new hierarchyRef. + * @param [in] hierarchyRef The new hierarchyRef. */ void setHierarchyRef(VLNV const& hierarchyRef); /*! * Sets the reference to HW view to which the system is mapped. * - * @param [in] viewName The name of the HW view. + * @param [in] viewName The name of the HW view. */ void setHWViewRef(QString const& viewName); /*! * Get pointer to the hierarchical design for this view. * - * @return The vlnv of a hierarchical design if the view is used to reference a hierarchical design. + * @return The vlnv of a hierarchical design if the view is used to reference a hierarchical design. */ VLNV getHierarchyRef() const; @@ -130,14 +130,14 @@ class IPXACTMODELS_EXPORT SystemView : public NameGroup, public VendorExtension /*! * Get the file set references of the system view. * - * @return QStringList containing the file set names. + * @return QStringList containing the file set names. */ QStringList getFileSetRefs() const; /*! * Set the file set references for the system view. * - * @param [in] fileSetRefs Contains the file set names. + * @param [in] fileSetRefs Contains the file set names. */ void setFileSetRefs(QStringList const& fileSetRefs); diff --git a/IPXACTmodels/kactusExtensions/validators/ApiDefinitionValidator.h b/IPXACTmodels/kactusExtensions/validators/ApiDefinitionValidator.h index 1347a25fa..28f56b68d 100644 --- a/IPXACTmodels/kactusExtensions/validators/ApiDefinitionValidator.h +++ b/IPXACTmodels/kactusExtensions/validators/ApiDefinitionValidator.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT ApiDefinitionValidator /*! * The constructor. * - * @param [in] expressionParser The expression parser to use. + * @param [in] expressionParser The expression parser to use. */ ApiDefinitionValidator(); @@ -40,17 +40,17 @@ class IPXACTMODELS_EXPORT ApiDefinitionValidator /*! * Validates the given ApiDefinition. * - * @param [in] ApiDefinition The ApiDefinition to validate. + * @param [in] ApiDefinition The ApiDefinition to validate. * - * @return True, if the ApiDefinition is valid IP-XACT, otherwise false. + * @return True, if the ApiDefinition is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer apiDefinition) const; /*! * Finds possible errors in a ApiDefinition and creates a list of them. * - * @param [out] errors List of found errors. - * @param [in] ApiDefinition The ApiDefinition whose errors to find. + * @param [out] errors List of found errors. + * @param [in] ApiDefinition The ApiDefinition whose errors to find. */ virtual void findErrorsIn(QVector& errorList, QSharedPointer apiDefinition) const; diff --git a/IPXACTmodels/kactusExtensions/validators/ComDefinitionValidator.h b/IPXACTmodels/kactusExtensions/validators/ComDefinitionValidator.h index 7bcec1b05..a7d5430e0 100644 --- a/IPXACTmodels/kactusExtensions/validators/ComDefinitionValidator.h +++ b/IPXACTmodels/kactusExtensions/validators/ComDefinitionValidator.h @@ -30,7 +30,7 @@ class IPXACTMODELS_EXPORT ComDefinitionValidator /*! * The constructor. * - * @param [in] expressionParser The expression parser to use. + * @param [in] expressionParser The expression parser to use. */ ComDefinitionValidator(); @@ -40,17 +40,17 @@ class IPXACTMODELS_EXPORT ComDefinitionValidator /*! * Validates the given ComDefinition. * - * @param [in] ComDefinition The ComDefinition to validate. + * @param [in] ComDefinition The ComDefinition to validate. * - * @return True, if the ComDefinition is valid IP-XACT, otherwise false. + * @return True, if the ComDefinition is valid IP-XACT, otherwise false. */ virtual bool validate(QSharedPointer comDefinition) const; /*! * Finds possible errors in a ComDefinition and creates a list of them. * - * @param [out] errors List of found errors. - * @param [in] ComDefinition The ComDefinition whose errors to find. + * @param [out] errors List of found errors. + * @param [in] ComDefinition The ComDefinition whose errors to find. */ virtual void findErrorsIn(QVector& errorList, QSharedPointer comDefinition) const; diff --git a/IPXACTmodels/kactusExtensions/validators/SystemDesignConfigurationValidator.h b/IPXACTmodels/kactusExtensions/validators/SystemDesignConfigurationValidator.h index 747d5993c..288fa2cb9 100644 --- a/IPXACTmodels/kactusExtensions/validators/SystemDesignConfigurationValidator.h +++ b/IPXACTmodels/kactusExtensions/validators/SystemDesignConfigurationValidator.h @@ -40,8 +40,8 @@ class IPXACTMODELS_EXPORT SystemDesignConfigurationValidator : public DesignConf /*! * The constructor. * - * @param [in] parser The used expression parser. - * @param [in] library The used library interface. + * @param [in] parser The used expression parser. + * @param [in] library The used library interface. */ SystemDesignConfigurationValidator(QSharedPointer parser, LibraryInterface* library); @@ -51,9 +51,9 @@ class IPXACTMODELS_EXPORT SystemDesignConfigurationValidator : public DesignConf /*! * Check if the view configurations are valid. * - * @param [in] designConfiguration The selected design configuration. + * @param [in] designConfiguration The selected design configuration. * - * @return True, if the view configurations are valid, otherwise false. + * @return True, if the view configurations are valid, otherwise false. */ virtual bool hasValidViewConfigurations(QSharedPointer designConfiguration) const; @@ -66,8 +66,8 @@ class IPXACTMODELS_EXPORT SystemDesignConfigurationValidator : public DesignConf /*! * Check if the view configuration references a hw component instances. * - * @param [in] viewConfiguration The view configuration to check. - * @param [in] hwInstances The currently available hw component instances. + * @param [in] viewConfiguration The view configuration to check. + * @param [in] hwInstances The currently available hw component instances. */ bool viewConfigurationReferencesHWInstance(QSharedPointer viewConfiguration, QSharedPointer > > hwInstances) const; @@ -75,9 +75,9 @@ class IPXACTMODELS_EXPORT SystemDesignConfigurationValidator : public DesignConf /*! * Find errors in view configurations. * - * @param [in] errors List of found errors. - * @param [in] designConfiguration The selected design configuration. - * @param [in] context Context to help locate the errors. + * @param [in] errors List of found errors. + * @param [in] designConfiguration The selected design configuration. + * @param [in] context Context to help locate the errors. */ virtual void findErrorsInViewConfigurations(QVector& errors, QSharedPointer designConfiguration, QString const& context) const; diff --git a/IPXACTmodels/kactusExtensions/validators/SystemViewConfigurationValidator.h b/IPXACTmodels/kactusExtensions/validators/SystemViewConfigurationValidator.h index dcc3545c5..0a1d9b557 100644 --- a/IPXACTmodels/kactusExtensions/validators/SystemViewConfigurationValidator.h +++ b/IPXACTmodels/kactusExtensions/validators/SystemViewConfigurationValidator.h @@ -36,8 +36,8 @@ class IPXACTMODELS_EXPORT SystemViewConfigurationValidator: public ViewConfigura /*! * The constructor. * - * @param [in] library The used library interface. - * @param [in] parser The used expression parser. + * @param [in] library The used library interface. + * @param [in] parser The used expression parser. */ SystemViewConfigurationValidator(LibraryInterface* library, QSharedPointer parser); @@ -47,9 +47,9 @@ class IPXACTMODELS_EXPORT SystemViewConfigurationValidator: public ViewConfigura /*! * Check if the view reference is valid. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. * - * @return True, if the view reference is valid, otherwise false. + * @return True, if the view reference is valid, otherwise false. */ virtual bool hasValidViewReference(QSharedPointer configuration); @@ -62,7 +62,7 @@ class IPXACTMODELS_EXPORT SystemViewConfigurationValidator: public ViewConfigura /*! * Change the currently available views. * - * @param [in] configuration The selected view configuration. + * @param [in] configuration The selected view configuration. */ void changeAvailableSystemViews(QSharedPointer configuration); diff --git a/IPXACTmodels/utilities/BusDefinitionUtils.h b/IPXACTmodels/utilities/BusDefinitionUtils.h index 4e28141ce..7cd040642 100644 --- a/IPXACTmodels/utilities/BusDefinitionUtils.h +++ b/IPXACTmodels/utilities/BusDefinitionUtils.h @@ -30,10 +30,10 @@ namespace BusDefinitionUtils /*! * Get a list of the system groups from the selected bus definition. * - * @param [in] bus The selected bus definition. - * @param [in] libraryAccess Interface to the library. + * @param [in] bus The selected bus definition. + * @param [in] libraryAccess Interface to the library. * - * @return List of bus definition system groups. + * @return List of bus definition system groups. */ IPXACTMODELS_EXPORT QStringList getSystemGroups(QSharedPointer bus, LibraryInterface* libraryAccess); @@ -41,10 +41,10 @@ namespace BusDefinitionUtils /*! * Get a list of the extended port abstractions of the selected abstraction definition. * - * @param [in] abstraction The selected abstraction definition. - * @param [in] libraryAccess Interface to the library. + * @param [in] abstraction The selected abstraction definition. + * @param [in] libraryAccess Interface to the library. * - * @return List of extended port abstractions. + * @return List of extended port abstractions. */ IPXACTMODELS_EXPORT QList > getExtendedLogicalSignals( QSharedPointer abstraction, LibraryInterface* libraryAccess); diff --git a/KactusAPI/KactusAPI.h b/KactusAPI/KactusAPI.h index d3579735c..096511aa7 100644 --- a/KactusAPI/KactusAPI.h +++ b/KactusAPI/KactusAPI.h @@ -47,43 +47,43 @@ class KACTUS2_API KactusAPI /*! * Get the active IP-XACT library manager in the core. * - * @return The active IP-XACT library manager. + * @return The active IP-XACT library manager. */ static LibraryInterface* getLibrary(); /*! * Get the channel for output and error messages. * - * @return The channel for messages. + * @return The channel for messages. */ static MessageMediator* getMessageChannel(); /*! * Get the Kactus2 version. * - * @return The current Kactus2 version. + * @return The current Kactus2 version. */ static QString getVersion(); /*! * Get the version number. * - * @return The current version number. + * @return The current version number. */ static QString getVersionFileString(); /*! * Gets the paths where IP-XACT files are stored. * - * @return The paths where IP-XACT files are stored. + * @return The paths where IP-XACT files are stored. */ static QStringList getLibraryPaths(); /*! * Set the paths where IP-XACT files are stored. * - * @param [in] activeLocations The locations that are currently available to store the files. - * @param [in] allLocations All the locations available, but not all need to be active. + * @param [in] activeLocations The locations that are currently available to store the files. + * @param [in] allLocations All the locations available, but not all need to be active. */ static void setLibraryPaths(QStringList const& activeLocations, QStringList const& allLocations = QStringList() ); @@ -91,37 +91,37 @@ class KACTUS2_API KactusAPI /*! * Get the default library path for IP-XACT files. * - * @return The default path for IP-XACT files. + * @return The default path for IP-XACT files. */ static QString getDefaultLibraryPath(); /*! * Set the default library path for IP-XACT files. * - * @param [in] path The default path to set for IP-XACT files. + * @param [in] path The default path to set for IP-XACT files. */ static void setDefaultLibraryPath(QString const& path); /*! * Import a source file (RTL) into the library as a component. * - * @param [in] filePath The path to the file to import. - * @param [in] targetVLNV The VLNV to use for the imported component. - * @param [in] overwrite Overwrite the component in the library, if it already exists. + * @param [in] filePath The path to the file to import. + * @param [in] targetVLNV The VLNV to use for the imported component. + * @param [in] overwrite Overwrite the component in the library, if it already exists. * - * @return The number of imported IP-XACT documents. + * @return The number of imported IP-XACT documents. */ static int importFile(QString const& filePath, VLNV const& targetVLNV, bool overwrite); /*! * Run a generation plugin for a component. * - * @param [in] plugin The plugin to run. - * @param [in] componentVLNV The component to run the generation for. - * @param [in] viewName The component view to run the generation for. - * @param [in] outputDirectory The target directory for generated output files. - * @param [in] implementation The implementation type for which the generator is run. - * @param [in] parentWidget The parent widget for dialogs if GUI is used. + * @param [in] plugin The plugin to run. + * @param [in] componentVLNV The component to run the generation for. + * @param [in] viewName The component view to run the generation for. + * @param [in] outputDirectory The target directory for generated output files. + * @param [in] implementation The implementation type for which the generator is run. + * @param [in] parentWidget The parent widget for dialogs if GUI is used. */ static void runGenerator(IGeneratorPlugin* plugin, VLNV const& componentVLNV, QString const& viewName, QString const& outputDirectory, KactusAttribute::Implementation implementation, QWidget* parentWidget = nullptr); @@ -129,16 +129,16 @@ class KACTUS2_API KactusAPI /*! * Get the list of available plugins. * - * @return The list of available plugins. + * @return The list of available plugins. */ static QList getPlugins(); /*! * Get the file path of the selected VLNV document. * - * @param [in] vlnv VLNV of the selected document. + * @param [in] vlnv VLNV of the selected document. * - * @return File path of the selected VLNV document. + * @return File path of the selected VLNV document. */ static QString getDocumentFilePath(VLNV const& vlnv); diff --git a/KactusAPI/include/AbstractParameterInterface.h b/KactusAPI/include/AbstractParameterInterface.h index 9b7910749..7dd3e357e 100644 --- a/KactusAPI/include/AbstractParameterInterface.h +++ b/KactusAPI/include/AbstractParameterInterface.h @@ -32,9 +32,9 @@ class KACTUS2_API AbstractParameterInterface: public ParameterizableInterface, p /*! * The constructor. * - * @param [in] validator Validator for parameters. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] validator Validator for parameters. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ AbstractParameterInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -48,484 +48,484 @@ class KACTUS2_API AbstractParameterInterface: public ParameterizableInterface, p /*! * Set available choices. * - * @param [in] newChoices The new choices. + * @param [in] newChoices The new choices. */ void setChoices(QSharedPointer > > newChoices); /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; /*! * Get the expressions in the selected parameters. * - * @param [in] parameterNames Names of the selected parameters. + * @param [in] parameterNames Names of the selected parameters. * - * @return Expressions in the selected parameters. + * @return Expressions in the selected parameters. */ std::vector getExpressionsInSelectedItems(std::vector parameterNames) const; /*! * Validates the contained items. * - * @return True, if all the items are valid, false otherwise. + * @return True, if all the items are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Get the display name of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Name of the selected parameter. + * @return Name of the selected parameter. */ std::string getDisplayName(std::string const& parameterName) const; /*! * Set the display name of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newDisplayName New display name for the parameter. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newDisplayName New display name for the parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDisplayName(std::string const& parameterName, std::string const& newDisplayName); /*! * Get the type of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Type of the selected parameter. + * @return Type of the selected parameter. */ std::string getType(std::string const& parameterName) const; /*! * Set the type of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newType New type for the parameter. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newType New type for the parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setType(std::string const& parameterName, std::string const& newType); /*! * Get the calculated bit width left value of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] baseNumber Base for displaying the value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated bit width left value of the selected parameter. + * @return Calculated bit width left value of the selected parameter. */ std::string getBitWidthLeftValue(std::string const& parameterName, int const& baseNumber = 0) const; /*! * Get the formatted bit width left expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Formatted bit width left expression of the selected parameter. + * @return Formatted bit width left expression of the selected parameter. */ std::string getBitWidthLeftFormattedExpression(std::string const& parameterName) const; /*! * Get the bit width left expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Bit width left expression of the selected parameter. + * @return Bit width left expression of the selected parameter. */ std::string getBitWidthLeftExpression(std::string const& parameterName) const; /*! * Set a new bit width left value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newBitWidthLeft New bit width left value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newBitWidthLeft New bit width left value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBitWidthLeft(std::string const& parameterName, std::string const& newBitWidthLeft); /*! * Get the calculated bit width right value of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] baseNumber Base for displaying the value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated bit width right value of the selected port. + * @return Calculated bit width right value of the selected port. */ std::string getBitWidthRightValue(std::string const& parameterName, int const& baseNumber = 0) const; /*! * Get the formatted bit width right expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Formatted bit width right expression of the selected parameter. + * @return Formatted bit width right expression of the selected parameter. */ std::string getBitWidthRightFormattedExpression(std::string const& parameterName) const; /*! * Get the bit width right expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Bit width right expression of the selected parameter. + * @return Bit width right expression of the selected parameter. */ std::string getBitWidthRightExpression(std::string const& parameterName) const; /*! * Set a new bit width right value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newBitWidthRight New bit width right value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newBitWidthRight New bit width right value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBitWidthRight(std::string const& parameterName, std::string const& newBitWidthRight); /*! * Get the minimum value the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Minimum value of the selected parameter. + * @return Minimum value of the selected parameter. */ std::string getMinimum(std::string const& parameterName) const; /*! * Set the minimum value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newMinimum New minimum value of the parameter. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newMinimum New minimum value of the parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMinimum(std::string const& parameterName, std::string const& newMinimum); /*! * Get the maximum value the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Maximum value of the selected parameter. + * @return Maximum value of the selected parameter. */ std::string getMaximum(std::string const& parameterName) const; /*! * Set the maximum value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newMaximum New maximum value of the parameter. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newMaximum New maximum value of the parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMaximum(std::string const& parameterName, std::string const& newMaximum); /*! * Get the choice reference of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Choice reference of the selected parameter. + * @return Choice reference of the selected parameter. */ std::string getChoice(std::string const& parameterName) const; /*! * Set the choice reference for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newChoice The new choice reference. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newChoice The new choice reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setChoice(std::string const& parameterName, std::string const& newChoice); /*! * Get the calculated value of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] baseNumber Base for displaying the value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated value of the selected port. + * @return Calculated value of the selected port. */ std::string getValue(std::string const& parameterName, int const& baseNumber = 0) const; /*! * Get the formatted value expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Formatted value expression of the selected parameter. + * @return Formatted value expression of the selected parameter. */ std::string getValueFormattedExpression(std::string const& parameterName) const; /*! * Get the value expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Value expression of the selected parameter. + * @return Value expression of the selected parameter. */ std::string getValueExpression(std::string const& parameterName) const; /*! * Set a new value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newValue New value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newValue New value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setValue(std::string const& parameterName, std::string const& newValue); /*! * Get the resolve of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Resolve of the selected parameter. + * @return Resolve of the selected parameter. */ std::string getResolve(std::string const& parameterName) const; /*! * Set a resolve for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newResolve New resolve. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newResolve New resolve. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setResolve(std::string const& parameterName, std::string const& newResolve); /*! * Get the calculated array left value of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] baseNumber Base for displaying the value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated array left value of the selected port. + * @return Calculated array left value of the selected port. */ std::string getArrayLeftValue(std::string const& parameterName, int const& baseNumber = 0) const; /*! * Get the formatted array left expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Formatted array left expression of the selected parameter. + * @return Formatted array left expression of the selected parameter. */ std::string getArrayLeftFormattedExpression(std::string const& parameterName) const; /*! * Get the array left expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Array left expression of the selected parameter. + * @return Array left expression of the selected parameter. */ std::string getArrayLeftExpression(std::string const& parameterName) const; /*! * Set a new array left value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newArrayLeft New array left value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newArrayLeft New array left value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setArrayLeft(std::string const& parameterName, std::string const& newArrayLeft); /*! * Get the calculated array right value of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] baseNumber Base for displaying the value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated array right value of the selected port. + * @return Calculated array right value of the selected port. */ std::string getArrayRightValue(std::string const& parameterName, int const& baseNumber = 0) const; /*! * Get the formatted array right expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Formatted array right expression of the selected parameter. + * @return Formatted array right expression of the selected parameter. */ std::string getArrayRightFormattedExpression(std::string const& parameterName) const; /*! * Get the array right expression of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Array right expression of the selected parameter. + * @return Array right expression of the selected parameter. */ std::string getArrayRightExpression(std::string const& parameterName) const; /*! * Set a new array right value for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newArrayRight New array right value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newArrayRight New array right value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setArrayRight(std::string const& parameterName, std::string const& newArrayRight); /*! * Get the ID of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return ID of the selected parameter. + * @return ID of the selected parameter. */ std::string getID(std::string const& parameterName) const; /*! * Set a new ID for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newID New ID. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newID New ID. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setID(std::string const& parameterName, std::string const& newID); /*! * Get the usage count of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return Usage count of the selected parameter. + * @return Usage count of the selected parameter. */ int getUsageCount(std::string const& parameterName) const; /*! * Set a new usage count for the selected parameter. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newUsageCount New usage count. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newUsageCount New usage count. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setUsageCount(std::string const& parameterName, int const& newUsageCount); /*! * Increase the usage count of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool increaseUsageCount(std::string const& parameterName); /*! * Decrease the usage count of the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool reduceUsageCount(std::string const& parameterName); /*! * Check if the selected parameter has a valid type. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the type is valid, false otherwise. + * @return True, if the type is valid, false otherwise. */ bool hasValidType(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid bit width. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the bit width is valid, false otherwise. + * @return True, if the bit width is valid, false otherwise. */ bool hasValidBitWidth(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid minimum. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the minimum is valid, false otherwise. + * @return True, if the minimum is valid, false otherwise. */ bool hasValidMinimum(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid maximum. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the maximum is valid, false otherwise. + * @return True, if the maximum is valid, false otherwise. */ bool hasValidMaximum(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid choice. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the choice is valid, false otherwise. + * @return True, if the choice is valid, false otherwise. */ bool hasValidChoice(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid value. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the value is valid, false otherwise. + * @return True, if the value is valid, false otherwise. */ bool hasValidValue(std::string const& parameterName) const; /*! * Check if the selected parameter has a valid resolve. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the resolve is valid, false otherwise. + * @return True, if the resolve is valid, false otherwise. */ bool hasValidResolve(std::string const& parameterName) const; /*! * Check if the selected parameter has valid array values. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if the array values are valid, false otherwise. + * @return True, if the array values are valid, false otherwise. */ bool hasValidArrayValues(std::string const& parameterName) const; @@ -538,47 +538,47 @@ class KACTUS2_API AbstractParameterInterface: public ParameterizableInterface, p /*! * Get the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return The selected parameter. + * @return The selected parameter. */ virtual QSharedPointer getParameter(std::string const& parameterName) const = 0; /*! * Evaluate the value of the selected parameter. * - * @param [in] parameter The selected parameter. + * @param [in] parameter The selected parameter. * - * @return Evaluated value of the selected parameter. + * @return Evaluated value of the selected parameter. */ QString evaluateValue(QSharedPointer parameter) const; /*! * Find the selected choice. * - * @param [in] choiceName Name of the selected choice. + * @param [in] choiceName Name of the selected choice. * - * @return The selected choice. + * @return The selected choice. */ QSharedPointer findChoice(QString const& choiceName) const; /*! * Changes the array value to match the current choice. * - * @param [in] choice The currently active choice. - * @param [in] arrayValue The array value to be changed. + * @param [in] choice The currently active choice. + * @param [in] arrayValue The array value to be changed. * - * @return Array whose values have been changed to match the currently selected choice. + * @return Array whose values have been changed to match the currently selected choice. */ QString matchArrayValuesToSelectedChoice(QSharedPointer choice, QString const& arrayValue) const; /*! * Finds a human-readable value to display for a given enumeration. * - * @param [in] choice The choice whose enumeration to find. - * @param [in] enumerationValue The value used to search the enumeration. + * @param [in] choice The choice whose enumeration to find. + * @param [in] enumerationValue The value used to search the enumeration. * - * @return A value for the enumeration to display. + * @return A value for the enumeration to display. */ QString findDisplayValueForEnumeration(QSharedPointer choice, QString const& enumerationValue) const; diff --git a/KactusAPI/include/AbstractionTypeInterface.h b/KactusAPI/include/AbstractionTypeInterface.h index ce7a6d095..31953ec72 100644 --- a/KactusAPI/include/AbstractionTypeInterface.h +++ b/KactusAPI/include/AbstractionTypeInterface.h @@ -38,9 +38,9 @@ class KACTUS2_API AbstractionTypeInterface: public CommonInterface /*! * The constructor. * - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] validator Validator for abstraction types. - * @param [in] library Interface for the VLNV library. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] validator Validator for abstraction types. + * @param [in] library Interface for the VLNV library. */ AbstractionTypeInterface(PortMapInterface* portMapInterface, QSharedPointer validator, LibraryInterface* library); @@ -53,9 +53,9 @@ class KACTUS2_API AbstractionTypeInterface: public CommonInterface /*! * Setup the abstraction types. * - * @param [in] newAbstractions The new abstraction types. - * @param [in] busMode The new bus interface mode. - * @param [in] systemGroup The new system group. + * @param [in] newAbstractions The new abstraction types. + * @param [in] busMode The new bus interface mode. + * @param [in] systemGroup The new system group. */ void setAbstractionTypes(QSharedPointer > > newAbstractions, General::InterfaceMode busMode, QString const& systemGroup); @@ -63,109 +63,109 @@ class KACTUS2_API AbstractionTypeInterface: public CommonInterface /*! * Setup a new bus interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. */ void setBusMode(General::InterfaceMode busMode); /*! * Setup a new system group. * - * @param [in] systemGroup The selected system group. + * @param [in] systemGroup The selected system group. */ void setSystemGroup(QString const& systemGroup); /*! * Get the selected abstraction type. * - * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] abstractionIndex Index of the selected abstraction type. * - * @return The selected abstraction type. + * @return The selected abstraction type. */ QSharedPointer getAbstraction(int const& abstractionIndex) const; /*! * Setup the containing port map interface. * - * @param [in] abstractionTypeIndex Index of the selected abstraction type. + * @param [in] abstractionTypeIndex Index of the selected abstraction type. * - * @return True, if succesfull, false otherwise. + * @return True, if succesfull, false otherwise. */ bool setupAbstractionTypeForPortMapInterface(int const& abstractionTypeIndex); /*! * Setup the abstraction definition for port map interface. * - * @param [in] abstractionTypeIndex Index of the selected abstraction definition. + * @param [in] abstractionTypeIndex Index of the selected abstraction definition. * - * @return True, if succesfull, false otherwise. + * @return True, if succesfull, false otherwise. */ bool setupAbstractionDefinitionForPortMapInterface(int const& abstractionTypeIndex); /*! * Get the abstraction reference string of the selected abstraction type. * - * @param [in] itemIndex Index of the selected abstraction type. + * @param [in] itemIndex Index of the selected abstraction type. * - * @return Abstraction reference string of the selected abstraction type. + * @return Abstraction reference string of the selected abstraction type. */ std::string getIndexedAbstraction(int const& itemIndex) const; /*! * Get the abstraction reference of the selected abstraction type. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. * - * @return Abstraction reference of the selected abstraction type. + * @return Abstraction reference of the selected abstraction type. */ QSharedPointer getAbstractionReference(int const& typeIndex) const; /*! * Get the abstraction reference string. * - * @return Abstraction reference if only a single abstraction type exists, otherwise [multiple]. + * @return Abstraction reference if only a single abstraction type exists, otherwise [multiple]. */ std::string getAbstractionReferenceString() const; /*! * Get the list of abstraction references. * - * @return String list of the abstraction references. + * @return String list of the abstraction references. */ std::vector getAbstractionReferences() const; /*! * Check if the selected abstraction type has an abstraction reference. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. * - * @return True, if the selected abstraction type has an abstraction reference, false otherwise. + * @return True, if the selected abstraction type has an abstraction reference, false otherwise. */ bool hasAbstractionReference(int const& typeIndex) const; /*! * Get the number of available abstraction types. * - * @return Number of available abstraction types. + * @return Number of available abstraction types. */ virtual int itemCount() const override final; /*! * Get the abstraction references of the available abstraction types. * - * @return Abstraction references of the available abstraction types. + * @return Abstraction references of the available abstraction types. */ virtual std::vector getItemNames() const override final; /*! * Set a new abstraction reference for the selected abstraction type. * - * @param [in] abstractionIndex Index of the selected abstraction type. - * @param [in] newVendor Vendor of the new abstraction reference. - * @param [in] newLibrary Library of the new abstraction reference. - * @param [in] newName Name of the new abstraction reference. - * @param [in] newVersion Version of the new abstraction reference. + * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] newVendor Vendor of the new abstraction reference. + * @param [in] newLibrary Library of the new abstraction reference. + * @param [in] newName Name of the new abstraction reference. + * @param [in] newVersion Version of the new abstraction reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAbstraction(int const& abstractionIndex, std::string const& newVendor, std::string const& newLibrary, std::string const& newName, std::string const& newVersion); @@ -173,79 +173,79 @@ class KACTUS2_API AbstractionTypeInterface: public CommonInterface /*! * Get the view references of the selected abstraction type. * - * @param [in] abstractionIndex Index of the abstraction type. + * @param [in] abstractionIndex Index of the abstraction type. * - * @return View references of the selected abstraction type. + * @return View references of the selected abstraction type. */ std::vector getViewReferences(int const& abstractionIndex) const; /*! * Get the view references of the selected abstraction type as a single string. * - * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] abstractionIndex Index of the selected abstraction type. * - * @return String containing the view references of the selected abstraction type. + * @return String containing the view references of the selected abstraction type. */ std::string getCombinedViews(int const& abstractionIndex) const; /*! * Set view references for the selected abstraction type. * - * @param [in] abstractionIndex Index of the selected abstraction type. - * @param [in] newViews The new view references. + * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] newViews The new view references. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setViewReferences(int const& abstractionIndex, std::vector newViews); /*! * Get the physical port names from all the contained port maps of the selected abstraction type. * - * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] abstractionIndex Index of the selected abstraction type. * - * @return Physical port names. + * @return Physical port names. */ std::vector getPhysicalPortsFromPortMaps(int const& abstractionIndex) const; /*! * Validates the contained abstraction types. * - * @return True, if all the abstraction types are valid, false otherwise. + * @return True, if all the abstraction types are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected abstraction type has a valid abstraction reference. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. * - * @return True, if the selected abstraction type has a valid abstraction reference. + * @return True, if the selected abstraction type has a valid abstraction reference. */ bool hasValidAbstractionReference(int const& typeIndex) const; /*! * Check if the selected abstraction type has valid view references. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. * - * @return True, if the selected abstraction type has valid view references. + * @return True, if the selected abstraction type has valid view references. */ bool hasValidViewReferences(int const& typeIndex) const; /*! * Add an abstraction type. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. */ void addAbstraction(int const& typeIndex); /*! * Add the selected abstraction type. * - * @param [in] newVendor Vendor of the new abstraction reference. - * @param [in] newLibrary Library of the new abstraction reference. - * @param [in] newName Name of the new abstraction reference. - * @param [in] newVersion Version of the new abstraction reference. + * @param [in] newVendor Vendor of the new abstraction reference. + * @param [in] newLibrary Library of the new abstraction reference. + * @param [in] newName Name of the new abstraction reference. + * @param [in] newVersion Version of the new abstraction reference. */ void addAbstractionType(std::string const& newVendor, std::string const& newLibrary, std::string const& newName, std::string const& newVersion) const; @@ -253,16 +253,16 @@ class KACTUS2_API AbstractionTypeInterface: public CommonInterface /*! * Remove the selected abstraction type. * - * @param [in] typeIndex Index of the selected abstraction type. + * @param [in] typeIndex Index of the selected abstraction type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeAbstraction(int const& typeIndex); /*! * Get the contained port map interface. * - * @return The port map interface. + * @return The port map interface. */ PortMapInterface* getPortMapInterface() const; diff --git a/KactusAPI/include/AccessPolicyInterface.h b/KactusAPI/include/AccessPolicyInterface.h index e72d5d7f3..cafa1b4e0 100644 --- a/KactusAPI/include/AccessPolicyInterface.h +++ b/KactusAPI/include/AccessPolicyInterface.h @@ -34,7 +34,7 @@ class KACTUS2_API AccessPolicyInterface /*! * The constructor. * - * @param [in] modeRefInterface Interface for accessing mode references. + * @param [in] modeRefInterface Interface for accessing mode references. */ explicit AccessPolicyInterface(ModeReferenceInterface* modeRefInterface); @@ -47,14 +47,14 @@ class KACTUS2_API AccessPolicyInterface /*! * Set available access policies. * - * @param [in] accessPolicies Access policies to set. + * @param [in] accessPolicies Access policies to set. */ void setAccessPolicies(QSharedPointer > > accessPolicies); /*! * Set the available component modes for the interface. * - * @param [in] componentModes The available component modes. + * @param [in] componentModes The available component modes. */ void setComponentModes(QSharedPointer > > componentModes); @@ -73,7 +73,7 @@ class KACTUS2_API AccessPolicyInterface /*! * Remove an access policy given by index. * - * @param [in] accessPolicyIndex The index of the access policy to remove. + * @param [in] accessPolicyIndex The index of the access policy to remove. * * @return True, if the removal was successful, otherwise false. */ @@ -82,8 +82,8 @@ class KACTUS2_API AccessPolicyInterface /*! * Set the access value for a given accesspolicy. * - * @param [in] newAccess The new access value to set. - * @param [in] accessPolicyIndex The index of the access policy to set the access for. + * @param [in] newAccess The new access value to set. + * @param [in] accessPolicyIndex The index of the access policy to set the access for. * * @return True, if the access value was successfully set, otherwise false. */ @@ -92,7 +92,7 @@ class KACTUS2_API AccessPolicyInterface /*! * Get the access value as a string of a given access policy. * - * @param [in] accessPolicyIndex The index of the access policy. + * @param [in] accessPolicyIndex The index of the access policy. * * @return The access value as a string. */ @@ -101,7 +101,7 @@ class KACTUS2_API AccessPolicyInterface /*! * Get the access value of a given access policy. * - * @param [in] accessPolicyIndex The index of the access policy. + * @param [in] accessPolicyIndex The index of the access policy. * * @return The access value. */ @@ -117,7 +117,7 @@ class KACTUS2_API AccessPolicyInterface /*! * Get the mode references of given access policy. * - * @param [in] accessPolicyIndex The index of the access policy whose mode references to get. + * @param [in] accessPolicyIndex The index of the access policy whose mode references to get. * * @return The mode references of access policy given by index. */ @@ -126,8 +126,8 @@ class KACTUS2_API AccessPolicyInterface /*! * Set mode references of an access policy. * - * @param [in] accessPolicyIndex The index of the access policy whose mode references to be set. - * @param [in] newModeRefs The modereferences to be set. + * @param [in] accessPolicyIndex The index of the access policy whose mode references to be set. + * @param [in] newModeRefs The modereferences to be set. * * @return True, if the operation was successful, otherwise false. */ @@ -136,7 +136,7 @@ class KACTUS2_API AccessPolicyInterface /*! * Get the mode references in use by other than selected access policy given by index. * - * @param [in] accessPolicyIndex The index of the access policy whose mode references are not to be + * @param [in] accessPolicyIndex The index of the access policy whose mode references are not to be * included in the returned list. * * @return All other mode references in use. @@ -147,7 +147,7 @@ class KACTUS2_API AccessPolicyInterface * Validates the mode references of selected access policy. Compares against all mode references * in other access policies. * - * @param [in] accessPolicyIndex The index of the access policy whose mode references are validated. + * @param [in] accessPolicyIndex The index of the access policy whose mode references are validated. * * @return True, if the mode references of selected accesspolicy are valid, otherwise false. */ diff --git a/KactusAPI/include/AdHocConnectionInterface.h b/KactusAPI/include/AdHocConnectionInterface.h index 39e898151..b91f7af9b 100644 --- a/KactusAPI/include/AdHocConnectionInterface.h +++ b/KactusAPI/include/AdHocConnectionInterface.h @@ -39,37 +39,37 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Setup the ad hoc connections. * - * @param [in] newDesign Design containing the ad hoc connections. + * @param [in] newDesign Design containing the ad hoc connections. */ void setConnections(QSharedPointer newDesign); /*! * Get index of the selected ad hoc connection. * - * @param [in] itemName Name of the selected ad hoc connection. + * @param [in] itemName Name of the selected ad hoc connection. * - * @return Index of the selected ad hoc connection. + * @return Index of the selected ad hoc connection. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed ad hoc connection. * - * @param [in] itemIndex Index of the selected ad hoc connection. + * @param [in] itemIndex Index of the selected ad hoc connection. * - * @return Name of the selected ad hoc connection. + * @return Name of the selected ad hoc connection. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the name of the selected ad hoc connection. * - * @param [in] startInstanceName Name of the instance containing the first port. - * @param [in] startPortName Name of the first port. - * @param [in] endInstanceName Name of the instance containing the second port. - * @param [in] endPortName Name of the second port. + * @param [in] startInstanceName Name of the instance containing the first port. + * @param [in] startPortName Name of the first port. + * @param [in] endInstanceName Name of the instance containing the second port. + * @param [in] endPortName Name of the second port. * - * @return Name of the selected ad hoc connection. + * @return Name of the selected ad hoc connection. */ std::string getConnectionName(std::string const& startInstanceName, std::string const& startPortName, std::string const& endInstanceName, std::string const& endPortName) const; @@ -77,11 +77,11 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Get the name of the selected hierarchical ad hoc connection. * - * @param [in] instanceName Name of the component instance containing the selected port. - * @param [in] instancePort Name of the selected component instance port. - * @param [in] topPort Name of the top component port. + * @param [in] instanceName Name of the component instance containing the selected port. + * @param [in] instancePort Name of the selected component instance port. + * @param [in] topPort Name of the top component port. * - * @return Name of the selected ad hoc connection. + * @return Name of the selected ad hoc connection. */ std::string getHierarchicalConnectionName(std::string const& instanceName, std::string const& instancePort, std::string const& topPort) const; @@ -89,70 +89,70 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Get the number of available ad hoc connections. * - * @return Number of available ad hoc connections. + * @return Number of available ad hoc connections. */ virtual int itemCount() const override final; /*! * Get the names of the available bus interfaces. * - * @return Names of the available bus interfaces. + * @return Names of the available bus interfaces. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected ad hoc connection. * - * @param [in] currentName Name of the selected ad hoc connection. - * @param [in] newName New name for the ad hoc connection. + * @param [in] currentName Name of the selected ad hoc connection. + * @param [in] newName New name for the ad hoc connection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the description of the selected ad hoc connection. * - * @param [in] itemName Name of the selected ad hoc connection. + * @param [in] itemName Name of the selected ad hoc connection. * - * @return Description of the selected ad hoc connection. + * @return Description of the selected ad hoc connection. */ virtual std::string getDescription(std::string const& itemName) const override final; /*! * Set a new description for the selected ad hoc connection. * - * @param [in] itemName Name of the selected ad hoc connection. - * @param [in] newDescription New description. + * @param [in] itemName Name of the selected ad hoc connection. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setDescription(std::string const& itemName, std::string const& newDescription) override final; /*! * Validates the contained ad hoc connections. * - * @return True, if all the ad hoc connections are valid, false otherwise. + * @return True, if all the ad hoc connections are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected ad hoc connection has a valid name. * - * @param [in] itemName Name of the selected ad hoc connection. + * @param [in] itemName Name of the selected ad hoc connection. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Add a new ad hoc connection. * - * @param [in] startComponentInstance Name of the component instance containing the first port. - * @param [in] startPort Name of the first port. - * @param [in] endComponentInstance Name of the component instance containing the second port. - * @param [in] endPort Name of the second port. - * @param [in] connectionName Name of the new ad hoc connection. + * @param [in] startComponentInstance Name of the component instance containing the first port. + * @param [in] startPort Name of the first port. + * @param [in] endComponentInstance Name of the component instance containing the second port. + * @param [in] endPort Name of the second port. + * @param [in] connectionName Name of the new ad hoc connection. */ void addAdHocConnection(std::string const& startComponentInstance, std::string const& startPort, std::string const& endComponentInstance, std::string const& endPort, @@ -161,10 +161,10 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Add a new hierarchical ad hoc connection. * - * @param [in] instanceName Name of the component instance containing the selected port. - * @param [in] instancePort Name of the selected port. - * @param [in] topPort Name of the top component port. - * @param [in] connectionName Name of the new ad hoc connection. + * @param [in] instanceName Name of the component instance containing the selected port. + * @param [in] instancePort Name of the selected port. + * @param [in] topPort Name of the top component port. + * @param [in] connectionName Name of the new ad hoc connection. */ void addHierarchicalAdHocConnection(std::string const& instanceName, std::string const& instancePort, std::string const& topPort, std::string const& connectionName = ""); @@ -172,35 +172,35 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Remove the selected ad hoc connection. * - * @param [in] busName Name of the selected ad hoc connection. + * @param [in] busName Name of the selected ad hoc connection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeAdHocConnection(std::string const& connectionName); /*! * Remove ad hoc connections connected to the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeInstanceAdHocConnections(std::string const& instanceName); /*! * Check if the selected ad hoc connection exists. * - * @param [in] connectionName Name of the selected ad hoc connection. + * @param [in] connectionName Name of the selected ad hoc connection. * - * @return True, if the ad hoc connection exists, false otherwise. + * @return True, if the ad hoc connection exists, false otherwise. */ bool adHocConnectionExists(std::string const& connectionName) const; /*! * Rename the component references in connections. * - * @param [in] currentName Current name of the component instance. - * @param [in] newName New name for the component instance. + * @param [in] currentName Current name of the component instance. + * @param [in] newName New name for the component instance. */ void renameComponentReferences(std::string const& currentName, std::string const& newName); @@ -213,18 +213,18 @@ class KACTUS2_API AdHocConnectionInterface : public NameGroupInterface /*! * Get the selected ad hoc connection. * - * @param [in] connectionName Name of the selected ad hoc connection. + * @param [in] connectionName Name of the selected ad hoc connection. * - * @return The selected ad hoc connection. + * @return The selected ad hoc connection. */ QSharedPointer getAdHocConnection(std::string const& connectionName) const; /*! * Get the ad hoc connection with the selected name, sliced to a NameGroup. * - * @param [in] connectionName Name of the selected ad hoc connection. + * @param [in] connectionName Name of the selected ad hoc connection. * - * @return The sliced ad hoc connection with the selected name. + * @return The sliced ad hoc connection with the selected name. */ QSharedPointer getItem(std::string const& connectionName) const; diff --git a/KactusAPI/include/AddressBlockExpressionsGatherer.h b/KactusAPI/include/AddressBlockExpressionsGatherer.h index 236020243..a3680edc3 100644 --- a/KactusAPI/include/AddressBlockExpressionsGatherer.h +++ b/KactusAPI/include/AddressBlockExpressionsGatherer.h @@ -40,9 +40,9 @@ class KACTUS2_API AddressBlockExpressionGatherer /*! * Get the expressions from the given address block. * - * @param [in] currentAddressBlock The given address block. + * @param [in] currentAddressBlock The given address block. * - * @return A list of all the expressions used in address block. + * @return A list of all the expressions used in address block. */ QStringList getExpressions(QSharedPointer currentAddressBlock) const; diff --git a/KactusAPI/include/AddressBlockInterface.h b/KactusAPI/include/AddressBlockInterface.h index 1426ae744..47c7836eb 100644 --- a/KactusAPI/include/AddressBlockInterface.h +++ b/KactusAPI/include/AddressBlockInterface.h @@ -39,12 +39,12 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * The constructor. * - * @param [in] blockValidator Validator for address blocks. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] subInterface Interface for accessing registers. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] blockValidator Validator for address blocks. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] subInterface Interface for accessing registers. + * @param [in] parameterInterface Interface for accessing parameters. */ AddressBlockInterface(QSharedPointer blockValidator, QSharedPointer expressionParser, @@ -61,103 +61,103 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Check if the selected memory block is an address block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return True, if the memory block is an address block, false otherwise. + * @return True, if the memory block is an address block, false otherwise. */ virtual bool acceptBlock(std::string const& blockName) const override final; /*! * Get the formatted range expression of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Formatted range expression of the selected address block. + * @return Formatted range expression of the selected address block. */ std::string getRangeFormattedExpression(std::string const& blockName) const; /*! * Get the range expression of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Range expression of the selected address block. + * @return Range expression of the selected address block. */ std::string getRangeExpression(std::string const& blockName) const; /*! * Set a new range value for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newRange New range value. + * @param [in] blockName Name of the selected address block. + * @param [in] newRange New range value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRange(std::string const& blockName, std::string const& newRange) const; /*! * Get the calculated width value of the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] baseNumber Base for displaying the value. + * @param [in] blockName Name of the selected address block. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated width value of the selected address block. + * @return Calculated width value of the selected address block. */ std::string getWidthValue(std::string const& blockName, int const& baseNumber = 0) const; /*! * Get the formatted width expression of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Formatted width expression of the selected address block. + * @return Formatted width expression of the selected address block. */ std::string getWidthFormattedExpression(std::string const& blockName) const; /*! * Get the width expression of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Width expression of the selected address block. + * @return Width expression of the selected address block. */ std::string getWidthExpression(std::string const& blockName) const; /*! * Set a new width value for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newWidth New width value. + * @param [in] blockName Name of the selected address block. + * @param [in] newWidth New width value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWidth(std::string const& blockName, std::string const& newWidth) const; /*! * Get the usage string of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Usage string of the selected address block. + * @return Usage string of the selected address block. */ std::string getUsageString(std::string const& blockName) const; /*! * Get the usage of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Usage of the selected address block. + * @return Usage of the selected address block. */ General::Usage getUsage(std::string const& blockName) const; /*! * Set a new usage value for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newUsage New usage value. + * @param [in] blockName Name of the selected address block. + * @param [in] newUsage New usage value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setUsage(std::string const& blockName, std::string const& newUsage) const; @@ -166,71 +166,71 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface * accessPolicyIndex parameter. The default value of -1 returns the address block's access value. 0 and above * returns an indexed access policy's access value. * - * @param [in] blockName Name of the selected address block. - * @param [in] getAccessPolicyAccess Flag indicating if access is fetched from access policy or directly + * @param [in] blockName Name of the selected address block. + * @param [in] getAccessPolicyAccess Flag indicating if access is fetched from access policy or directly * from address block. * - * @return Access string of the selected address block or its access policy. + * @return Access string of the selected address block or its access policy. */ std::string getAccessString(std::string const& blockName, bool getAccessPolicyAccess = false) const; /*! * Get the access of the selected address block. Used in std14 access editor. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Access of the selected address block. + * @return Access of the selected address block. */ AccessTypes::Access getAccess(std::string const& blockName) const; /*! * Set a new access for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newAccess New access value. - * @param [in] getAccessPolicyAccess Flag indicating if access is set to access policy or directly to + * @param [in] blockName Name of the selected address block. + * @param [in] newAccess New access value. + * @param [in] getAccessPolicyAccess Flag indicating if access is set to access policy or directly to * address block. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAccess(std::string const& blockName, std::string const& newAccess, bool setAccessPolicyAccess = false) const; /*! * Get the volatile value of the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return Volatile value of the selected address block. + * @return Volatile value of the selected address block. */ std::string getVolatile(std::string const& blockName) const; /*! * Set a new volatile value for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newVolatile New volatile value. + * @param [in] blockName Name of the selected address block. + * @param [in] newVolatile New volatile value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setVolatile(std::string const& blockName, bool newVolatile) const; /*! * Set a new volatile value for the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] newVolatileValue The new volatile value. + * @param [in] blockName Name of the selected address block. + * @param [in] newVolatileValue The new volatile value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setVolatile(std::string const& blockName, std::string const& newVolatileValue); /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -238,74 +238,74 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected address block has a valid range. * - * @param [in] itemName Name of the selected address block. + * @param [in] itemName Name of the selected address block. * - * @return True, if the range is valid, false otherwise. + * @return True, if the range is valid, false otherwise. */ bool hasValidRange(std::string const& itemName) const; /*! * Check if the selected address block has a valid width. * - * @param [in] itemName Name of the selected address block. + * @param [in] itemName Name of the selected address block. * - * @return True, if the width is valid, false otherwise. + * @return True, if the width is valid, false otherwise. */ bool hasValidWidth(std::string const& itemName) const; /*! * Check if the selected address block has a valid usage. * - * @param [in] itemName Name of the selected address block. + * @param [in] itemName Name of the selected address block. * - * @return True, if the usage is valid, false otherwise. + * @return True, if the usage is valid, false otherwise. */ bool hasValidUsage(std::string const& itemName) const; /*! * Add a new address block. * - * @param [in] row Row of the new address block. - * @param [in] newBlockName Name of the new address block. + * @param [in] row Row of the new address block. + * @param [in] newBlockName Name of the new address block. */ virtual void addBlock(int const& row, std::string const& newBlockName = std::string("")) override final; /*! * Get the expressions in the selected items. * - * @param [in] itemNames Names of the selected items. + * @param [in] itemNames Names of the selected items. * - * @return The expressions of the selected items. + * @return The expressions of the selected items. */ virtual std::vector getExpressionsInSelectedItems(std::vector const& itemNames) const override final; /*! * Get the sub interface. * - * @return Interface for accessing registers. + * @return Interface for accessing registers. */ RegisterInterface* getSubInterface() const; /*! * Check if the selected address block contains registers. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return True, if the address block contains registers, false otherwise. + * @return True, if the address block contains registers, false otherwise. */ bool hasRegisters(std::string const& blockName) const; /*! * Get the number of access policies an address block has. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * * @return The number of access policies of the selected address block. */ @@ -314,9 +314,9 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Add a new access policy to an address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return True, if the operation was successful, otherwise false. + * @return True, if the operation was successful, otherwise false. */ bool addAccessPolicy(std::string const& blockName) const; @@ -326,25 +326,25 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Get the selected address block. * - * @param [in] blockName Name of the selected address block. + * @param [in] blockName Name of the selected address block. * - * @return The selected address block. + * @return The selected address block. */ QSharedPointer getAddressBlock(std::string const& itemName) const; /*! * Get the default name for an address block. * - * @return Default name for an address block. + * @return Default name for an address block. */ virtual std::string getDefaultName() const override final; /*! * Get a list of the copied address blocks. * - * @param [in] selectedRows Rows of the copied address blocks. + * @param [in] selectedRows Rows of the copied address blocks. * - * @return List of the copied memory blocks. + * @return List of the copied memory blocks. */ virtual QList > getCopiedBlocks(std::vector const& selectedRows) const override final; @@ -352,16 +352,16 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Get the mime type of the address block. * - * @return The mime type of the address block. + * @return The mime type of the address block. */ virtual QString getMimeType() const override final; /*! * Create a copy of the selected address block. * - * @param [in] copiedItem The selected address block- + * @param [in] copiedItem The selected address block- * - * @return Copy of the selected address block. + * @return Copy of the selected address block. */ virtual QSharedPointer createCopyBlock(QSharedPointer copiedItem) const override final; @@ -369,25 +369,25 @@ class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface /*! * Count the address block items in the selected list. * - * @param [in] itemList List of address block items. + * @param [in] itemList List of address block items. * - * @return Number of address block items in the selected list. + * @return Number of address block items in the selected list. */ virtual int countItems(QList > itemList) const override final; /*! * Get the address block validator. * - * @return The address block validator. + * @return The address block validator. */ virtual QSharedPointer getValidator() const override final; /*! * Get the address block with the selected name, sliced to a NameGroup. * - * @param [in] itemName Name of the selected address block. + * @param [in] itemName Name of the selected address block. * - * @return The sliced address block with the selected name. + * @return The sliced address block with the selected name. */ QSharedPointer getItem(std::string const& itemName) const override; diff --git a/KactusAPI/include/AddressSpaceExpressionsGatherer.h b/KactusAPI/include/AddressSpaceExpressionsGatherer.h index 9861b8a76..1630cbc49 100644 --- a/KactusAPI/include/AddressSpaceExpressionsGatherer.h +++ b/KactusAPI/include/AddressSpaceExpressionsGatherer.h @@ -41,9 +41,9 @@ class KACTUS2_API AddressSpaceExpressionGatherer /*! * Get the expressions from a given address space. * - * @param [in] addressSpace The given address space. + * @param [in] addressSpace The given address space. * - * @return A list containing all the expressions used in an address space. + * @return A list containing all the expressions used in an address space. */ QStringList getExpressions(QSharedPointer addressSpace) const; @@ -52,9 +52,9 @@ class KACTUS2_API AddressSpaceExpressionGatherer /*! * Get the expressions from segments. * - * @param [in] segmentList A list of the selected segments. + * @param [in] segmentList A list of the selected segments. * - * @return A list of expressions contained within the segments. + * @return A list of expressions contained within the segments. */ QStringList getExpressionsFromSegments(QSharedPointer > > segmentList) const; diff --git a/KactusAPI/include/BusInterfaceInterface.h b/KactusAPI/include/BusInterfaceInterface.h index 86d67111b..291dcebaf 100644 --- a/KactusAPI/include/BusInterfaceInterface.h +++ b/KactusAPI/include/BusInterfaceInterface.h @@ -44,9 +44,9 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * The constructor. * - * @param [in] busValidator Validator for bus interfaces. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] busValidator Validator for bus interfaces. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ BusInterfaceInterface(QSharedPointer busValidator, QSharedPointer expressionParser, @@ -60,152 +60,152 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Set a new file set interface. * - * @param [in] newFileSetInterface The new file set interface. + * @param [in] newFileSetInterface The new file set interface. */ void setFileSetInterface(FileSetInterface* newFileSetInterface); /*! * Set a new memory map interface. * - * @param [in] newMapInterface The new memory map interface. + * @param [in] newMapInterface The new memory map interface. */ void setMemoryMapInterface(MemoryMapInterface* newMapInterface); /*! * Set a new abstraction type interface. * - * @param [in] newAbstractionTypeInterface The new abstraction type interface. + * @param [in] newAbstractionTypeInterface The new abstraction type interface. */ void setAbstractionTypeInterface(AbstractionTypeInterface* newAbstractionTypeInterface); /*! * Set a new transparent bridge interface. * - * @param [in] newBridgeInterface The new transparent bridge interface. + * @param [in] newBridgeInterface The new transparent bridge interface. */ void setTransparentBridgeInterface(TransparentBridgeInterface* newBridgeInterface); /*! * Set a new parameter interface. * - * @param [in] newParameterInterface The new parameter interface. + * @param [in] newParameterInterface The new parameter interface. */ void setParameterInterface(ParametersInterface* newParameterInterface); /*! * Setup the bus interfaces. * - * @param [in] newComponent Component containing the bus interfaces. + * @param [in] newComponent Component containing the bus interfaces. */ void setBusInterfaces(QSharedPointer newComponent); /*! * Setup the sub interfaces for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. */ void setupSubInterfaces(std::string const& busName); /*! * Get index of the selected bus interface. * - * @param [in] itemName Name of the selected bus interface. + * @param [in] itemName Name of the selected bus interface. * - * @return Index of the selected bus interface. + * @return Index of the selected bus interface. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed bus interface. * - * @param [in] itemIndex Index of the selected bus interface. + * @param [in] itemIndex Index of the selected bus interface. * - * @return Name of the selected bus interface. + * @return Name of the selected bus interface. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available bus interfaces. * - * @return Number of available bus interfaces. + * @return Number of available bus interfaces. */ virtual int itemCount() const override final; /*! * Get the names of the available bus interfaces. * - * @return Names of the available bus interfaces. + * @return Names of the available bus interfaces. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected bus interface. * - * @param [in] currentName Name of the selected bus interface. - * @param [in] newName New name for the bus interface. + * @param [in] currentName Name of the selected bus interface. + * @param [in] newName New name for the bus interface. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Validates the contained bus interfaces. * - * @return True, if all the bus interfaces are valid, false otherwise. + * @return True, if all the bus interfaces are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Validate the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if the bus interface is valid, false otherwise. + * @return True, if the bus interface is valid, false otherwise. */ bool validateBusInterface(std::string const& busName) const; /*! * Check if the selected bus interface has a valid name. * - * @param [in] itemName Name of the selected bus interface. + * @param [in] itemName Name of the selected bus interface. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Check if the selected bus interface has a valid bus type. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if the bus type is valid, false otherwise. + * @return True, if the bus type is valid, false otherwise. */ bool hasValidBusType(std::string const& busName) const; /*! * Check if the selected bus interface has valid abstraction types. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if the abstraction types is valid, false otherwise. + * @return True, if the abstraction types is valid, false otherwise. */ bool hasValidAbstractionTypes(std::string const& busName) const; /*! * Get the interface mode of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Interface mode of the selected bus interface. + * @return Interface mode of the selected bus interface. */ General::InterfaceMode getMode(std::string const& busName) const; /*! * Get the active / monitored bus interface mode of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Active / monitored bus interface mode of the seleced bus interface. + * @return Active / monitored bus interface mode of the seleced bus interface. */ General::InterfaceMode getActiveMode(std::string const& busName) const; @@ -213,259 +213,259 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Get the interface mode of the selected bus interface in string form. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Interface mode string of the selected bus interface. + * @return Interface mode string of the selected bus interface. */ std::string getModeString(std::string const& busName) const; /*! * Set the interface mode for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newMode The new interface mode. + * @param [in] busName Name of the selected bus interface. + * @param [in] newMode The new interface mode. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMode(std::string const& busName, std::string const& newMode); /*! * Get the system group of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return System group of the selected bus interface. + * @return System group of the selected bus interface. */ std::string getSystemGroup(std::string const& busName) const; /*! * Get the active / monitored system group of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Active / monitored system group of the seleced bus interface. + * @return Active / monitored system group of the seleced bus interface. */ QString getActiveSystemGroup(std::string const& busName) const; /*! * Set the system group for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newSystem The new system group. + * @param [in] busName Name of the selected bus interface. + * @param [in] newSystem The new system group. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setSystemGroup(std::string const& busName, std::string const& newSystem); /*! * Get the connection required value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return The connection required value of the selected bus interface. + * @return The connection required value of the selected bus interface. */ std::string connectionIsRequired(std::string const& busName) const; /*! * Set the connection required value for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newValue New connection required value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newValue New connection required value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setConnectionIsRequired(std::string const& busName, bool newValue); /*! * Get the bits in lau value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Bits in lau value of the selected bus interface. + * @return Bits in lau value of the selected bus interface. */ std::string getBitsInLau(std::string const& busName) const; /*! * Set the bits in value for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newBits New bits in lau value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newBits New bits in lau value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBitsInLau(std::string const& busName, std::string const& newBits); /*! * Get the endianness of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return BIG, LITTLE or UNSPECIFIED. + * @return BIG, LITTLE or UNSPECIFIED. */ BusInterface::Endianness getEndianness(std::string const& busName) const; /*! * Set the endianness of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newEndianness New endianness value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newEndianness New endianness value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setEndianness(std::string const& busName, std::string const& newEndianness); /*! * Get the bit steering value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return The bit steering of the selected bus interface. + * @return The bit steering of the selected bus interface. */ std::string getBitSteering(std::string const& busName) const; /*! * Set the bit steering value for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newBitSteering New bit steering value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newBitSteering New bit steering value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBitSteering(std::string const& busName, std::string const& newBitSteering); /*! * Get the address space reference of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Address space reference of the selected bus interface. + * @return Address space reference of the selected bus interface. */ std::string getAddressSpaceReference(std::string const& busName) const; /*! * Set a new address space reference for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newSpace New address space reference. + * @param [in] busName Name of the selected bus interface. + * @param [in] newSpace New address space reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAddressSpaceReference(std::string const& busName, std::string const& newSpace); /*! * Get the calculated base address value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] baseNumber Base for displaying the value. + * @param [in] busName Name of the selected bus interface. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated base address value of the selected bus interface. + * @return Calculated base address value of the selected bus interface. */ std::string getBaseAddressValue(std::string const& busName, int const& baseNumber = 0) const; /*! * Get the formatted base address expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Formatted base address expression of the selected bus interface. + * @return Formatted base address expression of the selected bus interface. */ std::string getBaseAddressFormattedExpression(std::string const& busName) const; /*! * Get the base address expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Base address expression of the selected bus interface. + * @return Base address expression of the selected bus interface. */ std::string getBaseAddressExpression(std::string const& busName) const; /*! * Set the base address for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newBaseAddress New base address. + * @param [in] busName Name of the selected bus interface. + * @param [in] newBaseAddress New base address. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBaseAddress(std::string const& busName, std::string const& newBaseAddress); /*! * Get the memory map reference of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Memory map reference of the selected bus interface. + * @return Memory map reference of the selected bus interface. */ std::string getMemoryMapReference(std::string const& busName) const; /*! * Set a new memory map reference for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newMapReference New memory map reference. + * @param [in] busName Name of the selected bus interface. + * @param [in] newMapReference New memory map reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMemoryMapReference(std::string const& busName, std::string const& newMapReference); /*! * Get the file set references of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return File set references of the selected bus interface. + * @return File set references of the selected bus interface. */ std::vector getFileSetReferences(std::string const& busName) const; /*! * Set the file set references for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newFileSetReferences New file set references. + * @param [in] busName Name of the selected bus interface. + * @param [in] newFileSetReferences New file set references. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setFileSetReferences(std::string const& busName, std::vector const& newFileSetReferences); /*! * Get the bus type of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Bus type of the selected bus interface. + * @return Bus type of the selected bus interface. */ ConfigurableVLNVReference getBusType(std::string const& busName) const; /*! * Get the bus type of the selected bus interface as a string. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Bus type of the selected bus interface in string format. + * @return Bus type of the selected bus interface in string format. */ std::string getBusTypeString(std::string const& busName) const; /*! * Set the bus type of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newVLNV New bus type VLNV. + * @param [in] busName Name of the selected bus interface. + * @param [in] newVLNV New bus type VLNV. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBustype(std::string const& busName, ConfigurableVLNVReference const& newVLNV); /*! * Set the bus type for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newVendor Vendor of the new bus type. - * @param [in] newLibrary Library of the new bus type. - * @param [in] newName Name of the new bus type. - * @param [in] newVersion Version of the new bus type. + * @param [in] busName Name of the selected bus interface. + * @param [in] newVendor Vendor of the new bus type. + * @param [in] newLibrary Library of the new bus type. + * @param [in] newName Name of the new bus type. + * @param [in] newVersion Version of the new bus type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBustype(std::string const& busName, std::string const& newVendor, std::string const& newLibrary, std::string const& newName, std::string const& newVersion) const; @@ -473,31 +473,31 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Get the abstraction reference string of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Abstraction reference if only a single abstraction type exists, otherwise [multiple]. + * @return Abstraction reference if only a single abstraction type exists, otherwise [multiple]. */ std::string getAbstractionReferenceString(std::string const& busName) const; /*! * Get the list of abstraction references of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return String list of the abstraction references. + * @return String list of the abstraction references. */ std::vector getAbstractionReferences(std::string const& busName) const; /*! * Add a new abstraction type to the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newVendor Vendor of the new abstraction type. - * @param [in] newLibrary Library of the new abstraction type. - * @param [in] newName Name of the new abstraction type. - * @param [in] newVersion Version of the new abstraction type. + * @param [in] busName Name of the selected bus interface. + * @param [in] newVendor Vendor of the new abstraction type. + * @param [in] newLibrary Library of the new abstraction type. + * @param [in] newName Name of the new abstraction type. + * @param [in] newVersion Version of the new abstraction type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addAbstractionType(std::string const& busName, std::string const& newVendor, std::string const& newLibrary, std::string const& newName, std::string const& newVersion) const; @@ -505,220 +505,220 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Remove all the abstraction types from the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if successfull, false otherwise. + * @return True, if successfull, false otherwise. */ bool removeAbstractionTypes(std::string const& busName); /*! * Get the calculated range value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] baseNumber Base for displaying the value. + * @param [in] busName Name of the selected bus interface. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated range value of the selected bus interface. + * @return Calculated range value of the selected bus interface. */ std::string getRangeValue(std::string const& busName, int const& baseNumber = 0) const; /*! * Get the formatted range expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Formatted range expression of the selected bus interface. + * @return Formatted range expression of the selected bus interface. */ std::string getRangeFormattedExpression(std::string const& busName) const; /*! * Get the range expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Range expression of the selected bus interface. + * @return Range expression of the selected bus interface. */ std::string getRangeExpression(std::string const& busName) const; /*! * Set the range for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newRange New range value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newRange New range value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRange(std::string const& busName, std::string const& newRange); /*! * Get the calculated remap address value of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] baseNumber Base for displaying the value. + * @param [in] busName Name of the selected bus interface. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated remap address value of the selected bus interface. + * @return Calculated remap address value of the selected bus interface. */ std::string getRemapAddressValue(std::string const& busName, int const& baseNumber = 0) const; /*! * Get the formatted remap address expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Formatted remap address expression of the selected bus interface. + * @return Formatted remap address expression of the selected bus interface. */ std::string getRemapAddressFormattedExpression(std::string const& busName) const; /*! * Get the remap address expression of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Remap address expression of the selected bus interface. + * @return Remap address expression of the selected bus interface. */ std::string getRemapAddressExpression(std::string const& busName) const; /*! * Set the remap address for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newRemapAddress New remap address value. + * @param [in] busName Name of the selected bus interface. + * @param [in] newRemapAddress New remap address value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRemapAddress(std::string const& busName, std::string const& newRemapAddress); /*! * Get the monitor interface mode of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Monitor interface mode of the selected bus interface. + * @return Monitor interface mode of the selected bus interface. */ General::InterfaceMode getMonitorMode(std::string const& busName) const; /*! * Set the monitor interface mode for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newMode New monitor interface mode. + * @param [in] busName Name of the selected bus interface. + * @param [in] newMode New monitor interface mode. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMonitorMode(std::string const& busName, std::string const& newMode); /*! * Get the monitor system group of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Monitor system group of the selected bus interface. + * @return Monitor system group of the selected bus interface. */ std::string getMonitorGroup(std::string const& busName) const; /*! * Set the monitor system group for the selected bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] newGroup New monitor system group. + * @param [in] busName Name of the selected bus interface. + * @param [in] newGroup New monitor system group. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMonitorGroup(std::string const& busName, std::string const& newGroup); /*! * Add a new bus interface. * - * @param [in] newBusIndex Index of the new bus interface. - * @param [in] busName Name of the new bus interface. + * @param [in] newBusIndex Index of the new bus interface. + * @param [in] busName Name of the new bus interface. */ void addBusInterface(int const& newBusIndex, std::string const& busName = ""); /*! * Swap the selected bus interfaces. * - * @param [in] firstIndex Index of the first bus interface. - * @param [in] secondIndex Index of the second bus interface. + * @param [in] firstIndex Index of the first bus interface. + * @param [in] secondIndex Index of the second bus interface. */ void swapBusInterfaces(int const& firstIndex, int const& secondIndex); /*! * Remove the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeBusInterface(std::string const& busName); /*! * Check if the selected bus interface exists. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return True, if the bus interface exists, false otherwise. + * @return True, if the bus interface exists, false otherwise. */ bool busInterfaceExists(std::string const& busName) const; /*! * Get the interface for accessing transparent bridges. * - * @return Interface for accessing transparent bridges. + * @return Interface for accessing transparent bridges. */ TransparentBridgeInterface* getBridgeInterface(); /*! * Get the interface for accessing file sets. * - * @return Interface for accessing file sets. + * @return Interface for accessing file sets. */ FileSetInterface* getFileSetInterface() const; /*! * Get the interface for accessing memory maps. * - * @return Interface for accessing memory maps. + * @return Interface for accessing memory maps. */ MemoryMapInterface* getMemoryMapInterface() const; /*! * Get the interface for accessing abstraction types. * - * @return Interface for accessing abstraction types. + * @return Interface for accessing abstraction types. */ AbstractionTypeInterface* getAbstractionTypeInterface() const; /*! * Get the validator for bus interfaces. * - * @return Validator for bus interfaces. + * @return Validator for bus interfaces. */ QSharedPointer getValidator() const; /*! * Get the transparent bridges of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Transparent bridges of the selected bus interface. + * @return Transparent bridges of the selected bus interface. */ QSharedPointer > > getBridges(std::string const& busName) const; /*! * Create or get existing transparent bridges pointer of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Pointer to the transparent bridges of the selected bus interface. + * @return Pointer to the transparent bridges of the selected bus interface. */ QSharedPointer > > createBridges(std::string const& busName); /*! * Get all the references made to the selected parameter in the selected bus interface. * - * @param [in] itemName Name of the selected bus interface. - * @param [in] valueID ID of the target parameter. + * @param [in] itemName Name of the selected bus interface. + * @param [in] valueID ID of the target parameter. * - * @return Number of references made to the given parameter in the selected bus interface. + * @return Number of references made to the given parameter in the selected bus interface. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override; @@ -726,30 +726,30 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Get all the expressions in the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return List of the expressions in the selected bus interface. + * @return List of the expressions in the selected bus interface. */ std::vector getAllExpressions(std::string const& busName) const; /*! * Copy the selected bus interfaces. * - * @param [in] selectedRows Indexes of the selected bus interfaces. + * @param [in] selectedRows Indexes of the selected bus interfaces. */ void copyRows(std::vector selectedRows); /*! * Paste the selected bus interfaces. * - * @return Names of the pasted bus interfaces. + * @return Names of the pasted bus interfaces. */ std::vector pasteRows(); /*! * Get the number of pasted bus interfaces. * - * @return Number of the pasted bus interfaces. + * @return Number of the pasted bus interfaces. */ int getPasteRowCount() const; @@ -762,90 +762,90 @@ class KACTUS2_API BusInterfaceInterface : public ParameterizableInterface, publi /*! * Get the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return The selected bus interface. + * @return The selected bus interface. */ QSharedPointer getBusInterface(std::string const& busName) const; /*! * Get the bus interface with the selected name, sliced to a NameGroup. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return The sliced port abstraction with the selected name. + * @return The sliced port abstraction with the selected name. */ QSharedPointer getItem(std::string const& busName) const override; /*! * Get the selected master bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected master bus interface. + * @return The selected master bus interface. */ QSharedPointer getInitiatorInterface(std::string const& busName) const; /*! * Create or get an existing master for the selected bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected master bus interface. + * @return The selected master bus interface. */ QSharedPointer createInitiatorForBusInterface(std::string const& busName); /*! * Get the selected slave bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected slave bus interface. + * @return The selected slave bus interface. */ QSharedPointer getTargetInterface(std::string const& busName) const; /*! * Create or get an existing slave for the selected bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected slave bus interface. + * @return The selected slave bus interface. */ QSharedPointer createTargetForBusInterface(std::string const& busName); /*! * Get the selected mirrored slave bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected mirrored slave bus interface. + * @return The selected mirrored slave bus interface. */ QSharedPointer getMirroredSlaveInterface(std::string const& busName) const; /*! * Create or get an existing mirrored slave for the selected bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected mirrored slave bus interface. + * @return The selected mirrored slave bus interface. */ QSharedPointer createMirrorSlaveForBusInterface(std::string const& busName); /*! * Get the selected monitor bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected monitor bus interface. + * @return The selected monitor bus interface. */ QSharedPointer getMonitorInterface(std::string const& busName) const; /*! * Create or get an existing monitor for the selected bus interface. * - * @param [in] busName Name of the containing bus interface. + * @param [in] busName Name of the containing bus interface. * - * @return The selected monitor bus interface. + * @return The selected monitor bus interface. */ QSharedPointer createMonitorForBusInterface(std::string const& busName); diff --git a/KactusAPI/include/BusInterfaceInterfaceFactory.h b/KactusAPI/include/BusInterfaceInterfaceFactory.h index 6d9d578c4..ff16f3033 100644 --- a/KactusAPI/include/BusInterfaceInterfaceFactory.h +++ b/KactusAPI/include/BusInterfaceInterfaceFactory.h @@ -43,13 +43,13 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing bus interfaces. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] component The containing component. - * @param [in] library Interface for accessing the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] component The containing component. + * @param [in] library Interface for accessing the library. * - * @return Interface for accessing bus interfaces. + * @return Interface for accessing bus interfaces. */ KACTUS2_API BusInterfaceInterface* createBusInterface( QSharedPointer parameterFinder, @@ -63,15 +63,15 @@ namespace BusInterfaceInterfaceFactory /*! * Create the common items in an interface for accessing bus interfaces. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] component The containing component. - * @param [in] library Interface for accessing the library. - * @param [in] portMapValidator Validator for port maps. - * @param [in] abstractionInterface Interface for accessing abstraction types. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] component The containing component. + * @param [in] library Interface for accessing the library. + * @param [in] portMapValidator Validator for port maps. + * @param [in] abstractionInterface Interface for accessing abstraction types. * - * @return Interface for accessing bus interfaces. + * @return Interface for accessing bus interfaces. */ BusInterfaceInterface* createCommonBusInterfaceItems( QSharedPointer parameterFinder, @@ -85,12 +85,12 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing file sets. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] component The containing component. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] component The containing component. * - * @return Interface for accessing file sets. + * @return Interface for accessing file sets. */ FileSetInterface* createFileSetInterface(QSharedPointer parameterFinder, QSharedPointer expressionFormatter, @@ -100,13 +100,13 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing memory maps. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] parameterValidator Validator for parameters. - * @param [in] component The containing component. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] parameterValidator Validator for parameters. + * @param [in] component The containing component. * - * @return Interface for accessing memory maps. + * @return Interface for accessing memory maps. */ MemoryMapInterface* createMapInterface(QSharedPointer parameterFinder, QSharedPointer expressionFormatter, @@ -117,14 +117,14 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing abstraction types. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] portMapValidator The VLNV library. - * @param [in] component The containing component. - * @param [in] library Interface for accessing the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] portMapValidator The VLNV library. + * @param [in] component The containing component. + * @param [in] library Interface for accessing the library. * - * @return Interface for accessing abstraction types. + * @return Interface for accessing abstraction types. */ AbstractionTypeInterface* createAbstractionTypeInterface( QSharedPointer parameterFinder, @@ -137,13 +137,13 @@ namespace BusInterfaceInterfaceFactory /*! * Create the common properties of an abstraction type interface. * - * @param [in] expressionParser Parser for expressions. - * @param [in] component The containing component. - * @param [in] portMapValidator Validator for port maps. - * @param [in] library The VLNV library. - * @param [in] portMapInterface Interface for accessing the port maps. + * @param [in] expressionParser Parser for expressions. + * @param [in] component The containing component. + * @param [in] portMapValidator Validator for port maps. + * @param [in] library The VLNV library. + * @param [in] portMapInterface Interface for accessing the port maps. * - * @return Interface for accessing the abstraction types. + * @return Interface for accessing the abstraction types. */ AbstractionTypeInterface* createCommonAbstractionTypeInterface( QSharedPointer expressionParser, @@ -155,13 +155,13 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing port maps. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] portMapValidator Validator for port maps. - * @param [in] component The containing component. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] portMapValidator Validator for port maps. + * @param [in] component The containing component. * - * @return Interface for accessing port maps. + * @return Interface for accessing port maps. */ PortMapInterface* createPortMapInterface( QSharedPointer parameterFinder, @@ -173,10 +173,10 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing transparent bridges. * - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. * - * @return Interface for accessing transparent bridges. + * @return Interface for accessing transparent bridges. */ TransparentBridgeInterface* createBridgeInterface(QSharedPointer expressionFormatter, QSharedPointer expressionParser); @@ -184,11 +184,11 @@ namespace BusInterfaceInterfaceFactory /*! * Create the interface for accessing parameters. * - * @param [in] validator Validator for parameters. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. + * @param [in] validator Validator for parameters. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. * - * @return The interface for accessing parameters. + * @return The interface for accessing parameters. */ ParametersInterface* createParameterInterface(QSharedPointer validator, QSharedPointer expressionParser, diff --git a/KactusAPI/include/BusInterfaceUtilities.h b/KactusAPI/include/BusInterfaceUtilities.h index dbae87fb8..ec33e09bf 100644 --- a/KactusAPI/include/BusInterfaceUtilities.h +++ b/KactusAPI/include/BusInterfaceUtilities.h @@ -31,10 +31,10 @@ namespace BusInterfaceUtilities /*! * Checks if the selected bus definitions match. * - * @param [in] firstDefinition The first bus definition. - * @param [in] secondDefinitionVLNV VLNV of the second bus definition. + * @param [in] firstDefinition The first bus definition. + * @param [in] secondDefinitionVLNV VLNV of the second bus definition. * - * @return True, if the bus definitions match, false otherwise. + * @return True, if the bus definitions match, false otherwise. */ KACTUS2_API bool hasMatchingBusDefinitions(QSharedPointer firstDefinition, VLNV const& secondDefinitionVLNV, LibraryInterface* library); @@ -42,11 +42,11 @@ namespace BusInterfaceUtilities /*! * Check if the selected bus definition VLNVs can be connected. * - * @param [in] firstDefinitionVLNV The first VLNV. - * @param [in] secondDefinitionVLNV The second VLNV. - * @param [in] library Access to the library. + * @param [in] firstDefinitionVLNV The first VLNV. + * @param [in] secondDefinitionVLNV The second VLNV. + * @param [in] library Access to the library. * - * @return True, if the selected bus definition VLNVs can be connected, false otherwise. + * @return True, if the selected bus definition VLNVs can be connected, false otherwise. */ KACTUS2_API bool busDefinitionVLNVsMatch(VLNV const& firstDefinitionVLNV, VLNV const& secondDefinitionVLNV, LibraryInterface* library); @@ -54,9 +54,9 @@ namespace BusInterfaceUtilities /*! * Get the path for the icon of the bus interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. * - * @return Path for the bus interface mode icon. + * @return Path for the bus interface mode icon. */ KACTUS2_API QString getIconPath(General::InterfaceMode busMode); } diff --git a/KactusAPI/include/CLIGenerator.h b/KactusAPI/include/CLIGenerator.h index 90ce189a2..558ccd3bf 100644 --- a/KactusAPI/include/CLIGenerator.h +++ b/KactusAPI/include/CLIGenerator.h @@ -35,19 +35,19 @@ class CLIGenerator /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const = 0; /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, diff --git a/KactusAPI/include/CommonInterface.h b/KactusAPI/include/CommonInterface.h index 3475b2a28..4e3505ebe 100644 --- a/KactusAPI/include/CommonInterface.h +++ b/KactusAPI/include/CommonInterface.h @@ -38,21 +38,21 @@ class KACTUS2_API CommonInterface /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const = 0; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const = 0; /*! * Validates the contained items. * - * @return True, if all the items are valid, false otherwise. + * @return True, if all the items are valid, false otherwise. */ virtual bool validateItems() const = 0; @@ -65,19 +65,19 @@ class KACTUS2_API CommonInterface /*! * Transform the selected name to a unique item name. * - * @param [in] newName The selected name. + * @param [in] newName The selected name. * - * @return A unique name derived from the selected name. + * @return A unique name derived from the selected name. */ QString getUniqueName(std::string const& newName, std::string const& itemTypeName) const; /*! * Check if the new name is different from the current name. * - * @param [in] newName The new name. - * @param [in] oldName The current name. + * @param [in] newName The new name. + * @param [in] oldName The current name. * - * @return True, if the new name is different, false otherwise. + * @return True, if the new name is different, false otherwise. */ bool nameHasChanged(std::string const& newName, std::string const& oldName) const; @@ -86,9 +86,9 @@ class KACTUS2_API CommonInterface /*! * Check if the selected name is unique. * - * @param [in] portName The selected name. + * @param [in] portName The selected name. * - * @return True, if the selected name is unique, false otherwise. + * @return True, if the selected name is unique, false otherwise. */ bool nameIsUnique(std::string_view name, std::vector const& reservedNamed) const; }; diff --git a/KactusAPI/include/ComponentAndInstantiationsParameterFinder.h b/KactusAPI/include/ComponentAndInstantiationsParameterFinder.h index 471cf4da8..fad7789b1 100644 --- a/KactusAPI/include/ComponentAndInstantiationsParameterFinder.h +++ b/KactusAPI/include/ComponentAndInstantiationsParameterFinder.h @@ -29,7 +29,7 @@ class KACTUS2_API ComponentAndInstantiationsParameterFinder : public ComponentPa /*! * Constructor. * - * @param [in] component The component which parameters are being searched for. + * @param [in] component The component which parameters are being searched for. */ explicit ComponentAndInstantiationsParameterFinder(QSharedPointer component) noexcept; @@ -46,21 +46,21 @@ class KACTUS2_API ComponentAndInstantiationsParameterFinder : public ComponentPa /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the component. * - * @return The number of parameters in the component. + * @return The number of parameters in the component. */ int getNumberOfParameters() const final; /*! * Get all the instantiation parameters. * - * @return The instantiation parameters. + * @return The instantiation parameters. */ QList > allInstantiationsParameters() const; @@ -69,9 +69,9 @@ class KACTUS2_API ComponentAndInstantiationsParameterFinder : public ComponentPa /*! * Get the selected parameter. * - * @param [in] parameterId ID of the selected parameter. + * @param [in] parameterId ID of the selected parameter. * - * @return The selected parameter. + * @return The selected parameter. */ QSharedPointer searchParameter(QStringView parameterId) const final; }; diff --git a/KactusAPI/include/ComponentInstanceInterface.h b/KactusAPI/include/ComponentInstanceInterface.h index 6f1ed6ff4..4990252d2 100644 --- a/KactusAPI/include/ComponentInstanceInterface.h +++ b/KactusAPI/include/ComponentInstanceInterface.h @@ -33,8 +33,8 @@ class KACTUS2_API ComponentInstanceInterface : public NameGroupInterface /*! * The constructor. * - * @param [in] connectionInterface Interface for accessing interconnections. - * @param [in] adHocInterface Interface for accessing ad hoc connections. + * @param [in] connectionInterface Interface for accessing interconnections. + * @param [in] adHocInterface Interface for accessing ad hoc connections. */ ComponentInstanceInterface(InterconnectionInterface* connectionInterface, AdHocConnectionInterface* adHocInterface); @@ -47,106 +47,106 @@ class KACTUS2_API ComponentInstanceInterface : public NameGroupInterface /*! * Setup the component instances. * - * @param [in] newDesign Design containing the component instances. + * @param [in] newDesign Design containing the component instances. */ void setComponentInstances(QSharedPointer newDesign); /*! * Get index of the selected component instance. * - * @param [in] itemName Name of the selected component instance. + * @param [in] itemName Name of the selected component instance. * - * @return Index of the selected component instance. + * @return Index of the selected component instance. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed component instance. * - * @param [in] itemIndex Index of the selected component instance. + * @param [in] itemIndex Index of the selected component instance. * - * @return Name of the selected component instance. + * @return Name of the selected component instance. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available component instances. * - * @return Number of available component instances. + * @return Number of available component instances. */ virtual int itemCount() const override final; /*! * Get the names of the available component instances. * - * @return Names of the available component instances. + * @return Names of the available component instances. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected component instance. * - * @param [in] currentName Name of the selected component instance. - * @param [in] newName New name for the component instance. + * @param [in] currentName Name of the selected component instance. + * @param [in] newName New name for the component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the description of the selected component instance. * - * @param [in] itemName Name of the selected component instance. + * @param [in] itemName Name of the selected component instance. * - * @return Description of the selected component instance. + * @return Description of the selected component instance. */ virtual std::string getDescription(std::string const& itemName) const override final; /*! * Set a new description for the selected component instance. * - * @param [in] itemName Name of the selected component instance. - * @param [in] newDescription New description. + * @param [in] itemName Name of the selected component instance. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setDescription(std::string const& itemName, std::string const& newDescription) override final; /*! * Validates the contained component instances. * - * @return True, if all the component instances are valid, false otherwise. + * @return True, if all the component instances are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected component instance has a valid name. * - * @param [in] itemName Name of the selected component instance. + * @param [in] itemName Name of the selected component instance. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Get the VLNV of the referenced component of the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return VLNV of the referenced component. + * @return VLNV of the referenced component. */ QSharedPointer getComponentReference(std::string const& instanceName) const; /*! * Set a new component reference for the selected component instance. * - * @param [in] instanceName Name of the selected component instance. - * @param [in] newVendor Vendor of the new component reference. - * @param [in] newLibrary Library of the new component reference. - * @param [in] newName Name of the new component reference. - * @param [in] newVersion Version of the new component reference. + * @param [in] instanceName Name of the selected component instance. + * @param [in] newVendor Vendor of the new component reference. + * @param [in] newLibrary Library of the new component reference. + * @param [in] newName Name of the new component reference. + * @param [in] newVersion Version of the new component reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setComponentReference(std::string const& instanceName, std::string const& newVendor, std::string const& newLibrary, std::string const& newName, std::string const& newVersion); @@ -154,25 +154,25 @@ class KACTUS2_API ComponentInstanceInterface : public NameGroupInterface /*! * Add a new component instance. * - * @param [in] instanceName Name of the new component instance. + * @param [in] instanceName Name of the new component instance. */ void addComponentInstance(std::string const& instanceName = ""); /*! * Remove the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeComponentInstance(std::string const& instanceName); /*! * Check if the selected component instance exists. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if the component instance exists, false otherwise. + * @return True, if the component instance exists, false otherwise. */ bool instanceExists(std::string const& instanceName) const; @@ -185,18 +185,18 @@ class KACTUS2_API ComponentInstanceInterface : public NameGroupInterface /*! * Get the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return The selected component instance. + * @return The selected component instance. */ QSharedPointer getComponentInstance(std::string const& instanceName) const; /*! * Get the paracomponent instancemeter with the selected name, sliced to a NameGroup. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return The sliced component instance with the selected name. + * @return The sliced component instance with the selected name. */ QSharedPointer getItem(std::string const& instanceName) const; diff --git a/KactusAPI/include/ComponentInstanceParameterFinder.h b/KactusAPI/include/ComponentInstanceParameterFinder.h index 5d186e1db..d1ab49519 100644 --- a/KactusAPI/include/ComponentInstanceParameterFinder.h +++ b/KactusAPI/include/ComponentInstanceParameterFinder.h @@ -34,8 +34,8 @@ class KACTUS2_API ComponentInstanceParameterFinder : public ParameterCache /*! * Constructor. * - * @param [in] componentInstance The component instance whose parameters are being searched for. - * @param [in] component The instantiated component. + * @param [in] componentInstance The component instance whose parameters are being searched for. + * @param [in] component The instantiated component. */ ComponentInstanceParameterFinder(QSharedPointer componentInstance, QSharedPointer component); @@ -53,9 +53,9 @@ class KACTUS2_API ComponentInstanceParameterFinder : public ParameterCache /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; diff --git a/KactusAPI/include/ComponentInstantiationInterface.h b/KactusAPI/include/ComponentInstantiationInterface.h index bde7a58d7..c0e6860fe 100644 --- a/KactusAPI/include/ComponentInstantiationInterface.h +++ b/KactusAPI/include/ComponentInstantiationInterface.h @@ -35,13 +35,13 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * The constructor. * - * @param [in] validator Validator for address blocks. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] parameterInterface Interface for accessing parameters. - * @param [in] moduleParameterInterface Interface for accessing module parameters - * @param [in] fileBuilderInterface Interface for accessing file builders. - * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] validator Validator for address blocks. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] moduleParameterInterface Interface for accessing module parameters + * @param [in] fileBuilderInterface Interface for accessing file builders. + * @param [in] fileSetInterface Interface for accessing file sets. */ ComponentInstantiationInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -59,7 +59,7 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * Set available component instantiations. * - * @param [in] newInstantiations The new component instantiations. + * @param [in] newInstantiations The new component instantiations. */ void setComponentInstantiations( QSharedPointer > > newInstantiations); @@ -67,71 +67,71 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the display name of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Display name of the selected item. + * @return Display name of the selected item. */ std::string getDisplayName(std::string const& itemName) const; /*! * Set the display name of the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] newDisplayName New display name for the item. + * @param [in] itemName Name of the selected item. + * @param [in] newDisplayName New display name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDisplayName(std::string const& itemName, std::string const& newDisplayName); /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -139,222 +139,222 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * Get the expressions in the selected component instantiations. * - * @param [in] instantiationNames Names of the selected component instantiations. + * @param [in] instantiationNames Names of the selected component instantiations. * - * @return Expressions in the selected component instantiations. + * @return Expressions in the selected component instantiations. */ std::vector getExpressionsInSelectedItems(std::vector instantiationNames) const; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Add a new component instantiation. * - * @param [in] row Row of the new component instantiation. - * @param [in] newInstantiationName Name of the new component instantiation. + * @param [in] row Row of the new component instantiation. + * @param [in] newInstantiationName Name of the new component instantiation. */ void addComponentInstantiation(int const& row, std::string const& newInstantiationName = std::string("")); /*! * Remove the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeComponentInstantiation(std::string const& instantiationName); /*! * Get the parameter interface. * - * @return Interface for accessing parameters. + * @return Interface for accessing parameters. */ ParametersInterface* getParameterInterface() const; /*! * Get the module parameter interface. * - * @return Interface for accessing module parameters. + * @return Interface for accessing module parameters. */ ModuleParameterInterface* getModuleParameterInterface() const; /*! * Get the file builder interface. * - * @return Interface for accessing file builders. + * @return Interface for accessing file builders. */ FileBuilderInterface* getFileBuilderInterface() const; /*! * Get the file set interface. * - * @return Interface for accessing file sets. + * @return Interface for accessing file sets. */ FileSetInterface* getFileSetInterface() const; /*! * Get the language of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Language of the selected component instantiation. + * @return Language of the selected component instantiation. */ std::string getLanguage(std::string const& instantiationName) const; /*! * Set a new language for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newLanguage New language. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newLanguage New language. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLanguage(std::string const& instantiationName, std::string const& newLanguage); /*! * Check if the language of the selected component instantiation is strict. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Language strictness of the selected component instantiation. + * @return Language strictness of the selected component instantiation. */ bool isLanguageStrict(std::string const& instantiationName) const; /*! * Set language strictness for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newStrictness The new language strictness. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newStrictness The new language strictness. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLanguageStrictness(std::string const& instantiationName, bool newStrictness); /*! * Get the library name of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Library name of the selected component instantiation. + * @return Library name of the selected component instantiation. */ std::string getLibraryName(std::string const& instantiationName) const; /*! * Set a new library name for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newLibraryName The new library name. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newLibraryName The new library name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLibraryName(std::string const& instantiationName, std::string const& newLibraryName); /*! * Get the package name of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Package name of the selected component instantiation. + * @return Package name of the selected component instantiation. */ std::string getPackageName(std::string const& instantiationName) const; /*! * Set a new package name for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newPackageName The new library name. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newPackageName The new library name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPackageName(std::string const& instantiationName, std::string const& newPackageName); /*! * Get the module name of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Module name of the selected component instantiation. + * @return Module name of the selected component instantiation. */ std::string getModuleName(std::string const& instantiationName) const; /*! * Set a new module name for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newModuleName The new module name. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newModuleName The new module name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setModuleName(std::string const& instantiationName, std::string const& newModuleName); /*! * Get the architecture name of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Architecture name of the selected component instantiation. + * @return Architecture name of the selected component instantiation. */ std::string getArchitectureName(std::string const& instantiationName) const; /*! * Set a new architecture name for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newArchitectureName The new module name. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newArchitectureName The new module name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setArchitectureName(std::string const& instantiationName, std::string const& newArchitectureName); /*! * Get the configuration name of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return Configuration name of the selected component instantiation. + * @return Configuration name of the selected component instantiation. */ std::string getConfigurationName(std::string const& instantiationName) const; /*! * Set a new configuration name for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newConfigurationName The new module name. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newConfigurationName The new module name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setConfigurationName(std::string const& instantiationName, std::string const& newConfigurationName); /*! * Get the file set references of the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. * - * @return File set references of the selected component instantiation. + * @return File set references of the selected component instantiation. */ std::vector getFileSetReferences(std::string const& instantiationName) const; /*! * Set new file set references for the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. - * @param [in] newReferences The new file set references. + * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] newReferences The new file set references. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setFileSetReferences(std::string const& instantiationName, std::vector const& newReferences); @@ -364,9 +364,9 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * Get the selected component instantiation. * - * @param [in] itemName Name of the selected component instantiation. + * @param [in] itemName Name of the selected component instantiation. * - * @return The selected component instantiation. + * @return The selected component instantiation. */ QSharedPointer getComponentInstantiation(std::string const& itemName) const; @@ -374,9 +374,9 @@ class KACTUS2_API ComponentInstantiationInterface : public ParameterizableInterf /*! * Get the component instantiation with the selected name, sliced to a NameGroup. * - * @param [in] itemName Name of the selected component instantiation. + * @param [in] itemName Name of the selected component instantiation. * - * @return The sliced component instantiation with the selected name. + * @return The sliced component instantiation with the selected name. */ QSharedPointer getItem(std::string const& itemName) const override; diff --git a/KactusAPI/include/ComponentInstantiationParameterFinder.h b/KactusAPI/include/ComponentInstantiationParameterFinder.h index 075788d09..7e2e519b0 100644 --- a/KactusAPI/include/ComponentInstantiationParameterFinder.h +++ b/KactusAPI/include/ComponentInstantiationParameterFinder.h @@ -31,7 +31,7 @@ class KACTUS2_API ComponentInstantiationParameterFinder : public ParameterFinder /*! * Constructor. * - * @param [in] componentInstantiation The element which parameters are being searched for. + * @param [in] componentInstantiation The element which parameters are being searched for. */ explicit ComponentInstantiationParameterFinder(QSharedPointer componentInstantiation); @@ -48,48 +48,48 @@ class KACTUS2_API ComponentInstantiationParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const final; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; /*! * Gets all of the ids of components instantiation parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the component instantiation. * - * @return The number of parameters in the component instantiation. + * @return The number of parameters in the component instantiation. */ int getNumberOfParameters() const final; @@ -101,7 +101,7 @@ class KACTUS2_API ComponentInstantiationParameterFinder : public ParameterFinder /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; diff --git a/KactusAPI/include/ComponentParameterFinder.h b/KactusAPI/include/ComponentParameterFinder.h index 5849729d4..398781018 100644 --- a/KactusAPI/include/ComponentParameterFinder.h +++ b/KactusAPI/include/ComponentParameterFinder.h @@ -30,7 +30,7 @@ class KACTUS2_API ComponentParameterFinder : public ParameterFinder /*! * Constructor. * - * @param [in] component The component which parameters are being searched for. + * @param [in] component The component which parameters are being searched for. */ explicit ComponentParameterFinder(QSharedPointer component) noexcept; @@ -48,62 +48,62 @@ class KACTUS2_API ComponentParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const override; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const override; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const override; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const override; /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ virtual QStringList getAllParameterIds() const override; /*! * Gets the number of parameters in the component. * - * @return The number of parameters in the component. + * @return The number of parameters in the component. */ virtual int getNumberOfParameters() const override; /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ virtual void registerParameterModel(QAbstractItemModel const* model) override; /*! * Set a new component for the parameter finder. * - * @param [in] component The new component. + * @param [in] component The new component. */ virtual void setComponent(QSharedPointer component); @@ -115,7 +115,7 @@ class KACTUS2_API ComponentParameterFinder : public ParameterFinder /*! * Finds all the parameters in component bus interfaces. * - * @return The parameters in all bus interfaces. + * @return The parameters in all bus interfaces. */ QList > allBusInterfaceParameters() const; @@ -132,14 +132,14 @@ class KACTUS2_API ComponentParameterFinder : public ParameterFinder /*! * Finds all the parameters in component registers. * - * @return The parameters in all registers. + * @return The parameters in all registers. */ QList > allRegisterParameters() const; /*! * Get all the parameters in indirect interfaces. * - * @return The parameters in indirect interfaces. + * @return The parameters in indirect interfaces. */ QList > allIndirectInterfacesParameters() const; @@ -153,7 +153,7 @@ class KACTUS2_API ComponentParameterFinder : public ParameterFinder /*! * Get the component. * - * @return The contained component. + * @return The contained component. */ QSharedPointer getComponent() const noexcept; diff --git a/KactusAPI/include/DesignParameterFinder.h b/KactusAPI/include/DesignParameterFinder.h index 3ce6eb6aa..3d1560170 100644 --- a/KactusAPI/include/DesignParameterFinder.h +++ b/KactusAPI/include/DesignParameterFinder.h @@ -31,7 +31,7 @@ class KACTUS2_API DesignParameterFinder : public ListParameterFinder /*! * The constructor. * - * @param [in] designInstantiation The design instantiation whose parameters are being searched for. + * @param [in] designInstantiation The design instantiation whose parameters are being searched for. */ DesignParameterFinder(QSharedPointer designInstantiation); @@ -48,9 +48,9 @@ class KACTUS2_API DesignParameterFinder : public ListParameterFinder /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; diff --git a/KactusAPI/include/DocumentValidator.h b/KactusAPI/include/DocumentValidator.h index 247ae0b7e..627c872a7 100644 --- a/KactusAPI/include/DocumentValidator.h +++ b/KactusAPI/include/DocumentValidator.h @@ -63,7 +63,7 @@ class DocumentValidator /*! * Change the component used in the component validator parameter finder. * - * @param [in] targetComponent The new component. + * @param [in] targetComponent The new component. */ void changeComponentValidatorParameterFinder(QSharedPointer targetComponent); @@ -71,40 +71,40 @@ class DocumentValidator /*! * Finds any errors within a given bus definition document. * - * @param [in] busDefinition The bus definition to search in. - * @param [out] errorList The list of errors to add any found errors. + * @param [in] busDefinition The bus definition to search in. + * @param [out] errorList The list of errors to add any found errors. */ void findErrorsInBusDefinition(QSharedPointer busDefinition, QVector& errorList); /*! * Finds any errors within a given abstraction definition document. * - * @param [in] abstraction The bus definition to search in. - * @param [out] errorList The list of errors to add any found errors. + * @param [in] abstraction The bus definition to search in. + * @param [out] errorList The list of errors to add any found errors. */ void findErrorsInAbstractionDefinition(QSharedPointer abstraction, QVector& errorList); /*! * Finds any errors within a given component. * - * @param [in] component The selected component. - * @param [in] errorList The list of errors. + * @param [in] component The selected component. + * @param [in] errorList The list of errors. */ void findErrorsInComponent(QSharedPointer component, QVector& errorList); /*! * Finds any errors within a given design. * - * @param [in] design The selected design. - * @param [in] errorList The list of errors. + * @param [in] design The selected design. + * @param [in] errorList The list of errors. */ void findErrorsInDesign(QSharedPointer design, QVector& errorList); /*! * Finds any errors within a given design configuration. * - * @param [in] configuration The selected design configuration. - * @param [in] errorList The list of errors. + * @param [in] configuration The selected design configuration. + * @param [in] errorList The list of errors. */ void findErrorsInDesignConfiguration(QSharedPointer configuration, QVector& errorList); diff --git a/KactusAPI/include/ExpressionFormatter.h b/KactusAPI/include/ExpressionFormatter.h index 2cbdbd8c2..267e58a72 100644 --- a/KactusAPI/include/ExpressionFormatter.h +++ b/KactusAPI/include/ExpressionFormatter.h @@ -31,7 +31,7 @@ class KACTUS2_API ExpressionFormatter /*! * Constructor. * - * @param [in] parameterFinder Parameter finder used to search the components parameters. + * @param [in] parameterFinder Parameter finder used to search the components parameters. */ ExpressionFormatter(QSharedPointer parameterFinder); @@ -43,9 +43,9 @@ class KACTUS2_API ExpressionFormatter /*! * Format an expression containing a reference to another parameter. * - * @param [in] expression The expression being worked on. + * @param [in] expression The expression being worked on. * - * @return Formatted expression. + * @return Formatted expression. */ QString formatReferringExpression(QString const& expression) const; diff --git a/KactusAPI/include/ExpressionFormatterFactory.h b/KactusAPI/include/ExpressionFormatterFactory.h index 770756670..1dc03296b 100644 --- a/KactusAPI/include/ExpressionFormatterFactory.h +++ b/KactusAPI/include/ExpressionFormatterFactory.h @@ -33,15 +33,15 @@ class ExpressionFormatterFactory /*! * Create an expression formatter using the given component. * - * @param [in] component Pointer to the component, whose parameters are used in the formatter. + * @param [in] component Pointer to the component, whose parameters are used in the formatter. */ virtual ExpressionFormatter* makeExpressionFormatter(QSharedPointer component) = 0; /*! * Create an expression formatter for a component instance within a design. * - * @param [in] component The component of the selected component instance. - * @param [in] design Design containing the component instance. + * @param [in] component The component of the selected component instance. + * @param [in] design Design containing the component instance. */ virtual ExpressionFormatter* createDesignInstanceFormatter(QSharedPointer component, QSharedPointer design) = 0; diff --git a/KactusAPI/include/ExpressionFormatterFactoryImplementation.h b/KactusAPI/include/ExpressionFormatterFactoryImplementation.h index d5e1ff021..ddb4b3dee 100644 --- a/KactusAPI/include/ExpressionFormatterFactoryImplementation.h +++ b/KactusAPI/include/ExpressionFormatterFactoryImplementation.h @@ -38,15 +38,15 @@ class KACTUS2_API ExpressionFormatterFactoryImplementation : public ExpressionFo /*! * Create an expression formatter using the given component. * - * @param [in] component Pointer to the component, whose parameters are used in the formatter. + * @param [in] component Pointer to the component, whose parameters are used in the formatter. */ virtual ExpressionFormatter* makeExpressionFormatter(QSharedPointer component); /*! * Create an expression formatter for a component instance within a design. * - * @param [in] component The component of the selected component instance. - * @param [in] design Design containing the component instance. + * @param [in] component The component of the selected component instance. + * @param [in] design Design containing the component instance. */ virtual ExpressionFormatter* createDesignInstanceFormatter(QSharedPointer component, QSharedPointer design); diff --git a/KactusAPI/include/ExpressionParser.h b/KactusAPI/include/ExpressionParser.h index e486cbf9c..f457b8a27 100644 --- a/KactusAPI/include/ExpressionParser.h +++ b/KactusAPI/include/ExpressionParser.h @@ -28,28 +28,28 @@ class ExpressionParser /*! * Parses an expression to decimal number. * - * @param [in] expression The expression to parse. - * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. + * @param [in] expression The expression to parse. + * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. * - * @return The decimal value of the evaluated expression. + * @return The decimal value of the evaluated expression. */ virtual QString parseExpression(QStringView expression, bool* validExpression = nullptr) const = 0; /*! * Checks if the given expression is a plain value and does not need evaluation. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a plain value, otherwise false. + * @return True, if the expression is a plain value, otherwise false. */ virtual bool isPlainValue(QStringView expression) const = 0; /*! * Finds the common base in the expression. * - * @param [in] expression The expression to search in. + * @param [in] expression The expression to search in. * - * @return The common base for the expression. + * @return The common base for the expression. */ virtual int baseForExpression(QStringView expression) const = 0; }; diff --git a/KactusAPI/include/ExpressionSupport.h b/KactusAPI/include/ExpressionSupport.h index d1d5251c4..d825af207 100644 --- a/KactusAPI/include/ExpressionSupport.h +++ b/KactusAPI/include/ExpressionSupport.h @@ -21,7 +21,7 @@ class ExpressionSupport /*! * Sets the expression parser to use for parsing expressions. * - * @param [in] parser The expression parser to use. + * @param [in] parser The expression parser to use. */ virtual void setExpressionParser(QSharedPointer parser) = 0; }; diff --git a/KactusAPI/include/FieldExpressionsGatherer.h b/KactusAPI/include/FieldExpressionsGatherer.h index 77d651a02..2b8ea1fc5 100644 --- a/KactusAPI/include/FieldExpressionsGatherer.h +++ b/KactusAPI/include/FieldExpressionsGatherer.h @@ -38,9 +38,9 @@ class FieldExpressionsGatherer /*! * Get the expressions from a given field. * - * @param [in] field The given field. + * @param [in] field The given field. * - * @return A list containing all the expressions used in a field. + * @return A list containing all the expressions used in a field. */ QStringList getExpressions(QSharedPointer field) const; diff --git a/KactusAPI/include/FieldInterface.h b/KactusAPI/include/FieldInterface.h index fcbc184fa..32b1dc4fe 100644 --- a/KactusAPI/include/FieldInterface.h +++ b/KactusAPI/include/FieldInterface.h @@ -43,10 +43,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * The constructor. * - * @param [in] validator Validator for fields. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] subInterface Interface for accessing resets. + * @param [in] validator Validator for fields. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] subInterface Interface for accessing resets. */ FieldInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -61,223 +61,223 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Set available fields. * - * @param [in] newFields The new fields. + * @param [in] newFields The new fields. */ void setFields(QSharedPointer > > newFields); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the calculated offset value of the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated offset value of the selected field. + * @return Calculated offset value of the selected field. */ std::string getOffsetValue(std::string const& fieldName, int const& baseNumber = 0) const; /*! * Get the formatted offset expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Formatted offset expression of the selected field. + * @return Formatted offset expression of the selected field. */ std::string getOffsetFormattedExpression(std::string const& fieldName) const; /*! * Get the offset expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Offset expression of the selected field. + * @return Offset expression of the selected field. */ std::string getOffsetExpression(std::string const& fieldName) const; /*! * Set a new offset value for the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] newOffset New offset value. + * @param [in] fieldName Name of the selected field. + * @param [in] newOffset New offset value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setOffset(std::string const& fieldName, std::string const& newOffset); /*! * Get the calculated bit width value of the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated bit width value of the selected parameter. + * @return Calculated bit width value of the selected parameter. */ std::string getWidthValue(std::string const& fieldName, int const& baseNumber = 0) const; /*! * Get the formatted bit width expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Formatted bit width expression of the selected field. + * @return Formatted bit width expression of the selected field. */ std::string getWidthFormattedExpression(std::string const& fieldName) const; /*! * Get the bit width expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Bit width expression of the selected field. + * @return Bit width expression of the selected field. */ std::string getWidthExpression(std::string const& fieldName) const; /*! * Set a new bit width value for the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] newWidth New bit width value. + * @param [in] fieldName Name of the selected field. + * @param [in] newWidth New bit width value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWidth(std::string const& fieldName, std::string const& newWidth); /*! * Get the reset values of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Reset values of the selected field. + * @return Reset values of the selected field. */ std::string getResets(std::string const& fieldName) const; /*! * Get the tooltip of the reset values of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Tooltip constructed from the reset values of the selected field. + * @return Tooltip constructed from the reset values of the selected field. */ std::string getResetsToolTip(std::string const& fieldName) const; /*! * Get the volatile status of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Volatile status of the selected field. + * @return Volatile status of the selected field. */ std::string getVolatile(std::string const& fieldName) const; /*! * Set the volatile status of the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] newVolatile The new volatile status of the selected field. + * @param [in] fieldName Name of the selected field. + * @param [in] newVolatile The new volatile status of the selected field. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setVolatile(std::string const& fieldName, std::string const& newVolatile); /*! * Get the access string of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return Access string of the selected field or field access policy. + * @return Access string of the selected field or field access policy. */ std::string getAccessString(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Get the access of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return Access of the selected field or field access policy. + * @return Access of the selected field or field access policy. */ AccessTypes::Access getAccessType(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set the access of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] newAccess The new access of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newAccess The new access of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAccess(std::string const& fieldName, std::string const& accessType, int accessPolicyIndex = -1) const; /*! * Get the modified write value string of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return Modified write value string of the selected field or field access policy. + * @return Modified write value string of the selected field or field access policy. */ std::string getModifiedWriteString(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Get the modified write value of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Modified write value of the selected field. + * @return Modified write value of the selected field. */ General::ModifiedWrite getModifiedWriteValue(std::string const& fieldName) const; /*! * Set the modified write value of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] newModifiedWrite The new modified write value of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newModifiedWrite The new modified write value of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setModifiedWrite(std::string const& fieldName, std::string const& newModifiedWrite, int accessPolicyIndex = -1); @@ -285,41 +285,41 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the read action string of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return Read action string of the selected field access policy of selected field. + * @return Read action string of the selected field access policy of selected field. */ std::string getReadActionString(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Get the read action of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field. * - * @return Read action of the selected field or field access policy. + * @return Read action of the selected field or field access policy. */ General::ReadAction getReadAction(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set the read action of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] newReadAction The new read action. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newReadAction The new read action. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setReadAction(std::string const& fieldName, std::string const& newReadAction, int accessPolicyIndex = -1); /*! * Get the testable string of the selected field access policy of a selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the selected field access policy. * - * @return Testable string of the selected field access policy. + * @return Testable string of the selected field access policy. */ std::string getTestableValue(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -327,10 +327,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Get the testable bool of the selected field or field access policy. Access policy index is provided * only when getting the testable value of a field access policy within a 2022 std revision field. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Testable bool of the selected field. + * @return Testable bool of the selected field. */ bool getTestableBool(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -339,11 +339,11 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Access policy index is provided only when setting a testable value of a field access policy within a * std revision 2022 field. * - * @param [in] fieldName Name of the selected field. - * @param [in] newTestable The new testable value of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newTestable The new testable value of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setTestable(std::string const& fieldName, std::string const& newTestable, int accessPolicyIndex = -1) const; @@ -352,10 +352,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Access policy index is provided only when getting the test constraint of a field access policy within a * 2022 std revision field. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Test constraint string of the selected field. + * @return Test constraint string of the selected field. */ std::string getTestConstraintString(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -363,10 +363,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Get the test constraint of the selected field or field access policy. Access policy index is provided * only when getting the test constraint of a field access policy within a 2022 std revision field. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Test constraint of the selected field. + * @return Test constraint of the selected field. */ General::TestConstraint getTestConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -374,205 +374,205 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Set the test constraint of the selected field or field access policy. Access policy index is provided * only when setting the test constraint of a field access policy within a 2022 std revision field. * - * @param [in] fieldName Name of the selected field. - * @param [in] newTestConstraint The new test constraint of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newTestConstraint The new test constraint of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setTestConstraint(std::string const& fieldName, std::string const& newTestConstraint, int accessPolicyIndex = -1) const; /*! * Get the calculated is present value of the selected field. * - * @param [in] fieldName Name of the selected field. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated is present value of the selected field. + * @return Calculated is present value of the selected field. */ std::string getIsPresentValue(std::string const& fieldName, int const& baseNumber = 0) const; /*! * Get the formatted is present expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Formatted is present expression of the selected field. + * @return Formatted is present expression of the selected field. */ std::string getIsPresentFormattedExpression(std::string const& fieldName) const; /*! * Get the is present expression of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Is present expression of the selected parameter. + * @return Is present expression of the selected parameter. */ std::string getIsPresentExpression(std::string const& fieldName) const; /*! * Set a new is present value for the selected field. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newIsPresent New is present value. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newIsPresent New is present value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsPresent(std::string const& fieldName, std::string const& newIsPresent); /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Check if the selected field has a valid offset. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return True, if the offset is valid, false otherwise. + * @return True, if the offset is valid, false otherwise. */ bool hasValidOffset(std::string const& fieldName) const; /*! * Check if the selected field has a valid bit width. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return True, if the bit width is valid, false otherwise. + * @return True, if the bit width is valid, false otherwise. */ bool hasValidWidth(std::string const& fieldName) const; /*! * Check if the selected field has valid reset values. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return True, if the reset values are valid, false otherwise. + * @return True, if the reset values are valid, false otherwise. */ bool hasValidResets(std::string const& fieldName) const; /*! * Check if the selected field has a valid is present. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return True, if the is present is valid, false otherwise. + * @return True, if the is present is valid, false otherwise. */ bool hasValidIsPresent(std::string const& fieldName) const; /*! * Check if the selected field or field access policy has a valid access. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the field access policy to validate. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the field access policy to validate. * - * @return True, if the access is valid, false otherwise. + * @return True, if the access is valid, false otherwise. */ bool hasValidAccess(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Check if the selected field access policy has a valid read response. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the field access policy to validate. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the field access policy to validate. * - * @return True, if the read response is valid, false otherwise. + * @return True, if the read response is valid, false otherwise. */ bool hasValidReadResponse(std::string const& fieldName, int accessPolicyIndex) const; /*! * Check if the selected field access policy has a valid reserved value. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the field access policy to validate. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the field access policy to validate. * - * @return True, if the reserved is valid, false otherwise. + * @return True, if the reserved is valid, false otherwise. */ bool hasValidReserved(std::string const& fieldName, int accessPolicyIndex) const; /*! * Check if the selected field access policy has a valid write value constraint. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex Index of the field access policy to validate. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex Index of the field access policy to validate. * - * @return True, if the write value constraint is valid, false otherwise. + * @return True, if the write value constraint is valid, false otherwise. */ bool hasValidWriteValueConstraint(std::string const& fieldName, int accessPolicyIndex) const; /*! * Add a new field. * - * @param [in] row Row of the new field. - * @param [in] newFieldName Name of the new field. + * @param [in] row Row of the new field. + * @param [in] newFieldName Name of the new field. */ void addField(int const& row, std::string const& newFieldName = std::string("")); /*! * Remove the selected field. * - * @param [in] FieldName Name of the selected field. + * @param [in] FieldName Name of the selected field. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeField(std::string const& fieldName); /*! * Copy the selected fields. * - * @param [in] selectedRows Indexes of the selected fields. + * @param [in] selectedRows Indexes of the selected fields. */ void copyRows(std::vector const& selectedRows); /*! * Paste the selected fields. * - * @return Names of the pasted fields. + * @return Names of the pasted fields. */ std::vector pasteRows(); /*! * Get the number of pasted fields. * - * @return Number of the pasted fields. + * @return Number of the pasted fields. */ int getPasteRowCount() const; /*! * Get the expressions in the selected fields. * - * @param [in] fieldNames Names of the selected fields. + * @param [in] fieldNames Names of the selected fields. * - * @return The expressions of the selected fields. + * @return The expressions of the selected fields. */ std::vector getExpressionsInSelectedFields(std::vector const& fieldNames) const; /*! * Get the sub interface. * - * @return Interface for accessing resets. + * @return Interface for accessing resets. */ ResetInterface* getSubInterface() const; @@ -581,30 +581,30 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * provided only when checking the existence of a write constraint of a field access policy within a 2022 * std revision field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return True, if the selected field or field access policy has write value constraint, false otherwise. + * @return True, if the selected field or field access policy has write value constraint, false otherwise. */ bool hasWriteConstraint(std::string const& fieldName) const; /*! * Get the write value constraint type of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return The write value constraint type of the selected field or field access policy. + * @return The write value constraint type of the selected field or field access policy. */ std::string getWriteConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set a new write value constraint type for the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] newConstraintText The new write value constraint type. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] newConstraintText The new write value constraint type. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWriteConstraint(std::string const& fieldName, std::string const& newConstraintText, int accessPolicyIndex = -1); @@ -612,11 +612,11 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the calculated write value constraint minimum value of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated write value constraint minimum value of the selected field or field access policy. + * @return Calculated write value constraint minimum value of the selected field or field access policy. */ std::string getWriteConstraintMinimumValue(std::string const& fieldName, int accessPolicyIndex = -1, int const& baseNumber = 0) const; @@ -624,10 +624,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the formatted write value constraint minimum expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Formatted write value constraint minimum expression of the selected field or field access policy. + * @return Formatted write value constraint minimum expression of the selected field or field access policy. */ std::string getWriteConstraintMinimumFormattedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -635,21 +635,21 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the write value constraint minimum expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Write value constraint minimum expression of the selected parameter. + * @return Write value constraint minimum expression of the selected parameter. */ std::string getWriteConstraintMinimumExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set a new write value constraint minimum value for the selected field or field access policy. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newWriteConstraintMinimum New write value constraint minimum value. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newWriteConstraintMinimum New write value constraint minimum value. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWriteConstraintMinimum(std::string const& fieldName, std::string const& newWriteConstraintMinimum, int accessPolicyIndex = -1); @@ -657,11 +657,11 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the calculated write value constraint maximum value of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated write value constraint maximum value of the selected field or field access policy. + * @return Calculated write value constraint maximum value of the selected field or field access policy. */ std::string getWriteConstraintMaximumValue(std::string const& fieldName, int accessPolicyIndex = -1, int const& baseNumber = 0) const; @@ -669,10 +669,10 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the formatted write value constraint maximum expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Formatted write value constraint maximum expression of the selected field or field access policy. + * @return Formatted write value constraint maximum expression of the selected field or field access policy. */ std::string getWriteConstraintMaximumFormattedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; @@ -680,21 +680,21 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the write value constraint maximum expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Write value constraint maximum expression of the selected parameter. + * @return Write value constraint maximum expression of the selected parameter. */ std::string getWriteConstraintMaximumExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set a new write value constraint maximum value for the selected field or field access policy. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newWriteConstraintMaximum New write value constraint maximum value. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newWriteConstraintMaximum New write value constraint maximum value. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWriteConstraintMaximum(std::string const& fieldName, std::string const& newWriteConstraintMaximum, int accessPolicyIndex = -1); @@ -703,11 +703,11 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG * Get the calculated reserved value of the selected field or field access policy, which can be specified * by index, for getting the reserved value from a field access policy of a 2022 standard compliant field. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The selected access policy index. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The selected access policy index. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated reserved value of the selected field. + * @return Calculated reserved value of the selected field. */ std::string getReservedValue(std::string const& fieldName, int accessPolicyIndex = -1, int const& baseNumber = 0) const; @@ -715,57 +715,57 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the formatted reserved expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Formatted reserved expression of the selected field or field access policy. + * @return Formatted reserved expression of the selected field or field access policy. */ std::string getReservedFormattedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Get the reserved expression of the selected field or field access policy. * - * @param [in] fieldName Name of the selected field. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] fieldName Name of the selected field. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return Reserved expression of the selected parameter. + * @return Reserved expression of the selected parameter. */ std::string getReservedExpression(std::string const& fieldName, int accessPolicyIndex = -1) const; /*! * Set a new reserved value for the selected field or field access policy. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newReserved New reserved value. - * @param [in] accessPolicyIndex The index of the selected field access policy. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newReserved New reserved value. + * @param [in] accessPolicyIndex The index of the selected field access policy. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setReserved(std::string const& fieldName, std::string const& newReserved, int accessPolicyIndex = -1); /*! * Get the ID of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return ID of the selected field. + * @return ID of the selected field. */ std::string getID(std::string const& fieldName); /*! * Set a ID for the selected field. * - * @param [in] parameterName Name of the selected parameter. - * @param [in] newID New ID. + * @param [in] parameterName Name of the selected parameter. + * @param [in] newID New ID. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setID(std::string const& fieldName, std::string const& newID); /*! * Add a new field access policy to a selected field. * - * @param [in] fieldName The field to add a new access policy to. + * @param [in] fieldName The field to add a new access policy to. * * @return True, if successful, otherwise false. */ @@ -774,8 +774,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Remove the given field access policy from a specific field. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex The index of the field access policy to be removed. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex The index of the field access policy to be removed. * * @return True, if successful, otherwise false. */ @@ -784,8 +784,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the mode references of a given field access policy. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. * * @return A vector containing the mode references as a string-int pair. */ @@ -794,8 +794,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get all mode references of field access policies except for the one given by index. * - * @param [in] fieldName The field containing the field access policies. - * @param [in] accessPolicyIndex The index of the access policy whose mode references are not to get. + * @param [in] fieldName The field containing the field access policies. + * @param [in] accessPolicyIndex The index of the access policy whose mode references are not to get. * * @return All mode references, except for mode references of field access policy given by index. */ @@ -804,8 +804,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get mode references of given field access policy. * - * @param [in] fieldName The name of the field, which contains the field access policy. - * @param [in] accessPolicyIndex Index of the field access policy whose mode references to get. + * @param [in] fieldName The name of the field, which contains the field access policy. + * @param [in] accessPolicyIndex Index of the field access policy whose mode references to get. * * @return The mode references of the field access policy. */ @@ -814,9 +814,9 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Set the mode references of a field access policy. * - * @param [in] fieldName The name of the field, which contains the field access policy. - * @param [in] accessPolicyIndex Index of the field access policy whose mode references to set. - * @param [in] newModeRefs The mode references to set. + * @param [in] fieldName The name of the field, which contains the field access policy. + * @param [in] accessPolicyIndex Index of the field access policy whose mode references to set. + * @param [in] newModeRefs The mode references to set. * * @return True, if the operation was successful, otherwise false. */ @@ -825,7 +825,7 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the access policy count of the given field. * - * @param [in] fieldName Description + * @param [in] fieldName Description * * @return The number of field access policies in the given field. */ @@ -834,8 +834,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the read response of a field access policy as an expression. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. * * @return The read response as an expression. */ @@ -844,8 +844,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the read response of a field access policy as a formatted expression. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. * * @return The read response as a formatted expression. */ @@ -854,9 +854,9 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the evaluated read response value of a field access policy. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] baseNumber Base for displaying the value. * * @return The evaluated read response. */ @@ -865,9 +865,9 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Set the read response of a selected field access policy. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. - * @param [in] newReadResponse The read response to set. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] newReadResponse The read response to set. * * @return True, if successful, otherwise false. */ @@ -876,9 +876,9 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the number of references to a parameter used in the different sub-elements of the field access policy. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex Index of the field access policy. - * @param [in] valueID The parameter (ID) to check. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex Index of the field access policy. + * @param [in] valueID The parameter (ID) to check. * * @return The number of references to a parameter used within the field access policy. */ @@ -887,8 +887,8 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Checks if the field access policy given by index has valid mode references. * - * @param [in] fieldName The name of the field. - * @param [in] accessPolicyIndex The index of the field access policy to check. + * @param [in] fieldName The name of the field. + * @param [in] accessPolicyIndex The index of the field access policy to check. * * @return True, if the field access policy's mode references are valid, otherwise false. */ @@ -897,15 +897,15 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Copy selected field access policies to clipboard. * - * @param [in] fieldName The field containing the access policies. - * @param [in] selectedAccessPolicies List containing the indices of the selected access policies. + * @param [in] fieldName The field containing the access policies. + * @param [in] selectedAccessPolicies List containing the indices of the selected access policies. */ void copyFieldAccessPolicies(std::string const& fieldName, std::vector const& selectedAccessPolicies); /*! * Paste the selected field access policies. * - * @param [in] fieldName The name of the field to paste into. + * @param [in] fieldName The name of the field to paste into. * * @return The number of pasted field access policies. */ @@ -914,7 +914,7 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Set the mode reference interface to be used. * - * @param [in] modeRefInterface The mode reference interface to be used. + * @param [in] modeRefInterface The mode reference interface to be used. */ void setModeReferenceInterface(ModeReferenceInterface* modeRefInterface); @@ -930,27 +930,27 @@ class KACTUS2_API FieldInterface : public ParameterizableInterface, public NameG /*! * Get the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return The selected field. + * @return The selected field. */ QSharedPointer getField(std::string const& fieldName) const; /*! * Get the field with the selected name, sliced to a NameGroup. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return The sliced field with the selected name. + * @return The sliced field with the selected name. */ QSharedPointer getItem(std::string const& fieldName) const override; /*! * Get the write value constraing of the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return Write value constraint of the selected field. + * @return Write value constraint of the selected field. */ QSharedPointer getWriteValueConstraint(std::string const& fieldName, int accessPolicyIndex = -1) const; diff --git a/KactusAPI/include/FileBuilderInterface.h b/KactusAPI/include/FileBuilderInterface.h index 8caff1efc..43d5dc8f8 100644 --- a/KactusAPI/include/FileBuilderInterface.h +++ b/KactusAPI/include/FileBuilderInterface.h @@ -34,8 +34,8 @@ class KACTUS2_API FileBuilderInterface : public ParameterizableInterface, public /*! * The constructor. * - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ FileBuilderInterface(QSharedPointer expressionParser, QSharedPointer expressionFormatter); @@ -48,38 +48,38 @@ class KACTUS2_API FileBuilderInterface : public ParameterizableInterface, public /*! * Set available file builders. * - * @param [in] newFileBuilders The new file builders. + * @param [in] newFileBuilders The new file builders. */ void setFileBuilders(QSharedPointer > > newFileBuilders); /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Validates the contained items. * - * @return True, if all the items are valid, false otherwise. + * @return True, if all the items are valid, false otherwise. */ virtual bool validateItems() const; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -87,121 +87,121 @@ class KACTUS2_API FileBuilderInterface : public ParameterizableInterface, public /*! * Get the expressions in the selected file builders. * - * @param [in] fileBuilderNames Names of the selected file builders. + * @param [in] fileBuilderNames Names of the selected file builders. * - * @return The expressions of the selected file builders. + * @return The expressions of the selected file builders. */ std::vector getExpressionsInSelectedFileBuilders(std::vector fileBuilderNames) const; /*! * Add a new file builder. * - * @param [in] row Row of the new file builder. - * @param [in] newFileBuilderName Name of the new file builder. + * @param [in] row Row of the new file builder. + * @param [in] newFileBuilderName Name of the new file builder. */ void addFileBuilder(int const& row, std::string const& newFileBuilderName = std::string("")); /*! * Remove the selected file builder. * - * @param [in] fileBuilderName Name of the selected file builder. + * @param [in] fileBuilderName Name of the selected file builder. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeFileBuilder(std::string const& fileBuilderName); /*! * Get the file type of the indexed file builder. * - * @param [in] itemIndex Index of the selected file builder. + * @param [in] itemIndex Index of the selected file builder. * - * @return File type of the selected file builder. + * @return File type of the selected file builder. */ std::string getIndexedFileType(int const& itemIndex); /*! * Set a new file type for the selected item. * - * @param [in] currentFileType File type of the selected item. - * @param [in] newFileType The new file type for the item. + * @param [in] currentFileType File type of the selected item. + * @param [in] newFileType The new file type for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setFileType(std::string const& currentFileType, std::string const& newFileType); /*! * Get the command of the selected item. * - * @param [in] fileType File type of the selected item. + * @param [in] fileType File type of the selected item. * - * @return Command of the selected item. + * @return Command of the selected item. */ std::string getCommand(std::string const& fileType) const; /*! * Set a new command for the selected item. * - * @param [in] fileType File type of the selected item. - * @param [in] newCommand The new command for the item. + * @param [in] fileType File type of the selected item. + * @param [in] newCommand The new command for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setCommand(std::string const& fileType, std::string const& newCommand); /*! * Get the flags of the selected item. * - * @param [in] fileType File type of the selected item. + * @param [in] fileType File type of the selected item. * - * @return Flags of the selected item. + * @return Flags of the selected item. */ std::string getFlags(std::string const& fileType) const; /*! * Set new flags value for the selected item. * - * @param [in] fileType File type of the selected item. - * @param [in] newFlags The new flags value. + * @param [in] fileType File type of the selected item. + * @param [in] newFlags The new flags value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setFlags(std::string const& fileType, std::string const& newFlags); /*! * Get the calculated replace default flags value of the selected item. * - * @param [in] fileType The selected file type. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fileType The selected file type. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated replace default flags value of the selected item. + * @return Calculated replace default flags value of the selected item. */ std::string getReplaceDefaultFlagsValue(std::string const& fileType, int const& baseNumber = 0) const; /*! * Get the formatted replace default flags expression of the selected item. * - * @param [in] fileType The selected file type. + * @param [in] fileType The selected file type. * - * @return Formatted replace default flags expression of the selected item. + * @return Formatted replace default flags expression of the selected item. */ std::string getReplaceDefaultFlagsFormattedExpression(std::string const& fileType) const; /*! * Get the replace default flags expression of the selected item. * - * @param [in] fileType The selected file type. + * @param [in] fileType The selected file type. * - * @return Replace default flags expression of the selected file. + * @return Replace default flags expression of the selected file. */ std::string getReplaceDefaultFlagsExpression(std::string const& fileType) const; /*! * Set a new replace default flags value for the selected item. * - * @param [in] fileType The selected file type. - * @param [in] newReplaceDefaultFlags New replace default flags value. + * @param [in] fileType The selected file type. + * @param [in] newReplaceDefaultFlags New replace default flags value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setReplaceDefaultFlags(std::string const& filetype, std::string const& newReplaceDefaultFlags); @@ -210,9 +210,9 @@ class KACTUS2_API FileBuilderInterface : public ParameterizableInterface, public /*! * Get the selected file builder. * - * @param [in] fileBuilderName Name of the selected file builder. + * @param [in] fileBuilderName Name of the selected file builder. * - * @return The selected file builder. + * @return The selected file builder. */ QSharedPointer getFileBuilder(std::string const& fileBuilderName) const; diff --git a/KactusAPI/include/FileHandler.h b/KactusAPI/include/FileHandler.h index 2db2587da..57e015ba9 100644 --- a/KactusAPI/include/FileHandler.h +++ b/KactusAPI/include/FileHandler.h @@ -31,64 +31,64 @@ namespace FileHandler /*! * Construct a table for file types. * - * @return Table with file extension as key and file type as value. + * @return Table with file extension as key and file type as value. */ KACTUS2_API QMultiMap constructFileSuffixTable(); /*! * Get a file type for the selected file extension. * - * @param [in] fileSuffixTable Table containing file types combined with file name extensions. - * @param [in] suffix The selected extension. + * @param [in] fileSuffixTable Table containing file types combined with file name extensions. + * @param [in] suffix The selected extension. * - * @return File type matching the selected extension. + * @return File type matching the selected extension. */ KACTUS2_API QString getFileTypeForSuffix(QMultiMap const& fileSuffixTable, QString const& suffix); /*! * Resolve environment variables in a given URI to form a file path. * - * @param [in] ipxactURI + * @param [in] ipxactURI * - * @return The resolved file path. + * @return The resolved file path. */ KACTUS2_API QString resolvePath(QString const& ipxactURI); /*! * Resolve environment variables in a given URI to form a URI. * - * @param [in] ipxactURI + * @param [in] ipxactURI * - * @return The resolved URI. + * @return The resolved URI. */ KACTUS2_API QString resolveURI(QString const& ipxactURI); /*! * Check if given ipxactURI is valid. * - * @param [in] relativeTo Path to resolve relative file paths from. - * @param [in] ipxactURI The URI to check. + * @param [in] relativeTo Path to resolve relative file paths from. + * @param [in] ipxactURI The URI to check. * - * @return True, if the ipxactURI is valid, otherwise false. + * @return True, if the ipxactURI is valid, otherwise false. */ KACTUS2_API bool isValidURI(QString const& relativeTo, QString const& ipxactURI); /*! * Check if given file path exists in the file system. * - * @param [in] relativeTo Path to resolve relative file paths from. - * @param [in] filePath The path to check. + * @param [in] relativeTo Path to resolve relative file paths from. + * @param [in] filePath The path to check. * - * @return True, if the path exists, otherwise false. + * @return True, if the path exists, otherwise false. */ KACTUS2_API bool filePathExists(QString const& relativeTo, QString const& filePath); /*! * Check if given input is a URI. * - * @param [in] uri The input to check. + * @param [in] uri The input to check. * - * @return True, if the input is a URI, otherwise false. + * @return True, if the input is a URI, otherwise false. */ KACTUS2_API bool isURI(QString const& uri); }; diff --git a/KactusAPI/include/FileInterface.h b/KactusAPI/include/FileInterface.h index 80ff08102..0de30a319 100644 --- a/KactusAPI/include/FileInterface.h +++ b/KactusAPI/include/FileInterface.h @@ -37,9 +37,9 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * The constructor. * - * @param [in] validator Validator for files. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] validator Validator for files. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ FileInterface(QSharedPointer validator, QSharedPointer expressionParser, QSharedPointer expressionFormatter); @@ -52,49 +52,49 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * Set available files. * - * @param [in] newFiles The new files. + * @param [in] newFiles The new files. */ void setFiles(QSharedPointer > > newFiles); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; @@ -102,9 +102,9 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro * Get the description of the selected item. * Can't inherit this function from NameGroupInterface, as File doesn't inherit from NameGroup. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Description of the selected item. + * @return Description of the selected item. */ std::string getDescription(std::string const& itemName) const override; @@ -112,36 +112,36 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro * Set a new description for the selected item. * Can't inherit this function from NameGroupInterface, as File doesn't inherit from NameGroup. * - * @param [in] itemName Name of the selected item. - * @param [in] newDescription New description. + * @param [in] itemName Name of the selected item. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDescription(std::string const& itemName, std::string const& newDescription) override; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Calculate all the references to the selected ID in the selected file. * - * @param [in] fileName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] fileName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected file. + * @return Number of references to the selected ID in the selected file. */ virtual int getAllReferencesToIdInItem(const std::string& fileName, std::string const& valueID) const override final; @@ -149,331 +149,331 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * Get the expressions in the selected files. * - * @param [in] fileNames Names of the selected files. + * @param [in] fileNames Names of the selected files. * - * @return The expressions of the selected files. + * @return The expressions of the selected files. */ std::vector getExpressionsInSelectedFiles(std::vector fileNames) const; /*! * Add a new file. * - * @param [in] row Row of the new file. - * @param [in] newFileName Name of the new file. + * @param [in] row Row of the new file. + * @param [in] newFileName Name of the new file. */ void addFile(int const& row, std::string const& newFileName = std::string("")); /*! * Remove the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeFile(std::string const& fileName); /*! * Swap the positions of the selected files. * - * @param [in] firstIndex Index of the first file. - * @param [in] secondIndex Index of the second file. + * @param [in] firstIndex Index of the first file. + * @param [in] secondIndex Index of the second file. */ void swapFiles(int const& firstIndex, int const& secondIndex); /*! * Get the logical name of a file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Logical name of the selected file. + * @return Logical name of the selected file. */ std::string getLogicalName(std::string const& fileName) const; /*! * Set a new logical name. * - * @param [in] fileName Name of the selected file. - * @param [in] newLogicalName The new logical name. + * @param [in] fileName Name of the selected file. + * @param [in] newLogicalName The new logical name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalName(std::string const& fileName, std::string newLogicalName); /*! * Get the default-attribute value of the logicalName element. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return True of the logical name is default, otherwise false. + * @return True of the logical name is default, otherwise false. */ bool isLogicalNameDefault(std::string const& fileName) const; /*! * Set the logical name attribute default. * - * @param [in] fileName Name of the selected file. - * @param [in] newLogicalDefault Boolean value of the attribute. + * @param [in] fileName Name of the selected file. + * @param [in] newLogicalDefault Boolean value of the attribute. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalNameDefault(std::string const& fileName, bool newLogicalDefault); /*! * Check if the file contains a structural RTL or not. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return True, if the file contains a structural RTL, false otherwise. + * @return True, if the file contains a structural RTL, false otherwise. */ bool isStructural(std::string const& fileName) const; /*! * Set the file to contain structural RTL. * - * @param [in] fileName Name of the selected file. - * @param [in] structuralStatus The new structural status. + * @param [in] fileName Name of the selected file. + * @param [in] structuralStatus The new structural status. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setStructural(std::string const& fileName, bool structuralStatus); /*! * Get the isIncludeFile setting. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return True if the file is an include file, otherwise false. + * @return True if the file is an include file, otherwise false. */ bool isIncludeFile(std::string const& fileName) const; /*! * Set the isIncludeFile setting for this file. * - * @param [in] fileName Name of the selected file. - * @param [in] includeFileStatus Boolean value to be set. + * @param [in] fileName Name of the selected file. + * @param [in] includeFileStatus Boolean value to be set. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIncludeFile(std::string const& fileName, bool includeFileStatus); /*! * Get attribute value of external declarations. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return True of the file has external declarations, otherwise false. + * @return True of the file has external declarations, otherwise false. */ bool hasExternalDeclarations(std::string const& fileName) const; /*! * Set the externalDeclarations setting * - * @param [in] fileName Name of the selected file. - * @param [in] externalDeclarationsStatus Boolean value to be set. + * @param [in] fileName Name of the selected file. + * @param [in] externalDeclarationsStatus Boolean value to be set. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setExternalDeclarations(std::string const& fileName, bool externalDeclarationsStatus); /*! * Clear all the fileTypes and userFileTypes. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. */ void clearFileTypes(std::string const& fileName); /*! * Set file types for the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newFileTypes The new file types. + * @param [in] fileName Name of the selected file. + * @param [in] newFileTypes The new file types. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setFileTypes(std::string const& fileName, std::vector const newFileTypes); /*! * Add the selected file type to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newFileType The new file type. + * @param [in] fileName Name of the selected file. + * @param [in] newFileType The new file type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addFileType(std::string const& fileName, std::string const newFileType); /*! * Add multiple file type to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newFileTypes The new file types. + * @param [in] fileName Name of the selected file. + * @param [in] newFileTypes The new file types. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addMultipleFileTypes(std::string const& fileName, std::vector const newFileTypes); /*! * Get the dependencies of a file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Dependencies of the selected file. + * @return Dependencies of the selected file. */ std::vector getDependencies(std::string const& fileName) const; /*! * Clear all the dependencies on the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. */ void clearDependencies(std::string const& fileName); /*! * Add the selected dependency to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newDependency The new dependency. + * @param [in] fileName Name of the selected file. + * @param [in] newDependency The new dependency. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addDependency(std::string const& fileName, std::string const newDependency); /*! * Add multiple dependencies to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newDependencies The new dependencies. + * @param [in] fileName Name of the selected file. + * @param [in] newDependencies The new dependencies. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addMultipleDependencies(std::string const& fileName, std::vector const newDependencies); /*! * Get the exported names of a file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Exported names of the selected file. + * @return Exported names of the selected file. */ std::vector getExportedNames(std::string const& fileName) const; /*! * Clear all the exported names of the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. */ void clearExportedNames(std::string const& fileName); /*! * Add the selected exported name to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newExportedName The new exported name. + * @param [in] fileName Name of the selected file. + * @param [in] newExportedName The new exported name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addExportedName(std::string const& fileName, std::string const newExportedName); /*! * Add multiple exported names to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newExportedNames The new exported names. + * @param [in] fileName Name of the selected file. + * @param [in] newExportedNames The new exported names. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addMultipleExportedNames(std::string const& fileName, std::vector const newExportedNames); /*! * Get the image types of a file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Image types of the selected file. + * @return Image types of the selected file. */ std::vector getImageTypes(std::string const& fileName) const; /*! * Clear all the image types on the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. */ void clearImageTypes(std::string const& fileName); /*! * Add the selected image type to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newImageType The new image type. + * @param [in] fileName Name of the selected file. + * @param [in] newImageType The new image type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addImageType(std::string const& fileName, std::string const newImageType); /*! * Add multiple image types to the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newImageTypes The new image types. + * @param [in] fileName Name of the selected file. + * @param [in] newImageTypes The new image types. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addMultipleImageTypes(std::string const& fileName, std::vector const newImageTypes); /*! * Get the file types of the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return List containing the file types. + * @return List containing the file types. */ std::vector getFileTypes(std::string const& fileName) const; /*! * Get the build command of selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Build command of the selected file. + * @return Build command of the selected file. */ std::string getBuildCommandText(std::string const& fileName) const; /*! * Set the build command for the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newBuildCommand The new build command. + * @param [in] fileName Name of the selected file. + * @param [in] newBuildCommand The new build command. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBuildCommand(std::string const& fileName, std::string const& newBuildCommand); /*! * Get the build command flags of selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Build command flags of the selected file. + * @return Build command flags of the selected file. */ std::string getBuildCommandFlags(std::string const& fileName) const; /*! * Set the build flags for the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newFlags The new flags. + * @param [in] fileName Name of the selected file. + * @param [in] newFlags The new flags. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBuildCommandFlags(std::string const& fileName, std::string const& newFlags); /*! * Get the calculated build command replace default flags value of the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] baseNumber Base for displaying the value. + * @param [in] fileName Name of the selected file. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated build command replace default flags value of the selected file. + * @return Calculated build command replace default flags value of the selected file. */ std::string getBuildCommandReplaceDefaultFlagsValue(std::string const& fileName, int const& baseNumber = 0) const; @@ -481,28 +481,28 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * Get the formatted build command replace default flags expression of the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Formatted build command replace default flags expression of the selected file. + * @return Formatted build command replace default flags expression of the selected file. */ std::string getBuildCommandReplaceDefaultFlagsFormattedExpression(std::string const& fileName) const; /*! * Get the build command replace default flags expression of the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Build command replace default flags expression of the selected file. + * @return Build command replace default flags expression of the selected file. */ std::string getBuildCommandReplaceDefaultFlagsExpression(std::string const& fileName) const; /*! * Set a new build command replace default flags value for the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newReplaceDefaultFlags New build command replace default flags value. + * @param [in] fileName Name of the selected file. + * @param [in] newReplaceDefaultFlags New build command replace default flags value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setbuildCommandReplaceDefaultFlags(std::string const& fileName, std::string const& newReplaceDefaultFlags); @@ -510,19 +510,19 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * Get the build command target of selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return Build command target of the selected file. + * @return Build command target of the selected file. */ std::string getBuildCommandTarget(std::string const& fileName) const; /*! * Set the build target for the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] newTarget The new target. + * @param [in] fileName Name of the selected file. + * @param [in] newTarget The new target. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBuildCommandTarget(std::string const& fileName, std::string const& newTarget); @@ -531,9 +531,9 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro /*! * Get the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return The selected file. + * @return The selected file. */ QSharedPointer getFile(std::string const& fileName) const; @@ -541,25 +541,25 @@ class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGro * Get the file with the selected name, sliced to a NameGroup. * Dummy function, return nullptr, as file doesn't contain a name group. * - * @param [in] file Name of the selected file. + * @param [in] file Name of the selected file. * - * @return Always nullptr. + * @return Always nullptr. */ QSharedPointer getItem(std::string const& itemName) const override; /*! * Get the build command of the selected file. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return The build command of the selected file. + * @return The build command of the selected file. */ QSharedPointer getBuildCommand(std::string const& fileName) const; /*! * Remove an empty build command from the selected file. * - * @param [in] containingFile The selected file. + * @param [in] containingFile The selected file. */ void removeEmptyBuildCommand(QSharedPointer containingFile) const; diff --git a/KactusAPI/include/FileSetInterface.h b/KactusAPI/include/FileSetInterface.h index 6d51ddbc9..f87cba297 100644 --- a/KactusAPI/include/FileSetInterface.h +++ b/KactusAPI/include/FileSetInterface.h @@ -37,11 +37,11 @@ class KACTUS2_API FileSetInterface: public ParameterizableInterface, public Name /*! * The constructor. * - * @param [in] validator Validator for files. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] fileInterface Sub interface for files. - * @param [in] fileBuilderInterface Sub interface for file builders. + * @param [in] validator Validator for files. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] fileInterface Sub interface for files. + * @param [in] fileBuilderInterface Sub interface for file builders. */ FileSetInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -57,144 +57,144 @@ class KACTUS2_API FileSetInterface: public ParameterizableInterface, public Name /*! * Set available file sets. * - * @param [in] newFileSets The new file sets. + * @param [in] newFileSets The new file sets. */ void setFileSets(QSharedPointer > > newFileSets); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Get the groups of the selected file set. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return Groups of the selected file set. + * @return Groups of the selected file set. */ std::vector getGroups(std::string const& fileSetName) const; /*! * Set new groups for the selected item. * - * @param [in] fileSetName Name of the selected file set. - * @param [in] newGroups The new groups. + * @param [in] fileSetName Name of the selected file set. + * @param [in] newGroups The new groups. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setGroups(std::string const& fileSetName, std::vector const& newGroups); /*! * Get the dependencies of the selected file set. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return Dependencies of the selected file set. + * @return Dependencies of the selected file set. */ std::vector getDependencies(std::string const& fileSetName) const; /*! * Set new dependencies for the selected item. * - * @param [in] fileSetName Name of the selected file set. - * @param [in] newDependencies The new dependencies. + * @param [in] fileSetName Name of the selected file set. + * @param [in] newDependencies The new dependencies. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDependencies(std::string const& fileSetName, std::vector const& newDependencies); /*! * Add a new file set. * - * @param [in] row Row of the new file set. - * @param [in] newFileSetName Name of the new file set. + * @param [in] row Row of the new file set. + * @param [in] newFileSetName Name of the new file set. */ void addFileSet(int const& row, std::string const& newFileSetName = std::string("")); /*! * Remove the selected file set. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeFileSet(std::string const& fileSetName); /*! * Get the interface for accessing files. * - * @return Interface for accessing files. + * @return Interface for accessing files. */ FileInterface* getFileInterface() const; /*! * Get the interface for accessing file builders. * - * @return Interface for accessing file builders. + * @return Interface for accessing file builders. */ FileBuilderInterface* getFileBuilderInterface() const; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -202,18 +202,18 @@ class KACTUS2_API FileSetInterface: public ParameterizableInterface, public Name /*! * Get the expressions in the selected file sets. * - * @param [in] fileSetNames Names of the selected file sets. + * @param [in] fileSetNames Names of the selected file sets. * - * @return The expressions of the selected file sets. + * @return The expressions of the selected file sets. */ std::vector getExpressionsInSelectedFileSets(std::vector fileSetNames) const; /*! * Check if the selected file set exists. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return True, if the file set exists, false otherwise. + * @return True, if the file set exists, false otherwise. */ bool fileSetExists(std::string const& fileSetName) const; @@ -222,18 +222,18 @@ class KACTUS2_API FileSetInterface: public ParameterizableInterface, public Name /*! * Get the selected file set. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return The selected file set. + * @return The selected file set. */ QSharedPointer getFileSet(std::string const& fileSetName) const; /*! * Get the file set with the selected name, sliced to a NameGroup. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. * - * @return The sliced file set with the selected name. + * @return The sliced file set with the selected name. */ QSharedPointer getItem(std::string const& fileSetName) const override; diff --git a/KactusAPI/include/HighlightSource.h b/KactusAPI/include/HighlightSource.h index 045f3ee53..fbb66d21a 100644 --- a/KactusAPI/include/HighlightSource.h +++ b/KactusAPI/include/HighlightSource.h @@ -24,7 +24,7 @@ class HighlightSource /*! * Sets the given highlighter to be used by the source. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter) = 0; diff --git a/KactusAPI/include/Highlighter.h b/KactusAPI/include/Highlighter.h index 29f4ba84a..d97e438d8 100644 --- a/KactusAPI/include/Highlighter.h +++ b/KactusAPI/include/Highlighter.h @@ -25,26 +25,26 @@ class Highlighter /*! * Called when the text should be highlighted with the given color. * - * @param [in] text The text to highlight. - * @param [in] highlightColor The color of the highlight. - * @param [in] subSection Subsection where the text is located. + * @param [in] text The text to highlight. + * @param [in] highlightColor The color of the highlight. + * @param [in] subSection Subsection where the text is located. */ virtual void applyHighlight(QString const& text, QColor const& highlightColor, QString const& subSection = QString()) = 0; /*! * Called when a section should be highlighted with the given color. * - * @param [in] beginPosition The beginning character index. - * @param [in] endPosition The end character index. - * @param [in] highlightColor The color of the highlight. + * @param [in] beginPosition The beginning character index. + * @param [in] endPosition The end character index. + * @param [in] highlightColor The color of the highlight. */ virtual void applyHighlight(int beginPosition, int endPosition, QColor const& highlightColor) = 0; /*! * Called when the font color of a text should be changed to the given color. * - * @param [in] text The text whose font to change. - * @param [in] color The color of the text. + * @param [in] text The text whose font to change. + * @param [in] color The color of the text. */ virtual void applyFontColor(QString const& text, QColor const& color) = 0; }; diff --git a/KactusAPI/include/IGeneratorPlugin.h b/KactusAPI/include/IGeneratorPlugin.h index af0113e8e..41bf0c6c5 100644 --- a/KactusAPI/include/IGeneratorPlugin.h +++ b/KactusAPI/include/IGeneratorPlugin.h @@ -44,12 +44,12 @@ class IGeneratorPlugin : public IPlugin /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -59,11 +59,11 @@ class IGeneratorPlugin : public IPlugin * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, diff --git a/KactusAPI/include/IPXactSystemVerilogParser.h b/KactusAPI/include/IPXactSystemVerilogParser.h index 028e571da..54dc4f9a6 100644 --- a/KactusAPI/include/IPXactSystemVerilogParser.h +++ b/KactusAPI/include/IPXactSystemVerilogParser.h @@ -32,7 +32,7 @@ class KACTUS2_API IPXactSystemVerilogParser : public SystemVerilogExpressionPars /*! * The constructor. * - * @param [in] finder The finder for parameters available in the SystemVerilog expressions. + * @param [in] finder The finder for parameters available in the SystemVerilog expressions. */ explicit IPXactSystemVerilogParser(QSharedPointer finder); @@ -46,27 +46,27 @@ class KACTUS2_API IPXactSystemVerilogParser : public SystemVerilogExpressionPars /*! * Checks if the given expression is a symbol e.g. reference. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a symbol, otherwise false. + * @return True, if the expression is a symbol, otherwise false. */ bool isSymbol(QStringView expression) const override; /*! * Finds the value for given symbol. * - * @param [in] symbol The symbol whose value to find. + * @param [in] symbol The symbol whose value to find. * - * @return The found symbol value. + * @return The found symbol value. */ QString findSymbolValue(QStringView symbol) const override; /*! * Finds the base in the symbol. * - * @param [in] symbol The symbol whose base to find. + * @param [in] symbol The symbol whose base to find. * - * @return The base for the symbol. + * @return The base for the symbol. */ int getBaseForSymbol(QStringView symbol) const final; diff --git a/KactusAPI/include/IPluginUtility.h b/KactusAPI/include/IPluginUtility.h index 679f809fd..e016e9e80 100644 --- a/KactusAPI/include/IPluginUtility.h +++ b/KactusAPI/include/IPluginUtility.h @@ -43,14 +43,14 @@ class IPluginUtility /*! * Prints an error message to the console window. * - * @param [in] message The error message to print. + * @param [in] message The error message to print. */ virtual void printError(QString const& message) = 0; /*! * Prints an info message to the console window. * - * @param [in] message The info message to print. + * @param [in] message The info message to print. */ virtual void printInfo(QString const& message) = 0; }; diff --git a/KactusAPI/include/ISourceAnalyzerPlugin.h b/KactusAPI/include/ISourceAnalyzerPlugin.h index 409e9dad7..21affa763 100644 --- a/KactusAPI/include/ISourceAnalyzerPlugin.h +++ b/KactusAPI/include/ISourceAnalyzerPlugin.h @@ -73,9 +73,9 @@ class ISourceAnalyzerPlugin : public IPlugin * Calculates a language-dependent hash for the analyzed file. Hash calculation here may ignore * whitespace and comments. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. * - * @return The hash value for the file. + * @return The hash value for the file. */ virtual QString calculateHash(QString const& filename) = 0; @@ -83,8 +83,8 @@ class ISourceAnalyzerPlugin : public IPlugin * This function is called once when the dependency analysis scan is started. It gives the plugin the * ability to do preparations before any file is analyzed. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any preparations needed for the file dependency analysis should be made here. */ @@ -94,8 +94,8 @@ class ISourceAnalyzerPlugin : public IPlugin * This function is called once after the dependency analysis scan has completed. It allows the plugin to * make cleanup operations after the dependency scan has been finished, e.g destroy internal data structures. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any cleanups needed should be made here. */ @@ -104,11 +104,11 @@ class ISourceAnalyzerPlugin : public IPlugin /*! * Retrieves all file dependencies the given file has. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. - * @param [in] filename The name of the file to which the analysis is run. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. + * @param [in] filename The name of the file to which the analysis is run. * - * @return The list of found dependencies. + * @return The list of found dependencies. */ virtual QList getFileDependencies(Component const* component, QString const& componentPath, diff --git a/KactusAPI/include/ImportHighlighter.h b/KactusAPI/include/ImportHighlighter.h index 0905323f1..c798307bf 100644 --- a/KactusAPI/include/ImportHighlighter.h +++ b/KactusAPI/include/ImportHighlighter.h @@ -30,8 +30,8 @@ class ImportHighlighter : public QObject, public Highlighter /*! * The constructor. * - * @param [in] display The display widget for the parsed source file content. - * @param [in] parent The parent object. + * @param [in] display The display widget for the parsed source file content. + * @param [in] parent The parent object. */ ImportHighlighter(QPlainTextEdit* display, QObject* parent); @@ -41,26 +41,26 @@ class ImportHighlighter : public QObject, public Highlighter /*! * Called when the text should be highlighted with the given color. * - * @param [in] text The text to highlight. - * @param [in] highlightColor The color of the highlight. - * @param [in] subSection The current subsection containing the selected text. + * @param [in] text The text to highlight. + * @param [in] highlightColor The color of the highlight. + * @param [in] subSection The current subsection containing the selected text. */ virtual void applyHighlight(QString const& text, QColor const& highlightColor, QString const& subSection = QString()); /*! * Called when a section should be highlighted with the given color>. * - * @param [in] beginPosition The beginning character index. - * @param [in] endPosition The end character index. - * @param [in] highlightColor The color of the highlight. + * @param [in] beginPosition The beginning character index. + * @param [in] endPosition The end character index. + * @param [in] highlightColor The color of the highlight. */ virtual void applyHighlight(int beginPosition, int endPosition, QColor const& highlightColor); /*! * Called when the font color of a text should be changed to the given color. * - * @param [in] text The text whose font to change. - * @param [in] color The color of the text. + * @param [in] text The text whose font to change. + * @param [in] color The color of the text. */ virtual void applyFontColor(QString const& text, QColor const& color); diff --git a/KactusAPI/include/ImportPlugin.h b/KactusAPI/include/ImportPlugin.h index ed08107b1..bc3440dff 100644 --- a/KactusAPI/include/ImportPlugin.h +++ b/KactusAPI/include/ImportPlugin.h @@ -33,41 +33,41 @@ class ImportPlugin : public IPlugin /*! * Returns the file types supported by the plugin. * - * @return The file types the import plugin supports. + * @return The file types the import plugin supports. */ virtual QStringList getSupportedFileTypes() const = 0; /*! * Returns a compatibility warning concerning the import plugin usage. Can be empty. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const = 0; /*! * Get component declarations from the selected input file. * - * @param [in] input The selected input file. + * @param [in] input The selected input file. * - * @return List of component declarations found in the selected input. + * @return List of component declarations found in the selected input. */ virtual QStringList getFileComponents(QString const& input) const = 0; /*! * Get the name of the selected component declaration. * - * @param [in] componentDeclaration The selected component declaration. + * @param [in] componentDeclaration The selected component declaration. * - * @return Name of the selected component declaration. + * @return Name of the selected component declaration. */ virtual QString getComponentName(QString const& componentDeclaration) const = 0; /*! * Runs the import by parsing the given input and applying the parsed elements to the given component. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration Declaration of the selected component. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration Declaration of the selected component. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent) = 0; diff --git a/KactusAPI/include/ImportRunner.h b/KactusAPI/include/ImportRunner.h index 87a20686e..a6caff1a4 100644 --- a/KactusAPI/include/ImportRunner.h +++ b/KactusAPI/include/ImportRunner.h @@ -42,9 +42,9 @@ class KACTUS2_API ImportRunner : public QObject /*! * The constructor. * - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] displayTabs The container widget for read and displayed source files. - * @param [in] parent Pointer to the owner of this runner. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] displayTabs The container widget for read and displayed source files. + * @param [in] parent Pointer to the owner of this runner. */ ImportRunner(QSharedPointer parameterFinder, QTabWidget* displayTabs, QObject* parent); @@ -55,25 +55,25 @@ class KACTUS2_API ImportRunner : public QObject /*! * Sets the expression parser to be used by all importers. * - * @param [in] parser The parser to use. + * @param [in] parser The parser to use. */ void setExpressionParser(QSharedPointer parser); /*! * Loads all available import plugins. * - * @param [in] pluginManager The plugin manager owning all the plugins. + * @param [in] pluginManager The plugin manager owning all the plugins. */ void loadPlugins(PluginManager const& pluginManager); /*! * Locates component declarations from the selected file. * - * @param [in] filePath Path to the selected file. - * @param [in] componentXMLPath Path to the target component XML file. - * @param [in] targetComponent Target component to which import all parsed elements. + * @param [in] filePath Path to the selected file. + * @param [in] componentXMLPath Path to the target component XML file. + * @param [in] targetComponent Target component to which import all parsed elements. * - * @return List of component declarations found in the selected file. + * @return List of component declarations found in the selected file. */ QStringList constructComponentDataFromFile(QString const& filePath, QString const& componentXMLPath, QSharedPointer targetComponent); @@ -81,12 +81,12 @@ class KACTUS2_API ImportRunner : public QObject /*! * Runs all import plugins with matching file types for a given file and component. * - * @param [in] componentName Name of thes selected component. - * @param [in] filePath The relative path to the input file. - * @param [in] componentXmlPath The path to the target component XML file. - * @param [in] targetComponent The target component to which import all parsed elements. + * @param [in] componentName Name of thes selected component. + * @param [in] filePath The relative path to the input file. + * @param [in] componentXmlPath The path to the target component XML file. + * @param [in] targetComponent The target component to which import all parsed elements. * - * @return The component with all the imported elements. + * @return The component with all the imported elements. */ QSharedPointer run(QString const& componentName, QString const& filePath, QString const& componentXmlPath, QSharedPointer targetComponent); @@ -94,7 +94,7 @@ class KACTUS2_API ImportRunner : public QObject /*! * Gets all file types for which a import parser(s) can be run. * - * @return List of possible file types. + * @return List of possible file types. */ QStringList importFileTypes() const; @@ -112,23 +112,23 @@ class KACTUS2_API ImportRunner : public QObject /*! * Adds expression parser to a given import plugin if possible. * - * @param [in] parser The plugin to add expression parser to. + * @param [in] parser The plugin to add expression parser to. */ void addExpressionParserIfPossible(ImportPlugin* importPlugin) const; /*! * Scrolls the given display widget to the first highlighted row. * - * @param [in] sourceDisplay The display to scroll. + * @param [in] sourceDisplay The display to scroll. */ void scrollSourceDisplayToFirstHighlight(QPlainTextEdit* sourceDisplay) const; /*! * Imports all includes from the dependency files of a given file. * - * @param [in] filePath The file whose dependency files to import. - * @param [in] componentXmlPath The path to the target component XML file. - * @param [in] importComponent The component to import to. + * @param [in] filePath The file whose dependency files to import. + * @param [in] componentXmlPath The path to the target component XML file. + * @param [in] importComponent The component to import to. */ void importIncludes(QString const& filePath, QString const& componentXmlPath, QSharedPointer importComponent); @@ -136,39 +136,39 @@ class KACTUS2_API ImportRunner : public QObject /*! * Finds the include import plugins for the given file types. * - * @param [in] filetypes The file types to find plugins for. + * @param [in] filetypes The file types to find plugins for. * - * @return The found include import plugins. + * @return The found include import plugins. */ QList includeImportPluginsForFileTypes(QStringList const& filetypes) const; /*! * Finds the file types of a given file. * - * @param [in] importFile The relative path to the file. - * @param [in] fileSets The file sets to find the file and its file types from. + * @param [in] importFile The relative path to the file. + * @param [in] fileSets The file sets to find the file and its file types from. * - * @return File types of the given file. + * @return File types of the given file. */ QStringList filetypesOf(QString const& fileName, QList > const& fileSets) const; /*! * Finds possible source analyzer plugins for given file types. * - * @param [in] filetypes The file types to search for. + * @param [in] filetypes The file types to search for. * - * @return Import source analyzers capable of analyzing the given file types. + * @return Import source analyzers capable of analyzing the given file types. */ QList analyzerPluginsForFileTypes(QStringList filetypes) const; /*! * Imports a file to the given component. * - * @param [in] componentName Name of the selected component. - * @param [in] filePath The path to the file to import. - * @param [in] absoluteBasePath The absolute base path for relative filePaths. - * @param [in] importPluginsForFile The import plugins to use. - * @param [in] importComponent The component to import to. + * @param [in] componentName Name of the selected component. + * @param [in] filePath The path to the file to import. + * @param [in] absoluteBasePath The absolute base path for relative filePaths. + * @param [in] importPluginsForFile The import plugins to use. + * @param [in] importComponent The component to import to. */ void importFile(QString const& componentName, QString const& filePath, QString const& absoluteBasePath, QList importPluginsForFile, QSharedPointer importComponent); @@ -176,37 +176,37 @@ class KACTUS2_API ImportRunner : public QObject /*! * Reads the content of a given file. * - * @param [in] relativePath Relative path to the file from basePath. - * @param [in] basePath The from which to begin the relative path. + * @param [in] relativePath Relative path to the file from basePath. + * @param [in] basePath The from which to begin the relative path. * - * @return The file content. + * @return The file content. */ QString readInputFile(QString const& relativePath, QString const& basePath) const; /*! * Creates a display widget for the given file. * - * @param [in] filePath Path to the file. + * @param [in] filePath Path to the file. * - * @return A display widget for the given file. + * @return A display widget for the given file. */ QPlainTextEdit* createSourceDisplayForFile(QString const& filePath) const; /*! * Finds possible import plugins for given file types. * - * @param [in] filetypes The file types to search for. + * @param [in] filetypes The file types to search for. * - * @return Import plugins capable of reading the given file types. + * @return Import plugins capable of reading the given file types. */ QList importPluginsForFileTypes(QStringList const& filetypes) const; /*! * Get the selected component declaration. * - * @param [in] componentName Name of the selected component declaration. + * @param [in] componentName Name of the selected component declaration. * - * @return The selected component declaration. + * @return The selected component declaration. */ QString getComponentFromFile(QString const& componentName) const; diff --git a/KactusAPI/include/InterconnectionInterface.h b/KactusAPI/include/InterconnectionInterface.h index 3bb5c7a2d..7afcba21e 100644 --- a/KactusAPI/include/InterconnectionInterface.h +++ b/KactusAPI/include/InterconnectionInterface.h @@ -39,37 +39,37 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Setup the interconnections. * - * @param [in] newDesign Design containing the interconnections. + * @param [in] newDesign Design containing the interconnections. */ void setInterconnections(QSharedPointer newDesign); /*! * Get index of the selected interconnection. * - * @param [in] itemName Name of the selected interconnection. + * @param [in] itemName Name of the selected interconnection. * - * @return Index of the selected interconnection. + * @return Index of the selected interconnection. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed interconnection. * - * @param [in] itemIndex Index of the selected interconnection. + * @param [in] itemIndex Index of the selected interconnection. * - * @return Name of the selected interconnection. + * @return Name of the selected interconnection. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the name of the selected interconnection. * - * @param [in] startInstanceName Name of the component instance containing the first bus interface. - * @param [in] startBusName Name of the first bus interface. - * @param [in] endInstanceName Name of the component instance containing the second bus interface. - * @param [in] endBusName Name of the second bus interface. + * @param [in] startInstanceName Name of the component instance containing the first bus interface. + * @param [in] startBusName Name of the first bus interface. + * @param [in] endInstanceName Name of the component instance containing the second bus interface. + * @param [in] endBusName Name of the second bus interface. * - * @return Name of the selected interconnection. + * @return Name of the selected interconnection. */ std::string getConnectionName(std::string const& startInstanceName, std::string const& startBusName, std::string const& endInstanceName, std::string const& endBusName) const; @@ -77,11 +77,11 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Get the name of the selected hierarchical interconnection. * - * @param [in] instanceName Name of the component instance containing the selected bus interface. - * @param [in] instanceBus Name of the selected component instance bus interface. - * @param [in] topBus Name of the top component bus interface. + * @param [in] instanceName Name of the component instance containing the selected bus interface. + * @param [in] instanceBus Name of the selected component instance bus interface. + * @param [in] topBus Name of the top component bus interface. * - * @return Name of the selected interconnection. + * @return Name of the selected interconnection. */ std::string getHierarchicalConnectionName(std::string const& instanceName, std::string const& instanceBus, std::string const& topBus) const; @@ -89,70 +89,70 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Get the number of available interconnections. * - * @return Number of available interconnections. + * @return Number of available interconnections. */ virtual int itemCount() const override final; /*! * Get the names of the available interconnections. * - * @return Names of the available interconnections. + * @return Names of the available interconnections. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected interconnection. * - * @param [in] currentName Name of the selected interconnection. - * @param [in] newName New name for the interconnection. + * @param [in] currentName Name of the selected interconnection. + * @param [in] newName New name for the interconnection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the description of the selected interconnection. * - * @param [in] itemName Name of the selected interconnection. + * @param [in] itemName Name of the selected interconnection. * - * @return Description of the selected interconnection. + * @return Description of the selected interconnection. */ virtual std::string getDescription(std::string const& itemName) const override final; /*! * Set a new description for the selected interconnection. * - * @param [in] itemName Name of the selected interconnection. - * @param [in] newDescription New description. + * @param [in] itemName Name of the selected interconnection. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setDescription(std::string const& itemName, std::string const& newDescription) override final; /*! * Validates the contained interconnections. * - * @return True, if all the interconnections are valid, false otherwise. + * @return True, if all the interconnections are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected interconnection has a valid name. * - * @param [in] itemName Name of the selected interconnection. + * @param [in] itemName Name of the selected interconnection. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Add a new interconnection. * - * @param [in] startComponentInstance Name of the component instance containing the first bus interface. - * @param [in] startBus Name of the first bus interface. - * @param [in] endComponentInstance Name of the component instance containing the second bus interface. - * @param [in] endBus Name of the second bus interface. - * @param [in] connectionName Name of the connection. + * @param [in] startComponentInstance Name of the component instance containing the first bus interface. + * @param [in] startBus Name of the first bus interface. + * @param [in] endComponentInstance Name of the component instance containing the second bus interface. + * @param [in] endBus Name of the second bus interface. + * @param [in] connectionName Name of the connection. */ void addInterconnection(std::string const& startComponentInstance, std::string const& startBus, std::string const& endComponentInstance, std::string const& endBus, std::string const& connectionName = ""); @@ -160,10 +160,10 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Add a new hierarchical interconnection. * - * @param [in] instanceName Name of the component instance containing the selected bus interface. - * @param [in] instanceBus Name of the selected component instance bus interface. - * @param [in] topBus Name of the selected top component bus interface. - * @param [in] connectionName Name of the connection. + * @param [in] instanceName Name of the component instance containing the selected bus interface. + * @param [in] instanceBus Name of the selected component instance bus interface. + * @param [in] topBus Name of the selected top component bus interface. + * @param [in] connectionName Name of the connection. */ void addHierarchicalInterconnection(std::string const& instanceName, std::string const& instanceBus, std::string const& topBus, std::string const& connectionName = ""); @@ -171,35 +171,35 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Remove the selected interconnection. * - * @param [in] connectionName Name of the selected interconnection. + * @param [in] connectionName Name of the selected interconnection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeInterconnection(std::string const& connectionName); /*! * Remove interconnections connected to the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeInstanceInterconnections(std::string const& instanceName); /*! * Check if the selected interconnection exists. * - * @param [in] connectionName Name of the selected interconnection. + * @param [in] connectionName Name of the selected interconnection. * - * @return True, if the interconnection exists, false otherwise. + * @return True, if the interconnection exists, false otherwise. */ bool interconnectionExists(std::string const& connectionName) const; /*! * Rename the component references in connections. * - * @param [in] currentName Current name of the component instance. - * @param [in] newName New name for the component instance. + * @param [in] currentName Current name of the component instance. + * @param [in] newName New name for the component instance. */ void renameComponentReferences(std::string const& currentName, std::string const& newName); @@ -212,18 +212,18 @@ class KACTUS2_API InterconnectionInterface : public NameGroupInterface /*! * Get the selected interconnection. * - * @param [in] connectionName Name of the selected interconnection. + * @param [in] connectionName Name of the selected interconnection. * - * @return The selected interconnection. + * @return The selected interconnection. */ QSharedPointer getInterconnection(std::string const& connectionName) const; /*! * Get the interconnection with the selected name, sliced to a NameGroup. * - * @param [in] connectionName Name of the selected parameter. + * @param [in] connectionName Name of the selected parameter. * - * @return The sliced interconnection with the selected name. + * @return The sliced interconnection with the selected name. */ QSharedPointer getItem(std::string const& connectionName) const; diff --git a/KactusAPI/include/LibraryHandler.h b/KactusAPI/include/LibraryHandler.h index b39c4c78a..f0463a705 100644 --- a/KactusAPI/include/LibraryHandler.h +++ b/KactusAPI/include/LibraryHandler.h @@ -66,9 +66,9 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * * This function can be called to get a model that matches an IP-Xact document. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The model that matches the document. + * @return The model that matches the document. */ QSharedPointer getModel(VLNV const& vlnv) final; @@ -76,39 +76,39 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * * This function can be called to get a model that matches an IP-Xact document. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The model that matches the document. + * @return The model that matches the document. */ QSharedPointer getModelReadOnly(VLNV const& vlnv) final; /*! Gets all the VLNVs currently in the library. * - * @return All known VLNVs in the library. + * @return All known VLNVs in the library. */ QList getAllVLNVs() const final; /*! Checks if the library already contains the specified vlnv. * - * @param [in] vlnv The vlnv that is searched within the library. + * @param [in] vlnv The vlnv that is searched within the library. * - * @return True if the vlnv was found + * @return True if the vlnv was found */ bool contains(VLNV const& vlnv) const final; /*! Get a path to the specified IP-Xact document. * - * @param [in] vlnv Specifies the wanted IP-Xact document. + * @param [in] vlnv Specifies the wanted IP-Xact document. * - * @return The path to the document. If vlnv is not found then empty string is returned. + * @return The path to the document. If vlnv is not found then empty string is returned. */ const QString getPath(VLNV const& vlnv) const final; /*! Get the directory path to the specified IP-XACT document. * - * @param [in] vlnv Specifies the wanted IP-XACT document. + * @param [in] vlnv Specifies the wanted IP-XACT document. * - * @return The directory path to the document. Does not contain the xml file name. + * @return The directory path to the document. Does not contain the xml file name. */ QString getDirectoryPath(VLNV const& vlnv) const final; @@ -121,10 +121,10 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * When model is saved using this function it is not necessary to call * onItemSaved() because it is called by this function. * - * @param [in] path Directory path that specifies the directory to save to file into. - * @param [in] model The library component that is written. + * @param [in] path Directory path that specifies the directory to save to file into. + * @param [in] model The library component that is written. * - * @return True if the model was in valid state and was successfully written. + * @return True if the model was in valid state and was successfully written. */ bool writeModelToFile(QString const& path, QSharedPointer model) final; @@ -135,9 +135,9 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * to the previous file so the model can not be restored to it's previous * state after this operation. * - * @param [in] model The model to be written. + * @param [in] model The model to be written. * - * @return True if the model was in valid state and was successfully written. + * @return True if the model was in valid state and was successfully written. */ bool writeModelToFile(QSharedPointer model) final; @@ -151,10 +151,10 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * all possible sub vlnvs that need other vlnvs and adds them to the list. * The list doesn't contain single vlnv twice. * - * @param [in] vlnv Reference to the vlnv that is used as starting point for the search. - * @param [out] list Reference to the list where all vlnvs are added to. + * @param [in] vlnv Reference to the vlnv that is used as starting point for the search. + * @param [out] list Reference to the list where all vlnvs are added to. * - * @return List containing all vlnvs that are referenced in any of the documents. + * @return List containing all vlnvs that are referenced in any of the documents. */ void getNeededVLNVs(VLNV const& vlnv, QList& list) final; @@ -164,14 +164,14 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * absolute file paths to the needed files. This function searches files * only from this document, it does not search possible subcomponents. * - * @param [in] vlnv Reference to the vlnv that is used for the search. - * @param [out] list The files are appended to the list if they are not already on the list. + * @param [in] vlnv Reference to the vlnv that is used for the search. + * @param [out] list The files are appended to the list if they are not already on the list. */ void getDependencyFiles(VLNV const& vlnv, QStringList& list) final; /*! Get the library tree's root item * - * @return The root item. + * @return The root item. */ LibraryItem const* getTreeRoot() const final; @@ -179,35 +179,35 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * * If vlnv is not found in the library then VLNV::INVALID is returned. * - * @param [in] vlnv Specifies the document that's type is wanted. + * @param [in] vlnv Specifies the document that's type is wanted. * - * @return Type of the document. + * @return Type of the document. */ VLNV::IPXactType getDocumentType(VLNV const& vlnv) final; /*! Count how many times the given component is instantiated in the library. * - * @param [in] vlnv Identifies the component that's instances are searched. + * @param [in] vlnv Identifies the component that's instances are searched. * - * @return Number of found instances. + * @return Number of found instances. */ int referenceCount(VLNV const& vlnv) const final; /*! Get the items that have referenced the given vlnv in their meta data. * - * @param [out] list The search results. - * @param [in] vlnvToSearch Identifies the item to search for. + * @param [out] list The search results. + * @param [in] vlnvToSearch Identifies the item to search for. * - * @return Number of owners found. + * @return Number of owners found. */ int getOwners(QList& list, VLNV const& vlnvToSearch) const final; /*! Get the items that are needed by the specified item. * - * @param [in] list QList where the search results are appended. - * @param [in] vlnvToSearch Identifies the item thats child-items are wanted. + * @param [in] list QList where the search results are appended. + * @param [in] vlnvToSearch Identifies the item thats child-items are wanted. * - * @return int The number of found children. + * @return int The number of found children. */ int getChildren(QList& list, VLNV const& vlnvToSearch) const final; @@ -220,9 +220,9 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * design vlnv is returned. If design is not found then invalid vlnv is * returned. * - * @param [in] hierarchyRef The hierarchical reference obtained from component's view. + * @param [in] hierarchyRef The hierarchical reference obtained from component's view. * - * @return VLNV The vlnv identifying the design object. + * @return VLNV The vlnv identifying the design object. */ VLNV getDesignVLNV(VLNV const& hierarchyRef) final; @@ -235,17 +235,17 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface * design pointer is returned. If design is not found then null pointer is * returned. * - * @param [in] hierarchyRef The hierarchical reference obtained from component's view. + * @param [in] hierarchyRef The hierarchical reference obtained from component's view. * - * @return QSharedPointer The design. + * @return QSharedPointer The design. */ QSharedPointer getDesign(VLNV const& hierarchyRef) final; /*! Check if the identified object is in valid state. * - * @param [in] vlnv Identifies the object to check. + * @param [in] vlnv Identifies the object to check. * - * @return bool True if the object was valid. False if invalid or object was not found in library. + * @return bool True if the object was valid. False if invalid or object was not found in library. */ bool isValid(VLNV const& vlnv) final; @@ -256,10 +256,10 @@ class KACTUS2_API LibraryHandler : public QObject, public LibraryInterface /*! * Find errors in the given document. * - * @param [in] document The document to check. - * @param [in] documentPath The path to the document file on disk. + * @param [in] document The document to check. + * @param [in] documentPath The path to the document file on disk. * - * @return List of errors in the document. + * @return List of errors in the document. */ QVector findErrorsInDocument(QSharedPointer document, QString const& path); @@ -274,15 +274,15 @@ public slots: /*! Edit an item in the library * - * @param [in] vlnv Reference to the vlnv that identifies the object to edit. + * @param [in] vlnv Reference to the vlnv that identifies the object to edit. * */ void onEditItem(VLNV const& vlnv) final; /*! Open the specified component design * - * @param [in] vlnv Identifies the component that's design is wanted - * @param [in] viewName Identifies the view for the design. + * @param [in] vlnv Identifies the component that's design is wanted + * @param [in] viewName Identifies the view for the design. * */ void onOpenDesign(VLNV const& vlnv, QString const& viewName) final; @@ -290,21 +290,21 @@ public slots: /*! * Opens the memory design of the given HW design. * - * @param [in] vlnv The vlnv of the HW design. - * @param [in] activeView The active view of the selected HW design. + * @param [in] vlnv The vlnv of the HW design. + * @param [in] activeView The active view of the selected HW design. */ void onOpenMemoryDesign(VLNV const& vlnv, QString const& activeView); /*! Open the specified component SW design * - * @param [in] vlnv Identifies the component that's SW design is wanted + * @param [in] vlnv Identifies the component that's SW design is wanted * */ void onOpenSWDesign(VLNV const& vlnv); /*! Open the specified component system design * - * @param [in] vlnv Identifies the component that's system design is wanted + * @param [in] vlnv Identifies the component that's system design is wanted * */ void onOpenSystemDesign(VLNV const& vlnv); @@ -315,7 +315,7 @@ public slots: * This function does not ask user to verify the deletion, it just removes the object and * it's xml file. If vlnv is for component the component's files are not removed. * - * @param [in] vlnv Identifies the object. + * @param [in] vlnv Identifies the object. * */ void removeObject(VLNV const& vlnv) final; @@ -324,7 +324,7 @@ public slots: * * This function opens a dialog that asks user to confirm the deletion of the objects. * - * @param [in] vlnvList Identifies the objects to remove. + * @param [in] vlnvList Identifies the objects to remove. * */ void removeObjects(const QList& vlnvList) final; @@ -406,7 +406,7 @@ private slots: * on library views and possible changes made to the object are updated to * views. * - * @param [in] vlnv Identifies the object that was saved. + * @param [in] vlnv Identifies the object that was saved. * */ void onItemSaved(VLNV const& vlnv); @@ -439,8 +439,8 @@ private slots: /*! The constructor * - * @param [in] dialer The dialer that provides search options. - * @param [in] parent The parent widget of this instance. + * @param [in] dialer The dialer that provides search options. + * @param [in] parent The parent widget of this instance. */ LibraryHandler(); @@ -469,73 +469,73 @@ private slots: /*! * Removes the given file from the file system. * - * @param [in] filePath Path to the file to be removed. + * @param [in] filePath Path to the file to be removed. * - * @return True, if the file was successfully removed, otherwise false. + * @return True, if the file was successfully removed, otherwise false. */ bool removeFile(QString const& filePath) const; /*! * Check if the given document is valid IP-XACT. * - * @param [in] document The document to check. - * @param [in] documentPath The path to the document file on disk. + * @param [in] document The document to check. + * @param [in] documentPath The path to the document file on disk. * - * @return True, if the document is valid, otherwise false. + * @return True, if the document is valid, otherwise false. */ bool validateDocument(QSharedPointer document, QString const& documentPath); /*! Check the validity of VLNV references within a document. * - * @param [in] document The document to check. + * @param [in] document The document to check. * - * @return True if the VLVN references are valid, otherwise false. + * @return True if the VLVN references are valid, otherwise false. */ bool validateDependentVLNVReferencences(QSharedPointer document); /*! * Finds any errors within a given document VLNV references. * - * @param [in] document The document whose VLNV references to check. - * @param [out] errorList The list of errors to add any found errors. + * @param [in] document The document whose VLNV references to check. + * @param [out] errorList The list of errors to add any found errors. */ void findErrorsInDependentVLNVReferencences(QSharedPointer document, QVector& errorList); /*! Check the validity of directory references within a document. * * - * @param [in] document The document to check. - * @param [in] documentPath The path to the document XML file. + * @param [in] document The document to check. + * @param [in] documentPath The path to the document XML file. * - * @return True if the directory references are valid, otherwise false. + * @return True if the directory references are valid, otherwise false. */ bool validateDependentDirectories(QSharedPointer document, QString const& documentPath); /*! * Finds any errors within a given document directory references. * - * @param [in] document The document whose directory references to check. - * @param [in] documentPath The path to the document XML file. - * @param [out] errorList The list of errors to add any found errors. + * @param [in] document The document whose directory references to check. + * @param [in] documentPath The path to the document XML file. + * @param [out] errorList The list of errors to add any found errors. */ void findErrorsInDependentDirectories(QSharedPointer document, QString const& documentPath, QVector& errorList); /*! Check the validity of file references within a document. * - * @param [in] document The document to check. + * @param [in] document The document to check. * - * @return True if the file references are valid, otherwise false. + * @return True if the file references are valid, otherwise false. */ bool validateDependentFiles(QSharedPointer document, QString const& documentPath); /*! * Finds any errors within a given document file references. * - * @param [in] document The document whose file references to check. - * @param [in] documentPath The path to the document XML file. - * @param [out] errorList The list of errors to add any found errors. + * @param [in] document The document whose file references to check. + * @param [in] documentPath The path to the document XML file. + * @param [out] errorList The list of errors to add any found errors. */ void findErrorsInDependentFiles(QSharedPointer document, QString const& documentPath, QVector& errorList); diff --git a/KactusAPI/include/LibraryInterface.h b/KactusAPI/include/LibraryInterface.h index 27380bdd8..028655563 100644 --- a/KactusAPI/include/LibraryInterface.h +++ b/KactusAPI/include/LibraryInterface.h @@ -32,17 +32,17 @@ class LibraryInterface /*! Get a model that matches given VLNV. Must be used when changes are made to the document. * The provided document is a copy, meaning that it must be explicitly saved after the changes. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The model that matches the document. The ownership of the object remains on Library Handler. + * @return The model that matches the document. The ownership of the object remains on Library Handler. */ virtual QSharedPointer getModel(VLNV const& vlnv) = 0; /*! Convenience function for getting the model that matches given VLNV, if the type is known beforehand. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The model that matches the document. + * @return The model that matches the document. */ template QSharedPointer getModel(VLNV const& vlnv) @@ -53,17 +53,17 @@ class LibraryInterface /*! Get a model that matches given VLNV for read-only access. May be used when no changes are to be made * for the document. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The model that matches the document. The ownership of the object remains on Library Handler. + * @return The model that matches the document. The ownership of the object remains on Library Handler. */ virtual QSharedPointer getModelReadOnly(VLNV const& vlnv) = 0; /*! Convenience function for getting the model that matches given VLNV, if the type is known beforehand. * - * @param [in] vlnv Identifies the desired document. + * @param [in] vlnv Identifies the desired document. * - * @return The read-only model that matches the document. + * @return The read-only model that matches the document. */ template QSharedPointer getModelReadOnly(VLNV const& vlnv) @@ -73,40 +73,40 @@ class LibraryInterface /*! Checks if the library already contains the specified VLNV. * - * @param [in] vlnv The VLNV that is searched within the library. + * @param [in] vlnv The VLNV that is searched within the library. * - * @return True if the vlnv was found, otherwise false. + * @return True if the vlnv was found, otherwise false. */ virtual bool contains(VLNV const& vlnv) const = 0; /*! Gets all the VLNVs currently in the library. * - * @return All known VLNVs in the library. + * @return All known VLNVs in the library. */ virtual QList getAllVLNVs() const = 0; /*! Get a path to the specified IP-XACT document. * - * @param [in] vlnv Specifies the wanted IP-XACT document. + * @param [in] vlnv Specifies the wanted IP-XACT document. * - * @return The path to the document. If VLNV is not found then empty string is returned. + * @return The path to the document. If VLNV is not found then empty string is returned. */ virtual const QString getPath(VLNV const& vlnv) const = 0; /*! Get the directory path to the specified IP-XACT document. * - * @param [in] vlnv Specifies the wanted IP-XACT document. + * @param [in] vlnv Specifies the wanted IP-XACT document. * - * @return The directory path to the document. Does not contain the XML file name. + * @return The directory path to the document. Does not contain the XML file name. */ virtual QString getDirectoryPath(VLNV const& vlnv) const = 0; /*! Write the model to file system to given file path. * - * @param [in] path Directory path that specifies the directory to save to file into. - * @param [in] model The library component that is written. + * @param [in] path Directory path that specifies the directory to save to file into. + * @param [in] model The library component that is written. * - * @return True if the model was in valid state and was successfully written. + * @return True if the model was in valid state and was successfully written. * * @remark The path must not contain the file name. * @remark If file already exists in file system it is overwritten. @@ -116,9 +116,9 @@ class LibraryInterface /*! Write the already registered model to file system. * - * @param [in] modelThe model to be written. + * @param [in] modelThe model to be written. * - * @return True if the model was in valid state and was successfully written. + * @return True if the model was in valid state and was successfully written. * * @remark The model must be already part of the library and it's file path can be found. * @remark This operation cannot be undone. @@ -135,8 +135,8 @@ class LibraryInterface * all possible sub VLNVs that need other VLNVs and adds them to the list. * The list doesn't contain single VLNV twice. * - * @param [in] vlnv The VLNV that is used as starting point for the search. - * @param [out] list The list where all VLNVs are added to. + * @param [in] vlnv The VLNV that is used as starting point for the search. + * @param [out] list The list where all VLNVs are added to. */ virtual void getNeededVLNVs(VLNV const& vlnv, QList& list) = 0; @@ -146,8 +146,8 @@ class LibraryInterface * absolute file paths to the needed files. This function searches files * only from this document, it does not search possible subcomponents. * - * @param [in] vlnv The VLNV that is used for the search. - * @param [out] list The files are appended to the list if they are not already on the list. + * @param [in] vlnv The VLNV that is used for the search. + * @param [out] list The files are appended to the list if they are not already on the list. */ virtual void getDependencyFiles(VLNV const& vlnv, QStringList& list) = 0; @@ -160,35 +160,35 @@ class LibraryInterface * * If vlnv is not found in the library then VLNV::INVALID is returned. * - * @param [in] vlnv Specifies the document that's type is wanted. + * @param [in] vlnv Specifies the document that's type is wanted. * - * @return The type of the document. + * @return The type of the document. */ virtual VLNV::IPXactType getDocumentType(VLNV const& vlnv) = 0; /*! Count how many times the given component is instantiated in the library. * - * @param [in] vlnv Identifies the component that's instances are searched. + * @param [in] vlnv Identifies the component that's instances are searched. * - * @return Number of found instances. + * @return Number of found instances. */ virtual int referenceCount(VLNV const& vlnv) const = 0; /*! Get the components that have instantiated the given vlnv in their design. * - * @param [out] list The search results. - * @param [in] vlnvToSearch Identifies the component to search for. + * @param [out] list The search results. + * @param [in] vlnvToSearch Identifies the component to search for. * - * @return Number of owners found. + * @return Number of owners found. */ virtual int getOwners(QList& list, VLNV const& vlnvToSearch) const = 0; /*! Get the items that are needed by the specified item. * - * @param [out] list The search results. - * @param [in] vlnvToSearch Identifies the item thats child-items are wanted. + * @param [out] list The search results. + * @param [in] vlnvToSearch Identifies the item thats child-items are wanted. * - * @return int The number of found children. + * @return int The number of found children. */ virtual int getChildren(QList& list, VLNV const& vlnvToSearch) const = 0; @@ -201,9 +201,9 @@ class LibraryInterface * design VLNV is returned. If design is not found then invalid VLNV is * returned. * - * @param [in] hierarchyRef The hierarchical reference obtained from component's view. + * @param [in] hierarchyRef The hierarchical reference obtained from component's view. * - * @return VLNV The VLNV identifying the design object. + * @return VLNV The VLNV identifying the design object. */ virtual VLNV getDesignVLNV(VLNV const& hierarchyRef) = 0; @@ -216,17 +216,17 @@ class LibraryInterface * design pointer is returned. If design is not found then null pointer is * returned. * - * @param [in] hierarchyRef The hierarchical reference obtained from component's view. + * @param [in] hierarchyRef The hierarchical reference obtained from component's view. * - * @return The design. + * @return The design. */ virtual QSharedPointer getDesign(VLNV const& hierarchyRef) = 0; /*! Check if the identified object is in valid state. * - * @param [in] VLNV Identifies the object to check. + * @param [in] VLNV Identifies the object to check. * - * @return bool True if the object was valid. False if invalid or object was not found in library. + * @return bool True if the object was valid. False if invalid or object was not found in library. */ virtual bool isValid(VLNV const& vlnv) = 0; @@ -241,14 +241,14 @@ public slots: /*! Edit an item in the library * - * @param [in] vlnv Reference to the vlnv that identifies the object to edit. + * @param [in] vlnv Reference to the vlnv that identifies the object to edit. */ virtual void onEditItem(VLNV const& vlnv) = 0; /*! Open the specified component design * - * @param [in] vlnv Identifies the component that's design is wanted - * @param [in] viewName Identifies the view for the design. + * @param [in] vlnv Identifies the component that's design is wanted + * @param [in] viewName Identifies the view for the design. */ virtual void onOpenDesign(VLNV const& vlnv, QString const& viewName) = 0; @@ -257,7 +257,7 @@ public slots: * This function does not ask user to verify the deletion, it just removes the object and * it's xml file. If vlnv is for component the component's files are not removed. * - * @param [in] vlnv Identifies the object. + * @param [in] vlnv Identifies the object. */ virtual void removeObject(VLNV const& vlnv) = 0; @@ -265,7 +265,7 @@ public slots: * * This function opens a dialog that asks user to confirm the deletion of the objects. * - * @param [in] vlnvList Identifies the objects to remove. + * @param [in] vlnvList Identifies the objects to remove. */ virtual void removeObjects(const QList& vlnvList) = 0; diff --git a/KactusAPI/include/LibraryItem.h b/KactusAPI/include/LibraryItem.h index 428497616..57fa71aed 100644 --- a/KactusAPI/include/LibraryItem.h +++ b/KactusAPI/include/LibraryItem.h @@ -50,9 +50,9 @@ class KACTUS2_API LibraryItem : public QObject /*! The constructor * - * @param [in] vlnv A VLNV tag that is to be added to database. - * @param [in] level The level of the item in the hierarchy. - * @param [in] parent The parent of this item. + * @param [in] vlnv A VLNV tag that is to be added to database. + * @param [in] level The level of the item in the hierarchy. + * @param [in] parent The parent of this item. */ LibraryItem(VLNV const& vlnv, Level level, LibraryItem *parent); @@ -61,52 +61,52 @@ class KACTUS2_API LibraryItem : public QObject /*! Create a new child for an existing item. * - * @param [in] vlnv A VLNV tag that is to be added to database. - * @param [in] level The level of the item in the hierarchy. + * @param [in] vlnv A VLNV tag that is to be added to database. + * @param [in] level The level of the item in the hierarchy. */ void createChild(VLNV const& vlnv, Level level); /*! Get the parent of the current node. * - * @return The parent of the item. + * @return The parent of the item. */ LibraryItem* parent() const; /*! Get the name of the item. * - * @return The name of the item. + * @return The name of the item. */ QString name() const; /*! Get the level of the item in the hierarchy. * - * @return The level the item is in. + * @return The level the item is in. */ Level getLevel() const; /*! Get the child item. * - * @param [in] index index of the child item. + * @param [in] index index of the child item. * - * @return The child. + * @return The child. */ LibraryItem* child(int index) const; /*! Get the row number of the child item. * - * @return The row number where the item is located in its parents list. + * @return The row number where the item is located in its parents list. */ int row(); /*! Get the number of child items the item has. * - * @return How many children item owns. + * @return How many children item owns. */ int getNumberOfChildren() const; /*! Get the VLNV tag of this item. * - * @return A VLNV instance that is represented by this item. + * @return A VLNV instance that is represented by this item. * * @remark Valid VLNV pointer can only be returned if this item is level VERSION. */ @@ -114,28 +114,28 @@ class KACTUS2_API LibraryItem : public QObject /*! Get the index of the specified item. * - * @param [in] item The library item that's row number is searched. + * @param [in] item The library item that's row number is searched. * - * @return The row number of the specified item. + * @return The row number of the specified item. */ int getIndexOf(LibraryItem* item); /*! Check if this item has children or not. * - * @return True if item has child-items, otherwise false. + * @return True if item has child-items, otherwise false. */ bool hasChildren() const; /*! Get list of all VLNV tags that exist under this item. * - * @return List of all VLNVs. + * @return List of all VLNVs. */ QVector getVLNVs() const; /*! Remove a child of this item. * - * @param [in] childItem The child item that should be removed. + * @param [in] childItem The child item that should be removed. */ void removeChild(LibraryItem* childItem); @@ -145,9 +145,9 @@ class KACTUS2_API LibraryItem : public QObject * are found then this function calls parent item to check if it can be * used to identify a single item. * - * @param [in] childItem The item that is currently the highest possible item. + * @param [in] childItem The item that is currently the highest possible item. * - * @return LibraryItem* The item that is to be removed. + * @return LibraryItem* The item that is to be removed. */ LibraryItem* findHighestUnique(LibraryItem* childItem = 0); @@ -155,23 +155,23 @@ class KACTUS2_API LibraryItem : public QObject * * This function finds the highest level possible to identify a single item. * - * @param [in] vlnv The vlnv element that must be matched. + * @param [in] vlnv The vlnv element that must be matched. * - * @return The item that is the highest level item. + * @return The item that is the highest level item. */ LibraryItem* findHighestUnique(VLNV const& vlnv); /*! Find the library item that uniquely represents the specified vlnv. * - * @param [in] vlnv The vlnv that identifies the item to find. + * @param [in] vlnv The vlnv that identifies the item to find. * - * @return The LibraryItem that represents the vlnv in the tree. + * @return The LibraryItem that represents the vlnv in the tree. */ LibraryItem* findItem(VLNV const& vlnv); /*! Set the vlnv to match the tree structure of this item * - * @param [out] vlnv The vlnv instance to set. + * @param [out] vlnv The vlnv instance to set. */ void setVlnv(VLNV& vlnv); @@ -180,39 +180,39 @@ class KACTUS2_API LibraryItem : public QObject /*! Get all vendor items. * - * @return All vendor items under this item. + * @return All vendor items under this item. */ QVector getVendors() const; /*! Get all library items. * - * @return All library items under this item. + * @return All library items under this item. */ QVector getLibraries() const; /*! Get all name items. * - * @return All name items under this item. + * @return All name items under this item. */ QVector getNames() const; /*! Get all version items. * - * @return All version items under this item. + * @return All version items under this item. */ QVector getVersions() const; /*! * Checks if the item is valid. * - * @return True, if the item is valid, otherwise false. + * @return True, if the item is valid, otherwise false. */ bool isValid() const; /*! * Sets the validity of the item. * - * @param [in] valid The validity to set. + * @param [in] valid The validity to set. */ void setValid(bool valid); @@ -228,10 +228,10 @@ class KACTUS2_API LibraryItem : public QObject /*! * Finds the child item on the given level from the given VLNV. * - * @param [in] level The level to get the item for. - * @param [in] vlnv The VLNV to get the item from. + * @param [in] level The level to get the item for. + * @param [in] vlnv The VLNV to get the item from. * - * @return The child item on the given level. + * @return The child item on the given level. */ LibraryItem* findChildForLevel(Level level, VLNV const& vlnv); diff --git a/KactusAPI/include/LibraryLoader.h b/KactusAPI/include/LibraryLoader.h index d40deb30a..3b7c30c96 100644 --- a/KactusAPI/include/LibraryLoader.h +++ b/KactusAPI/include/LibraryLoader.h @@ -40,13 +40,13 @@ class LibraryLoader /*! Cleans the directory structure. * - * @param [in] changedDirectories Changed directories (e.g. after a remove). + * @param [in] changedDirectories Changed directories (e.g. after a remove). */ void clean(QStringList const& changedDirectories) const; /*! Searches for IP-XACT files and returns any found targets. * - * @return The found IP-XACT targets. + * @return The found IP-XACT targets. */ QVector parseLibrary(MessageMediator const* messageChannel) const; @@ -54,24 +54,24 @@ class LibraryLoader /*! Finds the VLNV in the given file. * - * @param [in] path The file path to search. + * @param [in] path The file path to search. * - * @return The VLNV found in the given file. + * @return The VLNV found in the given file. */ VLNV getDocumentVLNV(QString const& path, MessageMediator const* messageChannel) const; /*! Clear the empty directories from the disk within given path. * - * @param [in] dirPath The path that is removed until one of the base library locations is reached. - * @param [in] libraryLocations Contains the base library locations user has defined. + * @param [in] dirPath The path that is removed until one of the base library locations is reached. + * @param [in] libraryLocations Contains the base library locations user has defined. * */ void clearDirectoryStructure(QString const& dirPath, QStringList const& libraryLocations) const; /*! Check if the path contains one of the given paths. * - * @param [in] path The path to a directory. - * @param [in] pathsToSearch Paths that are checked if they are contained in the given path. + * @param [in] path The path to a directory. + * @param [in] pathsToSearch Paths that are checked if they are contained in the given path. * */ bool containsPath(QString const& path, QStringList const& pathsToSearch) const; diff --git a/KactusAPI/include/LibraryTreeModel.h b/KactusAPI/include/LibraryTreeModel.h index b3299fa65..e4d81cf97 100644 --- a/KactusAPI/include/LibraryTreeModel.h +++ b/KactusAPI/include/LibraryTreeModel.h @@ -37,8 +37,8 @@ class KACTUS2_API LibraryTreeModel : public QAbstractItemModel /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this class + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this class * */ LibraryTreeModel(LibraryInterface* handler, QObject* parent = 0); @@ -48,84 +48,84 @@ class KACTUS2_API LibraryTreeModel : public QAbstractItemModel /*! Get the data for the headers of this model. * - * @param [in] section Specifies the column of the header. - * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. - * @param [in] role Specifies the role of the data. + * @param [in] section Specifies the column of the header. + * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. + * @param [in] role Specifies the role of the data. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! Get the number of columns in this model * - * @param [in] parent Model index identifying the item that's column count is wanted. + * @param [in] parent Model index identifying the item that's column count is wanted. * - * @return Number of columns. + * @return Number of columns. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of rows an item has. * - * @param [in] parent Model index identifying the item that's row count is wanted + * @param [in] parent Model index identifying the item that's row count is wanted * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ virtual QModelIndex index(int row, int column, QModelIndex const& parent = QModelIndex()) const; /*! Get the model index of the parent of the object * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelIndex that identifies the parent of the given object. + * @return QModelIndex that identifies the parent of the given object. */ virtual QModelIndex parent(QModelIndex const& child) const; /*! Get the data associated with given object. * - * @param [in] index Model index that identifies the object that's data is wanted. - * @param [in] role Specifies the type of data wanted. + * @param [in] index Model index that identifies the object that's data is wanted. + * @param [in] role Specifies the type of data wanted. * - * @return QVariant Containing the requested data. + * @return QVariant Containing the requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Does the specified item have child items or not. * - * @param [in] parent Model index identifying the object that's children are asked. + * @param [in] parent Model index identifying the object that's children are asked. * - * @return True if object has child objects. + * @return True if object has child objects. */ virtual bool hasChildren(QModelIndex const& parent = QModelIndex()) const; /*! Get the flags that identify possible methods for given object. * - * @param [in] index Model index identifying the object that's flags are requested. + * @param [in] index Model index identifying the object that's flags are requested. * - * @return Qt::ItemFlags that specify how the object can be handled. + * @return Qt::ItemFlags that specify how the object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Get the root item of the tree. * - * @return The root item + * @return The root item */ LibraryItem* getRoot() const; /*! Create a model index for a library item * - * @param [in] item The LibraryItem that's model index is wanted + * @param [in] item The LibraryItem that's model index is wanted * - * @return QModelIndex that identifies the libraryItem. + * @return QModelIndex that identifies the libraryItem. */ QModelIndex index(LibraryItem* item); @@ -227,7 +227,7 @@ public slots: * * Function updates the hierarchical model so that changes made to the document are visible. * - * @param [in] vlnv Identifies the document that changed. + * @param [in] vlnv Identifies the document that changed. */ void onDocumentUpdated(VLNV const& vlnv); @@ -241,16 +241,16 @@ public slots: /*! Removes an item from the treeModel * - * @param [in] toRemove The LibraryItem that is the highest-level item to remove. + * @param [in] toRemove The LibraryItem that is the highest-level item to remove. */ void removeLibraryItem(LibraryItem* toRemove); /*! * Validates the given item and possible sub-items. * - * @param [in] item The item to validate. + * @param [in] item The item to validate. * - * @return True, if the item is valid, otherwise false. + * @return True, if the item is valid, otherwise false. */ bool validate(LibraryItem* item); diff --git a/KactusAPI/include/ListParameterFinder.h b/KactusAPI/include/ListParameterFinder.h index 1e56c2d07..d329018d8 100644 --- a/KactusAPI/include/ListParameterFinder.h +++ b/KactusAPI/include/ListParameterFinder.h @@ -47,62 +47,62 @@ class KACTUS2_API ListParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const override; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const override; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const override; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const override; /*! * Gets all of the ids of parameters in the list. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const override; /*! * Gets the number of parameters in the list. * - * @return The number of parameters in the list. + * @return The number of parameters in the list. */ int getNumberOfParameters() const noexcept override; /*! * Set the parameter list. * - * @param [in] parameterList [Description]. + * @param [in] parameterList [Description]. */ void setParameterList(QSharedPointer > > parameterList) noexcept; /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; diff --git a/KactusAPI/include/MasterPortInterface.h b/KactusAPI/include/MasterPortInterface.h index a73a6413f..5d01ba081 100644 --- a/KactusAPI/include/MasterPortInterface.h +++ b/KactusAPI/include/MasterPortInterface.h @@ -38,57 +38,57 @@ class KACTUS2_API MasterPortInterface : public NameGroupInterface /*! * Add a wire port. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ virtual void addWirePort(std::string const& newPortName = std::string()) = 0; /*! * Add a transactional port. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ virtual void addTransactionalPort(std::string const& newPortName = std::string()) = 0; /*! * Check if the selected port is a wire. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is a wire, false otherwise. + * @return True, if the selected port is a wire, false otherwise. */ virtual bool portIsWire(std::string const& portName) const = 0; /*! * Check if the selected port is transactional. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is transactional, false otherwise. + * @return True, if the selected port is transactional, false otherwise. */ virtual bool portIsTransactional(std::string const& portName) const = 0; /*! * Get the icon path of a missing port. * - * @return Icon path for the selected port. + * @return Icon path for the selected port. */ std::string getIconPathForMissingPort() const; /*! * Get the icon path of the selected direction. * - * @param [in] direction Direction of the selected port. + * @param [in] direction Direction of the selected port. * - * @return Icon path for the selected direction. + * @return Icon path for the selected direction. */ std::string getIconPathForDirection(DirectionTypes::Direction direction) const; /*! * Get the icon path of the selected initiative. * - * @param [in] initiative The selected initiative. + * @param [in] initiative The selected initiative. * - * @return Icon path for the selected initiative. + * @return Icon path for the selected initiative. */ std::string getIconPathForInitiative(QString const& initiative) const; diff --git a/KactusAPI/include/MemoryBlockInterface.h b/KactusAPI/include/MemoryBlockInterface.h index 0b925b310..5566f7d13 100644 --- a/KactusAPI/include/MemoryBlockInterface.h +++ b/KactusAPI/include/MemoryBlockInterface.h @@ -39,10 +39,10 @@ class KACTUS2_API MemoryBlockInterface : public ParameterizableInterface, public /*! * The constructor. * - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parameterInterface Interface for accessing parameters. */ MemoryBlockInterface(QSharedPointer expressionParser, QSharedPointer expressionFormatter, @@ -57,256 +57,256 @@ class KACTUS2_API MemoryBlockInterface : public ParameterizableInterface, public /*! * Set available memory blocks. * - * @param [in] newMemoryBlocks The new memory block data. + * @param [in] newMemoryBlocks The new memory block data. */ void setMemoryBlocks(QSharedPointer > > newMemoryBlocks); /*! * Setup the sub interfaces. * - * @param [in] newComponent Component containing the available items. + * @param [in] newComponent Component containing the available items. */ void setupSubInterfaces(QSharedPointer newComponent); /*! * Get the interface for accessing bus interfaces. * - * @return Interface for accessing bus interfaces. + * @return Interface for accessing bus interfaces. */ BusInterfaceInterface* getBusInterface() const; /*! * Check if the selected memory block is accepted. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return True, if the memory block is accepted, false otherwise. + * @return True, if the memory block is accepted, false otherwise. */ virtual bool acceptBlock(std::string const& blockName) const = 0; /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the calculated base address value of the selected memory block. * - * @param [in] blockName Name of the selected memory block. - * @param [in] baseNumber Base for displaying the value. + * @param [in] blockName Name of the selected memory block. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated base address value of the selected memory block. + * @return Calculated base address value of the selected memory block. */ std::string getBaseAddressValue(std::string const& blockName, int const& baseNumber = 0) const; /*! * Get the formatted base address expression of the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return Formatted base address expression of the selected memory block. + * @return Formatted base address expression of the selected memory block. */ std::string getBaseAddressFormattedExpression(std::string const& blockName) const; /*! * Get the base address expression of the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return Base address expression of the selected memory block. + * @return Base address expression of the selected memory block. */ std::string getBaseAddressExpression(std::string const& blockName) const; /*! * Set a new base address value for the selected memory block. * - * @param [in] blockName Name of the selected memory block. - * @param [in] newBaseAddress New base memory value. + * @param [in] blockName Name of the selected memory block. + * @param [in] newBaseAddress New base memory value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBaseAddress(std::string const& blockName, std::string const& newBaseAdress) const; /*! * Get the calculated is present value of the selected memory block. * - * @param [in] blockName Name of the selected memory block. - * @param [in] baseNumber Base for displaying the value. + * @param [in] blockName Name of the selected memory block. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated is present value of the selected memory block. + * @return Calculated is present value of the selected memory block. */ std::string getIsPresentValue(std::string const& blockName, int const& baseNumber = 0) const; /*! * Get the formatted is present expression of the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return Formatted is present expression of the selected memory block. + * @return Formatted is present expression of the selected memory block. */ std::string getIsPresentFormattedExpression(std::string const& blockName) const; /*! * Get the is present expression of the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return Is present expression of the selected memory block. + * @return Is present expression of the selected memory block. */ std::string getIsPresentExpression(std::string const& blockName) const; /*! * Set a new is present value for the selected memory block. * - * @param [in] blockName Name of the selected memory block. - * @param [in] newIsPresent New is present value. + * @param [in] blockName Name of the selected memory block. + * @param [in] newIsPresent New is present value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsPresent(std::string const& blockName, std::string const& newIsPresent) const; /*! * Get the calculated range value of the selected memory block. * - * @param [in] blockName Name of the selected memory block. - * @param [in] baseNumber Base for displaying the value. + * @param [in] blockName Name of the selected memory block. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated range value of the selected memory block. + * @return Calculated range value of the selected memory block. */ std::string getRangeValue(std::string const& blockName, int const& baseNumber = 0) const; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override = 0; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ bool itemHasValidName(std::string const& itemName) const; /*! * Check if the selected memory block has a valid base address. * - * @param [in] itemName Name of the selected memory block. + * @param [in] itemName Name of the selected memory block. * - * @return True, if the base address is valid, false otherwise. + * @return True, if the base address is valid, false otherwise. */ bool hasValidBaseAddress(std::string const& itemName) const; /*! * Check if the selected memory block has a valid is present value. * - * @param [in] itemName Name of the selected memory block. + * @param [in] itemName Name of the selected memory block. * - * @return True, if the is present value is valid, false otherwise. + * @return True, if the is present value is valid, false otherwise. */ bool hasValidIsPresent(std::string const& itemName) const; /*! * Add a new memory block. * - * @param [in] row Row of the new memory block. - * @param [in] newBlockName Name of the new memory block. + * @param [in] row Row of the new memory block. + * @param [in] newBlockName Name of the new memory block. */ virtual void addBlock(int const& row, std::string const& newBlockName = std::string("")) = 0; /*! * Remove the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeBlock(std::string const& blockName); /*! * Copy the selected items. * - * @param [in] selectedRows Indexes of the selected items. + * @param [in] selectedRows Indexes of the selected items. */ void copyRows(std::vector selectedRows); /*! * Paste the selected items. * - * @return Names of the pasted items. + * @return Names of the pasted items. */ std::vector pasteRows(); /*! * Get the number of pasted items. * - * @return Number of the pasted items. + * @return Number of the pasted items. */ int getPasteRowCount() const; /*! * Get the expressions in the selected items. * - * @param [in] itemNames Names of the selected items. + * @param [in] itemNames Names of the selected items. * - * @return The expressions of the selected items. + * @return The expressions of the selected items. */ virtual std::vector getExpressionsInSelectedItems(std::vector const& itemNames) const = 0; /*! * Change the value for address unit bits. * - * @param [in] newAddressUnitbits The new value for address unit bits. + * @param [in] newAddressUnitbits The new value for address unit bits. */ void setAddressUnitBits(std::string const& newAddressUnitbits); @@ -315,39 +315,39 @@ class KACTUS2_API MemoryBlockInterface : public ParameterizableInterface, public /*! * Get the available memory blocks. * - * @return List of available memory blocks. + * @return List of available memory blocks. */ QSharedPointer > > getBlocksData(); /*! * Get the base address for a new memory block. * - * @return Base address for a new memory block. + * @return Base address for a new memory block. */ QString getNewBlockBaseAddress() const; /*! * Get the selected memory block. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return The selected memory block. + * @return The selected memory block. */ QSharedPointer getBlock(std::string const& itemName) const; /*! * Get the address unit bits. * - * @return The address unit bits. + * @return The address unit bits. */ QString getAddressUnitBits() const; /*! * Get the address space within the selected bus interface. * - * @param [in] masterBusReference Name of the selected bus interface. + * @param [in] masterBusReference Name of the selected bus interface. * - * @return Address space within the selected bus interface. + * @return Address space within the selected bus interface. */ QSharedPointer getReferencedAddressSpace(QString const& masterBusReference) const; @@ -356,59 +356,59 @@ class KACTUS2_API MemoryBlockInterface : public ParameterizableInterface, public /*! * Get the default name for a memory block. * - * @return Default name for a memory block. + * @return Default name for a memory block. */ virtual std::string getDefaultName() const = 0; /*! * Get a list of the copied memory blocks. * - * @param [in] selectedRows Rows of the copied memory blocks. + * @param [in] selectedRows Rows of the copied memory blocks. * - * @return List of the copied memory blocks. + * @return List of the copied memory blocks. */ virtual QList > getCopiedBlocks(std::vector const& selectedRows) const = 0; /*! * Get the mime type of the memory block. * - * @return The mime type of the memory block. + * @return The mime type of the memory block. */ virtual QString getMimeType() const = 0; /*! * Create a copy of the selected memory block. * - * @param [in] copiedItem The selected memory block- + * @param [in] copiedItem The selected memory block- * - * @return Copy of the selected memory block. + * @return Copy of the selected memory block. */ virtual QSharedPointer createCopyBlock(QSharedPointer copiedItem) const = 0; /*! * Count the memory block items in the selected list. * - * @param [in] itemList List of memory block items. + * @param [in] itemList List of memory block items. * - * @return Number of memory block items in the selected list. + * @return Number of memory block items in the selected list. */ virtual int countItems(QList > itemList) const = 0; /*! * Get the memory block validator. * - * @return The memory block validator. + * @return The memory block validator. */ virtual QSharedPointer getValidator() const = 0; /*! * Get the segment referenced by the selected subspace map. * - * @param [in] referencedSpace Address space within the master bus interface referenced by the + * @param [in] referencedSpace Address space within the master bus interface referenced by the * selected subspace map. - * @param [in] segmentReference Name of the selected segment. + * @param [in] segmentReference Name of the selected segment. * - * @return Segment referenced by the selected subspace map. + * @return Segment referenced by the selected subspace map. */ QSharedPointer getReferencedSegment(QSharedPointer referencedSpace, QString const& segmentReference) const; diff --git a/KactusAPI/include/MemoryMapExpressionsGatherer.h b/KactusAPI/include/MemoryMapExpressionsGatherer.h index 65facaa53..381e6c85d 100644 --- a/KactusAPI/include/MemoryMapExpressionsGatherer.h +++ b/KactusAPI/include/MemoryMapExpressionsGatherer.h @@ -38,9 +38,9 @@ class MemoryMapExpressionGatherer /*! * Get the expressions from a given memory map. * - * @param [in] memoryMap The given memory map. + * @param [in] memoryMap The given memory map. * - * @return A list containing all the expressions used in a memory map. + * @return A list containing all the expressions used in a memory map. */ QStringList getExpressions(QSharedPointer memoryMap) const; diff --git a/KactusAPI/include/MemoryMapInterface.h b/KactusAPI/include/MemoryMapInterface.h index 8004f09e6..3570b34f9 100644 --- a/KactusAPI/include/MemoryMapInterface.h +++ b/KactusAPI/include/MemoryMapInterface.h @@ -38,9 +38,9 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * The constructor. * - * @param [in] mapValidator Validator for memory maps. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] mapValidator Validator for memory maps. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ MemoryMapInterface(QSharedPointer mapValidator, QSharedPointer expressionParser, @@ -54,133 +54,133 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Set a new address block interface. * - * @param [in] blockInterface The new address block interface. + * @param [in] blockInterface The new address block interface. */ void setAddressBlockInterface(AddressBlockInterface* blockInterface); /*! * Set a new subspace map interface. * - * @param [in] submapInterface The new subspace map interface. + * @param [in] submapInterface The new subspace map interface. */ void setSubspaceMapInterface(SubspaceMapInterface* submapInterface); /*! * Set available memory maps. * - * @param [in] component Component containing the memory maps. + * @param [in] component Component containing the memory maps. */ void setMemoryMaps(QSharedPointer component); /*! * Get index of the selected memory map. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get index of the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the selected memory remap. * - * @return Index of the selected memory remap. + * @return Index of the selected memory remap. */ int getMemoryRemapIndex(std::string const& mapName, std::string const& remapName) const; /*! * Get name of the indexed memory map. * - * @param [in] itemIndex Index of the selected memory map. + * @param [in] itemIndex Index of the selected memory map. * - * @return Name of the selected memory map. + * @return Name of the selected memory map. */ std::string getIndexedItemName(int itemIndex) const final; /* * Get name of the indexed memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] itemIndex Index of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] itemIndex Index of the selected memory remap. * - * @return Name of the selected memory remap. + * @return Name of the selected memory remap. */ std::string getIndexedRemapName(std::string mapName, int const& itemIndex) const; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the number of available memory remaps in the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return Number of available memory remaps in the selected memory map. + * @return Number of available memory remaps in the selected memory map. */ int remapCount(std::string const& mapName) const; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Get the names of available memory remaps in the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return Names of the available memory remaps in the selected memory map. + * @return Names of the available memory remaps in the selected memory map. */ std::vector getRemapNames(std::string const& mapName) const; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Set a new name for the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] currentName Name of the selected memory remap. - * @param [in] newName New name for the memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] currentName Name of the selected memory remap. + * @param [in] newName New name for the memory remap. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRemapName(std::string const& mapName, std::string const& currentName, std::string const& newName); /*! * Get the description of the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the selected memory remap. * - * @return Description of the selected memory remap. + * @return Description of the selected memory remap. */ std::string getRemapDescription(std::string const& mapName, std::string const& remapName) const; /*! * Set a new description for the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] itemName Name of the selected memory remap. - * @param [in] newDescription New description. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] itemName Name of the selected memory remap. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRemapDescription(std::string const& mapName, std::string const& itemName, std::string const& newDescription); @@ -188,11 +188,11 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the calculated is present value of the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. - * @param [in] baseNumber Base for displaying the value. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated is present value of the selected item. + * @return Calculated is present value of the selected item. */ std::string getIsPresentValue(std::string const& mapName, std::string const& remapName = "", int const& baseNumber = 0) const; @@ -200,31 +200,31 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the formatted is present expression of the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. * - * @return Formatted is present expression of the selected item. + * @return Formatted is present expression of the selected item. */ std::string getIsPresentFormattedExpression(std::string const& mapName, std::string const& remapName = "") const; /*! * Get the is present expression of the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. * - * @return Is present expression of the selected item. + * @return Is present expression of the selected item. */ std::string getIsPresentExpression(std::string const& mapName, std::string const& remapName = "") const; /*! * Set a new is present value for the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. - * @param [in] newIsPresent New is present value. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. + * @param [in] newIsPresent New is present value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsPresent(std::string const& mapName, std::string const& newIsPresent, std::string const& remapName = ""); @@ -232,37 +232,37 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the remap state of the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. * - * @return Remap state of the selected item. + * @return Remap state of the selected item. */ std::string getRemapState(std::string const& mapName, std::string const& remapName = "") const; /*! * Set the remap state for the selected item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. - * @param [in] newRemapState New remap state. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. + * @param [in] newRemapState New remap state. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRemapState(std::string const& mapName, std::string const& remapName, std::string const& newRemapState); /*! * Get the address unit bits expression of the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return Address unit bits expression of the selected memory map. + * @return Address unit bits expression of the selected memory map. */ std::string getAddressUnitBitsExpression(std::string const& mapName) const; /*! * Get the address unit bits value of the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * * @return Address unit bits of the selected memory map. */ @@ -271,7 +271,7 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the formatted address unit bits expression of the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * * @return Formatted address unit bits expression of the selected memory map. */ @@ -280,38 +280,38 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Set the address unit bits for the selected memory map. * - * @param [in] mapName Name of the selected memory map. - * @param [in] newAddressUnitBits New address unit bits. + * @param [in] mapName Name of the selected memory map. + * @param [in] newAddressUnitBits New address unit bits. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAddressUnitBits(std::string const& mapName, std::string const& newAddressUnitBits) const; /*! * Get the slave interface binding of the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return Slave interface binding of the selected memory map. + * @return Slave interface binding of the selected memory map. */ std::string getInterfaceBinding(std::string const& mapName) const; /*! * Get the associated slave interface of the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return The associated slave interfaces of the selected memory map. + * @return The associated slave interfaces of the selected memory map. */ std::vector getAssociatedSlaveInterfaces(std::string const& mapName) const; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -319,21 +319,21 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the expressions in the selected memory item. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. * - * @return List of expressions in the selected memory item. + * @return List of expressions in the selected memory item. */ std::vector getMapExpressions(std::string const& mapName, std::string const& remapName) const; /*! * Get the number of references made to the selected parameter in the selected memory remap. * - * @param [in] mapName Name of the selected memory map. - * @param [in] remapName Name of the selected memory remap. - * @param [in] valueID ID of the selected parameter. + * @param [in] mapName Name of the selected memory map. + * @param [in] remapName Name of the selected memory remap. + * @param [in] valueID ID of the selected parameter. * - * @return The number of references made to the selected parameter in the selected memory remap. + * @return The number of references made to the selected parameter in the selected memory remap. */ int getAllReferencesToIdInRemapItem(std::string const& mapName, std::string const& remapName, std::string const& valueID) const; @@ -341,154 +341,154 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Check if the selected memory remap has a valid name. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] itemName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] itemName Name of the selected memory remap. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ bool remapHasValidName(std::string const& mapName, std::string const& itemName) const; /*! * Check if the selected memory remap has a valid remap state. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] itemName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] itemName Name of the selected memory remap. * - * @return True, if the remap state is valid, false otherwise. + * @return True, if the remap state is valid, false otherwise. */ bool remapHasValidRemapState(std::string const& mapName, std::string const& itemName) const; /*! * Check if the selected memory item has a valid is present. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the selected memory remap. * - * @return True, if the is present is valid, false otherwise. + * @return True, if the is present is valid, false otherwise. */ bool itemHasValidIsPresent(std::string const& mapName, std::string const& remapName = "") const; /*! * Check if the selected memory map has a valid address unit bits value. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return True, if the address unit bits value is valid, false otherwise. + * @return True, if the address unit bits value is valid, false otherwise. */ bool memoryMapHasValidAddressUnitBits(std::string const& mapName) const; /*! * Add a new memory map. * - * @param [in] row Row of the new memory map. - * @param [in] newMapName Name of the new memory map. + * @param [in] row Row of the new memory map. + * @param [in] newMapName Name of the new memory map. */ void addMemoryMap(int const& row, std::string const& newMapName = std::string("")); /*! * Add a new memory remap. * - * @param [in] mapName Name of the memory map containing the new memory remap. - * @param [in] newRemapName Name of the new memory map. + * @param [in] mapName Name of the memory map containing the new memory remap. + * @param [in] newRemapName Name of the new memory map. */ void addMemoryRemap(std::string const& mapName, std::string const& newRemapName = std::string("")); /*! * Remove the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeMap(std::string const& mapName); /*! * Remove the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the selected memory remap. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeRemap(std::string const& mapName, std::string remapName); /*! * Copy the selected items. * - * @param [in] selectedRows Indexes of the selected items. + * @param [in] selectedRows Indexes of the selected items. */ void copyRows(std::vector const& selectedRows); /*! * Paste the selected memory maps. * - * @return Names of the pasted items. + * @return Names of the pasted items. */ std::vector pasteMemoryMaps(); /*! * Paste the selected memory remaps. * - * @param [in] memoryMapName Name of the memory map containing the pasted memory remaps. + * @param [in] memoryMapName Name of the memory map containing the pasted memory remaps. * - * @return Names of the pasted items. + * @return Names of the pasted items. */ std::vector pasteMemoryRemaps(std::string const& memoryMapName); /*! * Get the address block interface. * - * @return Interface for accessing address blocks. + * @return Interface for accessing address blocks. */ AddressBlockInterface* getAddressBlockInterface() const; /*! * Get the subspace map interface. * - * @return Interface for accessing subspace maps. + * @return Interface for accessing subspace maps. */ SubspaceMapInterface* getSubspaceMapInterface() const; /*! * Get a pointer to the selected memory map (for index construction). * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return Pointer to the selected memory map. + * @return Pointer to the selected memory map. */ MemoryMap* getMapPointer(std::string const& mapName) const; /*! * Get a pointer to the selected memory remap (for index construction). * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the selected memory remap. * - * @return Pointer to the selected memory remap. + * @return Pointer to the selected memory remap. */ MemoryRemap* getRemapPointer(std::string const& mapName, std::string const& remapName) const; /*! * Get the number of mode references for a selected remap. * - * @param [in] mapName Memory map containing the remap. - * @param [in] remapName The name of the remap. + * @param [in] mapName Memory map containing the remap. + * @param [in] remapName The name of the remap. * * @return The number of mode references within the remap. */ @@ -497,8 +497,8 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the mode references of a selected remap. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap. * * @return The mode references of selected remap. */ @@ -508,8 +508,8 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N * Get string to display in mode references editor, depending on if remap has no mode references, * one mode reference or multiple mode references. Returns an empty string if remap is not found. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap. * * @return Empty string if remap is not found, or "None", "" or "[multiple]" * depending on mode references of the remap. @@ -519,9 +519,9 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Set the mode references of given remap. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap whose mode references are set. - * @param [in] newModeRefs The mode references to set. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap whose mode references are set. + * @param [in] newModeRefs The mode references to set. * * @return True, if the operation was successful, otherwise false. */ @@ -530,8 +530,8 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Add a new mode reference to a selected remap. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap to add a mode reference to. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap to add a mode reference to. * * @return True, if the operation was successful, otherwise false. */ @@ -540,9 +540,9 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Remove a selected mode reference of a given remap. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap to remove a mode reference of. - * @param [in] modeReferenceIndex The index of the mode reference to be removed. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap to remove a mode reference of. + * @param [in] modeReferenceIndex The index of the mode reference to be removed. * * @return True, if the operation was successful, otherwise false. */ @@ -558,7 +558,7 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Set the mode reference interface used for accessing remap mode references. * - * @param [in] modeRefInterface Description + * @param [in] modeRefInterface Description */ void setModeReferenceInterface(ModeReferenceInterface* modeRefInterface); @@ -566,8 +566,8 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N * Get the mode references of all remaps in memory map (excluding selected remap) as a list of priority, * reference pairs. * - * @param [in] mapName The containing memory map. - * @param [in] remapName The name of the remap to exclude from the mode ref list. + * @param [in] mapName The containing memory map. + * @param [in] remapName The name of the remap to exclude from the mode ref list. * * @return The mode references of remaps in memory map, excluding selected remap. */ @@ -579,58 +579,58 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Get the selected memory map. * - * @param [in] itemName Name of the selected memory map. + * @param [in] itemName Name of the selected memory map. * - * @return The selected memory map. + * @return The selected memory map. */ QSharedPointer getMemoryMap(std::string const& itemName) const; /*! * Get the memory map with the selected name, sliced to a NameGroup. * - * @param [in] itemName Name of the selected memory map. + * @param [in] itemName Name of the selected memory map. * - * @return The sliced memory map with the selected name. + * @return The sliced memory map with the selected name. */ QSharedPointer getItem(std::string const& itemName) const override; /*! * Get the selected memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] itemName Name of the selected memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] itemName Name of the selected memory remap. * - * @return The selected memory remap. + * @return The selected memory remap. */ QSharedPointer getMemoryRemap(std::string const& mapName, std::string const& itemName) const; /*! * Paste a single memory map. * - * @param [in] mapCopy The selected memory map to copy. + * @param [in] mapCopy The selected memory map to copy. * - * @return Name of the pasted memory map. + * @return Name of the pasted memory map. */ QString pasteMemoryMap(QSharedPointer mapCopy); /*! * Paste a single memory remap. * - * @param [in] remapCopy The selected memory remap to copy. - * @param [in] parentMapName Name of the memory map containing the copied memory remap. + * @param [in] remapCopy The selected memory remap to copy. + * @param [in] parentMapName Name of the memory map containing the copied memory remap. * - * @return Name of the pasted memory remap. + * @return Name of the pasted memory remap. */ QString pasteMemoryRemap(QSharedPointer remapCopy, std::string const& parentMapName); /*! * Transform the selected name to a unique memory remap name. * - * @param [in] mapName Name of the memory map containing the memory remaps. - * @param [in] newName The selected name. - * @param [in] itemTypeName The type of the item. + * @param [in] mapName Name of the memory map containing the memory remaps. + * @param [in] newName The selected name. + * @param [in] itemTypeName The type of the item. * - * @return A unique name derived from the selected name. + * @return A unique name derived from the selected name. */ QString getUniqueRemapName(std::string const& mapName, std::string const& newName, std::string const& itemTypeName) const; @@ -638,10 +638,10 @@ class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public N /*! * Check if the selected memory remap name is unique. * - * @param [in] mapName Name of the memory map containing the memory remaps. - * @param [in] remapName The selected memory remap name. + * @param [in] mapName Name of the memory map containing the memory remaps. + * @param [in] remapName The selected memory remap name. * - * @return True, if the selected name is unique, false otherwise. + * @return True, if the selected name is unique, false otherwise. */ bool remapNameIsUnique(std::string const& mapName, QString const& remapName) const; diff --git a/KactusAPI/include/MemoryRemapExpressionGatherer.h b/KactusAPI/include/MemoryRemapExpressionGatherer.h index cdef0e2e8..a7a64b872 100644 --- a/KactusAPI/include/MemoryRemapExpressionGatherer.h +++ b/KactusAPI/include/MemoryRemapExpressionGatherer.h @@ -39,9 +39,9 @@ class KACTUS2_API MemoryRemapExpressionGatherer /*! * Get the expressions from a given memory remap. * - * @param [in] memoryRemap The given memory remap. + * @param [in] memoryRemap The given memory remap. * - * @return A list containing all the expressions used in a memory remap + * @return A list containing all the expressions used in a memory remap */ QStringList getExpressions(QSharedPointer memoryRemap) const; diff --git a/KactusAPI/include/ModeConditionParser.h b/KactusAPI/include/ModeConditionParser.h index 15a7d732c..e0a1ee60d 100644 --- a/KactusAPI/include/ModeConditionParser.h +++ b/KactusAPI/include/ModeConditionParser.h @@ -46,21 +46,21 @@ class KACTUS2_API ModeConditionParser : public IPXactSystemVerilogParser /*! * Set the mode-specific field slices to use while parsing expressions. * - * @param [in] fieldSlices The field slices to set. + * @param [in] fieldSlices The field slices to set. */ void setFieldSlices(FieldSlice::List fieldSlices); /*! * Set the mode-specific port slices to use while parsing expressions. * - * @param [in] portSlices The port slices to set. + * @param [in] portSlices The port slices to set. */ void setPortSlices(PortSlice::List portSlices); /*! * Set the available modes to use while parsing expressions. * - * @param [in] modes The modes to set. + * @param [in] modes The modes to set. */ void setModes(Mode::List modes); @@ -69,37 +69,37 @@ class KACTUS2_API ModeConditionParser : public IPXactSystemVerilogParser /*! * Checks if the given expression is a symbol e.g. reference. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a symbol, otherwise false. + * @return True, if the expression is a symbol, otherwise false. */ bool isSymbol(QStringView expression) const final; /*! * Finds the value for given symbol. * - * @param [in] symbol The symbol whose value to find. + * @param [in] symbol The symbol whose value to find. * - * @return The found symbol value. + * @return The found symbol value. */ QString findSymbolValue(QStringView symbol) const override; /*! * Checks if the given token is a unary operator. * - * @param [in] expression The token to check. + * @param [in] expression The token to check. * - * @return True, if the token is a unary operator, otherwise false. + * @return True, if the token is a unary operator, otherwise false. */ bool isUnaryOperator(QStringView token) const final; /*! * Solves a binary operation. * - * @param [in] operation The operation to solve. - * @param [in] term The term for the operation. + * @param [in] operation The operation to solve. + * @param [in] term The term for the operation. * - * @return The result of the operation. + * @return The result of the operation. */ QString solveUnary(QStringView operation, QString const& term) const final; @@ -108,9 +108,9 @@ class KACTUS2_API ModeConditionParser : public IPXactSystemVerilogParser /*! * Check if the given expression is a valid reference within a mode. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a valid reference, otherwise false. + * @return True, if the expression is a valid reference, otherwise false. */ bool isModeReference(QStringView expression) const; @@ -118,10 +118,10 @@ class KACTUS2_API ModeConditionParser : public IPXactSystemVerilogParser /*! * Solve condition to a value. * - * @param [in] reference The reference to solve. - * @param [in] availableItems The available items to reference. + * @param [in] reference The reference to solve. + * @param [in] availableItems The available items to reference. * - * @return 1, if the reference is to a valid item, otherwise x. + * @return 1, if the reference is to a valid item, otherwise x. */ template QString solveCondition(QStringView reference, QSharedPointer > > availableItems) const diff --git a/KactusAPI/include/ModeConditionParserInterface.h b/KactusAPI/include/ModeConditionParserInterface.h index 9c16c7a88..f9375ba0b 100644 --- a/KactusAPI/include/ModeConditionParserInterface.h +++ b/KactusAPI/include/ModeConditionParserInterface.h @@ -37,24 +37,24 @@ class ModeConditionParserBaseInterface : public ExpressionParserInterface /*! * Set the field slices of the selected mode condition parser. * - * @param [in] expressionParser The mode condition parser to set the field slices to. - * @param [in] fieldSlices The field slices to set. + * @param [in] expressionParser The mode condition parser to set the field slices to. + * @param [in] fieldSlices The field slices to set. */ virtual void setFieldSlices(QSharedPointer expressionParser, FieldSlice::List fieldSlices) = 0; /*! * Set the port slices of the selected mode condition parser. * - * @param [in] expressionParser The mode condition parser to set the port slices to. - * @param [in] portSlices The port slices to set. + * @param [in] expressionParser The mode condition parser to set the port slices to. + * @param [in] portSlices The port slices to set. */ virtual void setPortSlices(QSharedPointer expressionParser, PortSlice::List portSlices) = 0; /*! * Set the available modes to the selected mode condition parser. * - * @param [in] expressionParser The mode condition parser to update. - * @param [in] modes The modes to set. + * @param [in] expressionParser The mode condition parser to update. + * @param [in] modes The modes to set. */ virtual void setModes(QSharedPointer expressionParser, Mode::List modes) = 0; }; @@ -78,24 +78,24 @@ class KACTUS2_API ModeConditionParserInterface : public ModeConditionParserBaseI /*! * Set the mode-specific field slices to use while parsing expressions. * - * @param [in] expressionParser The parser whose field slices to set. - * @param [in] fieldSlices The field slices to set. + * @param [in] expressionParser The parser whose field slices to set. + * @param [in] fieldSlices The field slices to set. */ void setFieldSlices(QSharedPointer expressionParser, FieldSlice::List fieldSlices) final; /*! * Set the mode-specific port slices to use while parsing expressions. * - * @param [in] expressionParser The parser whose port slices to set. - * @param [in] portSlices The port slices to set. + * @param [in] expressionParser The parser whose port slices to set. + * @param [in] portSlices The port slices to set. */ void setPortSlices(QSharedPointer expressionParser, PortSlice::List portSlices) final; /*! * Set the available modes to use while parsing expressions. * - * @param [in] expressionParser The parser whose modes to set. - * @param [in] modes The modes to set. + * @param [in] expressionParser The parser whose modes to set. + * @param [in] modes The modes to set. */ void setModes(QSharedPointer expressionParser, Mode::List modes) final; diff --git a/KactusAPI/include/ModeReferenceInterface.h b/KactusAPI/include/ModeReferenceInterface.h index 386eb837b..959feb423 100644 --- a/KactusAPI/include/ModeReferenceInterface.h +++ b/KactusAPI/include/ModeReferenceInterface.h @@ -32,7 +32,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Set the available mode references. * - * @param [in] modeReferences The mode references to set. + * @param [in] modeReferences The mode references to set. */ void setModeReferences(std::vector > const& modeReferences); @@ -46,7 +46,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Get the mode reference value for a selected mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference whose reference value to get. + * @param [in] modeReferenceIndex The index of the mode reference whose reference value to get. * * @return The mode reference value. */ @@ -55,7 +55,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Get the mode reference priority for a selected mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference whose priority to get. + * @param [in] modeReferenceIndex The index of the mode reference whose priority to get. * * @return The mode reference priority. */ @@ -64,8 +64,8 @@ class KACTUS2_API ModeReferenceInterface /*! * Set the mode reference value for a selected mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference whose reference value to set. - * @param [in] newValue The new reference to set. + * @param [in] modeReferenceIndex The index of the mode reference whose reference value to set. + * @param [in] newValue The new reference to set. * * @return True, if the operation was successful, otherwise false. */ @@ -74,8 +74,8 @@ class KACTUS2_API ModeReferenceInterface /*! * Set the mode reference priority for a selected mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference whose reference priority to set. - * @param [in] newPriority The new priority value to set. + * @param [in] modeReferenceIndex The index of the mode reference whose reference priority to set. + * @param [in] newPriority The new priority value to set. * * @return True, if the operation was successful, otherwise false. */ @@ -91,7 +91,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Remove a selected mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference to be removed. + * @param [in] modeReferenceIndex The index of the mode reference to be removed. * * @return True, if the operation was successful, otherwise false. */ @@ -100,7 +100,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Validate the reference value of given mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference to validate. + * @param [in] modeReferenceIndex The index of the mode reference to validate. * * @return True, if the mode reference value is valid, otherwise false. */ @@ -109,7 +109,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Validate the priority value of given mode reference. * - * @param [in] modeReferenceIndex The index of the mode reference to validate. + * @param [in] modeReferenceIndex The index of the mode reference to validate. * * @return True, if the mode reference priority is valid, otherwise false. */ @@ -125,7 +125,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Set to indicate that the current element is a memory remap. * - * @param [in] isRemap Flag to set, if element is remap. + * @param [in] isRemap Flag to set, if element is remap. */ void setContainingElementIsRemap(bool isRemap); @@ -133,7 +133,7 @@ class KACTUS2_API ModeReferenceInterface * Set mode references in the containing element, eg. mode references of all remaps within a memory map. * Should set all mode references except for the mode refs of access policy/remap currently being edited. * - * @param [in] modeRefs The mode references to set. + * @param [in] modeRefs The mode references to set. */ void setContainingElementModeReferences(std::vector > const& modeReferences); @@ -147,7 +147,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Set the available component modes. * - * @param [in] newModes The modes to set. + * @param [in] newModes The modes to set. */ void setComponentModes(QSharedPointer > > newModes); @@ -170,7 +170,7 @@ class KACTUS2_API ModeReferenceInterface /*! * Get the mode references that are currently in use, except for the mode reference being validated. * - * @param [in] modeReferenceIndex The index of the mode references to validate. + * @param [in] modeReferenceIndex The index of the mode references to validate. * * @return The mode references currently in use by other elements. */ diff --git a/KactusAPI/include/ModelParameterSource.h b/KactusAPI/include/ModelParameterSource.h index deaa69fef..67c5bf252 100644 --- a/KactusAPI/include/ModelParameterSource.h +++ b/KactusAPI/include/ModelParameterSource.h @@ -27,7 +27,7 @@ class ModelParameterSource /*! * Sets the given visualizer to be used by the source. * - * @param [in] visualizer The visualizer to use. + * @param [in] visualizer The visualizer to use. */ virtual void setModelParameterVisualizer(ModelParameterVisualizer* visualizer) = 0; diff --git a/KactusAPI/include/ModelParameterVisualizer.h b/KactusAPI/include/ModelParameterVisualizer.h index 2ff728ea4..4bfb37519 100644 --- a/KactusAPI/include/ModelParameterVisualizer.h +++ b/KactusAPI/include/ModelParameterVisualizer.h @@ -29,7 +29,7 @@ class ModelParameterVisualizer /*! * Called to receive future notifications of model parameter changes in the visualization. * - * @param [in] listener The the listener to receive notifications in. + * @param [in] listener The the listener to receive notifications in. */ virtual void registerChangeListener(QObject const* listener) = 0; }; diff --git a/KactusAPI/include/ModuleParameterInterface.h b/KactusAPI/include/ModuleParameterInterface.h index 0fc45a549..ec14f4066 100644 --- a/KactusAPI/include/ModuleParameterInterface.h +++ b/KactusAPI/include/ModuleParameterInterface.h @@ -30,10 +30,10 @@ class KACTUS2_API ModuleParameterInterface : public AbstractParameterInterface /*! * The constructor. * - * @param [ni] validator Validator for parameters. - * @param [ni] expressionParser Parser for expressions. - * @param [ni] expressionFormatter Formatter for expressions. - * @param [ni] parameterFinder Parameter finder for component instantiation parameters. + * @param [ni] validator Validator for parameters. + * @param [ni] expressionParser Parser for expressions. + * @param [ni] expressionFormatter Formatter for expressions. + * @param [ni] parameterFinder Parameter finder for component instantiation parameters. */ ModuleParameterInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -48,94 +48,94 @@ class KACTUS2_API ModuleParameterInterface : public AbstractParameterInterface /*! * Set available module parameters. * - * @param [in] instantiation Component instantiation containing the new module parameters. + * @param [in] instantiation Component instantiation containing the new module parameters. */ void setModuleParameters(QSharedPointer instantiation); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const override; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override; /*! * Get the data type of the selected module parameter. * - * @param [in] parameterName Name of the selected module parameter. + * @param [in] parameterName Name of the selected module parameter. * - * @return Data type of the selected module parameter. + * @return Data type of the selected module parameter. */ std::string getDataType(std::string const& parameterName) const; /*! * Set a new data type for the selected module parameter. * - * @param [in] parameterName Name of the selected module parameter. - * @param [in] newDataType New data type. + * @param [in] parameterName Name of the selected module parameter. + * @param [in] newDataType New data type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDataType(std::string const& parameterName, std::string const& newDataType); /*! * Get the usage type of the selected module parameter. * - * @param [in] parameterName Name of the selected module parameter. + * @param [in] parameterName Name of the selected module parameter. * - * @return Usage type of the selected module parameter. + * @return Usage type of the selected module parameter. */ std::string getUsageType(std::string const& parameterName) const; /*! * Set a new usage type for the selected module parameter. * - * @param [in] parameterName Name of the selected module parameter. - * @param [in] newUsageType New usage type. + * @param [in] parameterName Name of the selected module parameter. + * @param [in] newUsageType New usage type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setUsageType(std::string const& parameterName, std::string const& newUsageType); /*! * Add a new module parameter. * - * @param [in] row Index of the new parameter. - * @param [in] newParameterName New of the new parameter. + * @param [in] row Index of the new parameter. + * @param [in] newParameterName New of the new parameter. */ void addModuleParameter(int const& row, std::string const& newParameterName = std::string("")); /*! * Remove the selected module parameter. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeModuleParameter(std::string const& parameterName); @@ -149,27 +149,27 @@ class KACTUS2_API ModuleParameterInterface : public AbstractParameterInterface /*! * Get the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return The selected parameter. + * @return The selected parameter. */ virtual QSharedPointer getParameter(std::string const& parameterName) const override final; /*! * Get the parameter with the selected name, sliced to a NameGroup. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return The sliced parameter with the selected name. + * @return The sliced parameter with the selected name. */ QSharedPointer getItem(std::string const& parameterName) const override; /*! * Get the selected module parameter. * - * @param [in] parameterName Name of the selected module parameter. + * @param [in] parameterName Name of the selected module parameter. * - * @return The selected module parameter. + * @return The selected module parameter. */ QSharedPointer getModuleParameter(std::string const& parameterName) const; diff --git a/KactusAPI/include/MultipleParameterFinder.h b/KactusAPI/include/MultipleParameterFinder.h index caa8ada15..0e97e3895 100644 --- a/KactusAPI/include/MultipleParameterFinder.h +++ b/KactusAPI/include/MultipleParameterFinder.h @@ -29,7 +29,7 @@ class KACTUS2_API MultipleParameterFinder : public ParameterFinder /*! * Constructor. * - * @param [in] component The component which parameters are being searched for. + * @param [in] component The component which parameters are being searched for. */ MultipleParameterFinder(); @@ -47,14 +47,14 @@ class KACTUS2_API MultipleParameterFinder : public ParameterFinder /*! * Adds a finder to be used in searches. * - * @param [in] finder The finder to add. + * @param [in] finder The finder to add. */ void addFinder(QSharedPointer finder); /*! * Removes a finder from searches. * - * @param [in] finder The finder to remove. + * @param [in] finder The finder to remove. */ void removeFinder(QSharedPointer finder); @@ -66,55 +66,55 @@ class KACTUS2_API MultipleParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const final; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the component. * - * @return The number of parameters in the component. + * @return The number of parameters in the component. */ int getNumberOfParameters() const noexcept final; /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; diff --git a/KactusAPI/include/NameGroupInterface.h b/KactusAPI/include/NameGroupInterface.h index 9edbe1676..406f9b1ed 100644 --- a/KactusAPI/include/NameGroupInterface.h +++ b/KactusAPI/include/NameGroupInterface.h @@ -40,35 +40,35 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const = 0; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ virtual std::string getIndexedItemName(int itemIndex) const = 0; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) = 0; /*! * Get the display name of the selected item. * - * @param [in] itemName The name of the item whose display name to get. + * @param [in] itemName The name of the item whose display name to get. * * @return The item display name. */ @@ -77,8 +77,8 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Set the display name of the selected item. * - * @param [in] itemName Description - * @param [in] newDisplayName Description + * @param [in] itemName Description + * @param [in] newDisplayName Description * * @return True, if display name was set successfully, otherwise false. */ @@ -87,26 +87,26 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Get the description of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Description of the selected item. + * @return Description of the selected item. */ virtual std::string getDescription(std::string const& itemName) const; /*! * Set a new description for the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] newDescription New description. + * @param [in] itemName Name of the selected item. + * @param [in] newDescription New description. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setDescription(std::string const& itemName, std::string const& newDescription); /*! * Get the short description of an item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * * @return Short description of the selected item. */ @@ -115,8 +115,8 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Set a new short description for the selected item. * - * @param [in] itemName Description - * @param [in] newShortDescription Description + * @param [in] itemName Description + * @param [in] newShortDescription Description * * @return True, if successful, otherwise false. */ @@ -125,9 +125,9 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const = 0; @@ -140,9 +140,9 @@ class KACTUS2_API NameGroupInterface : public CommonInterface /*! * Get the item with the selected name, sliced to a NameGroup. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return The sliced item with the selected name. + * @return The sliced item with the selected name. */ virtual QSharedPointer getItem(std::string const& itemName) const = 0; }; diff --git a/KactusAPI/include/NullParser.h b/KactusAPI/include/NullParser.h index c1745ecb9..766f4da1c 100644 --- a/KactusAPI/include/NullParser.h +++ b/KactusAPI/include/NullParser.h @@ -36,27 +36,27 @@ class KACTUS2_API NullParser : public ExpressionParser /*! * Parses an expression to decimal number. * - * @param [in] expression The expression to parse. + * @param [in] expression The expression to parse. * - * @return The decimal value of the constant. + * @return The decimal value of the constant. */ QString parseExpression(QStringView expression, bool* isValidExpression) const final; /*! * Checks if the given expression is a plain value and does not need evaluation. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a plain value, otherwise false. + * @return True, if the expression is a plain value, otherwise false. */ bool isPlainValue(QStringView expression) const final; /*! * Finds the common base in the expression. * - * @param [in] expression The expression to search in. + * @param [in] expression The expression to search in. * - * @return The common base for the expression. + * @return The common base for the expression. */ int baseForExpression(QStringView expression) const final; diff --git a/KactusAPI/include/ParameterCache.h b/KactusAPI/include/ParameterCache.h index 70c9a9012..d043d546e 100644 --- a/KactusAPI/include/ParameterCache.h +++ b/KactusAPI/include/ParameterCache.h @@ -34,7 +34,7 @@ class KACTUS2_API ParameterCache : public QObject, public ComponentParameterFind /*! * Constructor. * - * @param [in] component The component which parameters are being searched for. + * @param [in] component The component which parameters are being searched for. */ ParameterCache(QSharedPointer component); @@ -51,44 +51,44 @@ class KACTUS2_API ParameterCache : public QObject, public ComponentParameterFind /*! * Get the parameter corresponding the id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the component. * - * @return The number of parameters in the component. + * @return The number of parameters in the component. */ int getNumberOfParameters() const final; /*! * Set a new component for the parameter finder. * - * @param [in] component The new component. + * @param [in] component The new component. */ void setComponent(QSharedPointer component) final; /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; diff --git a/KactusAPI/include/ParameterFinder.h b/KactusAPI/include/ParameterFinder.h index 06aecf9db..379ff0658 100644 --- a/KactusAPI/include/ParameterFinder.h +++ b/KactusAPI/include/ParameterFinder.h @@ -33,55 +33,55 @@ class ParameterFinder /*! * Get the parameter corresponding the id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ virtual QSharedPointer getParameterWithID(QStringView parameterId) const = 0; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ virtual bool hasId(QStringView id) const = 0; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter + * @return The name of the parameter */ virtual QString nameForId(QStringView id) const = 0; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter + * @return The value of the parameter */ virtual QString valueForId(QStringView id) const = 0; /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids of parameters. + * @return A list containing all of the ids of parameters. */ virtual QStringList getAllParameterIds() const = 0; /*! * Gets the number of parameters in the component. * - * @return The number of parameters. + * @return The number of parameters. */ virtual int getNumberOfParameters() const = 0; /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ virtual void registerParameterModel(QAbstractItemModel const* model) = 0; diff --git a/KactusAPI/include/ParameterizableInterface.h b/KactusAPI/include/ParameterizableInterface.h index 4899a1b87..4004deb89 100644 --- a/KactusAPI/include/ParameterizableInterface.h +++ b/KactusAPI/include/ParameterizableInterface.h @@ -30,8 +30,8 @@ class KACTUS2_API ParameterizableInterface /*! * The constructor. * - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ ParameterizableInterface(QSharedPointer expressionParser, QSharedPointer expressionFormatter); @@ -44,10 +44,10 @@ class KACTUS2_API ParameterizableInterface /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const = 0; @@ -60,28 +60,28 @@ class KACTUS2_API ParameterizableInterface /*! * Get the formatted value for the given expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. * - * @return The formatted expression. + * @return The formatted expression. */ QString formattedValueFor(QString const& expression) const; /*! * Parse the selected expression to decimal. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. * - * @return The value of the expression in decimal form. + * @return The value of the expression in decimal form. */ QString parseExpressionToDecimal(QString const& expression, bool* expressionIsValid = nullptr) const; /*! * Parse the selected expression to the selected base number. * - * @param [in] expression The selected expression. - * @param [in] baseNumber The selected base number. + * @param [in] expression The selected expression. + * @param [in] baseNumber The selected base number. * - * @return The value of the expression in the base number form. + * @return The value of the expression in the base number form. */ QString parseExpressionToBaseNumber(QString const& expression, unsigned int baseNumber, bool* expressionIsValid = nullptr) const; diff --git a/KactusAPI/include/ParametersInterface.h b/KactusAPI/include/ParametersInterface.h index 70d11f22f..d51bbce3e 100644 --- a/KactusAPI/include/ParametersInterface.h +++ b/KactusAPI/include/ParametersInterface.h @@ -28,9 +28,9 @@ class KACTUS2_API ParametersInterface : public AbstractParameterInterface /*! * The constructor. * - * @param [in] validator Validator for parameters. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] validator Validator for parameters. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ ParametersInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -44,56 +44,56 @@ class KACTUS2_API ParametersInterface : public AbstractParameterInterface /*! * Set available parameters. * - * @param [in] newParameters The new parameters. + * @param [in] newParameters The new parameters. */ void setParameters(QSharedPointer > > newParameters); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Add a new parameter. * - * @param [in] row Index of the new parameter. - * @param [in] newParameterName New of the new parameter. + * @param [in] row Index of the new parameter. + * @param [in] newParameterName New of the new parameter. */ void addParameter(int const& row, std::string const& newParameterName = std::string("")); /*! * Remove the selected parameter. * - * @param [in] parameterName New of the selected parameter. + * @param [in] parameterName New of the selected parameter. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeParameter(std::string const& parameterName); @@ -107,18 +107,18 @@ class KACTUS2_API ParametersInterface : public AbstractParameterInterface /*! * Get the selected parameter. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return The selected parameter. + * @return The selected parameter. */ QSharedPointer getParameter(std::string const& parameterName) const final; /*! * Get the parameter with the selected name, sliced to a NameGroup. * - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterName Name of the selected parameter. * - * @return The sliced parameter with the selected name. + * @return The sliced parameter with the selected name. */ QSharedPointer getItem(std::string const& parameterName) const override; diff --git a/KactusAPI/include/PluginManager.h b/KactusAPI/include/PluginManager.h index a7e8708e0..855442ab8 100755 --- a/KactusAPI/include/PluginManager.h +++ b/KactusAPI/include/PluginManager.h @@ -33,7 +33,7 @@ class KACTUS2_API PluginManager /*! * Adds the given plugin to the available plugins. * - * @param [in] plugin The plugin to add + * @param [in] plugin The plugin to add */ void addPlugin(IPlugin* plugin); @@ -50,23 +50,23 @@ class KACTUS2_API PluginManager /*! * Loads the plugins from given paths. * - * @param [in] pluginPaths The paths containing the plugins. + * @param [in] pluginPaths The paths containing the plugins. */ void setPluginPaths(QStringList const& pluginPaths); /*! * Find all plugins in the given paths. * - * @param [in] pluginPaths Paths to directories to search for plugins. + * @param [in] pluginPaths Paths to directories to search for plugins. * - * @return All plugins found in the given directories. + * @return All plugins found in the given directories. */ static QList findPluginsInPaths(QStringList const& pluginPaths); /*! * Get the singleton instance of the PluginManager. * - * @return The PluginManager instance. + * @return The PluginManager instance. */ static PluginManager& getInstance(); diff --git a/KactusAPI/include/PluginSettingsModel.h b/KactusAPI/include/PluginSettingsModel.h index 91e27212b..2739380a0 100644 --- a/KactusAPI/include/PluginSettingsModel.h +++ b/KactusAPI/include/PluginSettingsModel.h @@ -33,14 +33,14 @@ class PluginSettingsModel /*! * Loads plugin settings from the given settings store. Is called when Kactus2 loads the plugin. * - * @param [in] settings The settings store. + * @param [in] settings The settings store. */ virtual void loadSettings(QSettings& /*settings*/) {/* By default, do nothing. */} /*! * Saves plugin settings to the given settings store. Is called when Kactus2 applies changes to settings. * - * @param [in,out] settings The settings store. + * @param [in,out] settings The settings store. */ virtual void saveSettings(QSettings& /*settings*/) {/* By default, do nothing. */ } diff --git a/KactusAPI/include/PluginUtilityAdapter.h b/KactusAPI/include/PluginUtilityAdapter.h index ac041f064..fabea8ef2 100644 --- a/KactusAPI/include/PluginUtilityAdapter.h +++ b/KactusAPI/include/PluginUtilityAdapter.h @@ -30,11 +30,11 @@ class PluginUtilityAdapter : public IPluginUtility /*! * The constructor. * - * @param [in] libraryInterface The available library of IP-XACT objects. - * @param [in] messageChannel The channel for displaying messages to the user. - * @param [in] versionString The current version of the Kactus2 build. - * @param [in] parentWidget The parent widget. - * @param [in] parent The parent object. + * @param [in] libraryInterface The available library of IP-XACT objects. + * @param [in] messageChannel The channel for displaying messages to the user. + * @param [in] versionString The current version of the Kactus2 build. + * @param [in] parentWidget The parent widget. + * @param [in] parent The parent object. */ PluginUtilityAdapter(LibraryInterface* libraryInterface, MessageMediator* messageChannel, QString const& versionString, QWidget* parentWidget = 0); @@ -62,7 +62,7 @@ class PluginUtilityAdapter : public IPluginUtility /*! * Prints an error message to the console window. * - * @param [in] message The error message to print. + * @param [in] message The error message to print. * * @remark Requires signal errorMessage to be connected by the user. */ @@ -71,7 +71,7 @@ class PluginUtilityAdapter : public IPluginUtility /*! * Prints an info message to the console window. * - * @param [in] message The info message to print. + * @param [in] message The info message to print. * * @remark Requires signal infoMessage to be connected by the user. */ diff --git a/KactusAPI/include/PortAbstractionInterface.h b/KactusAPI/include/PortAbstractionInterface.h index bafbad8cd..007f1ab82 100644 --- a/KactusAPI/include/PortAbstractionInterface.h +++ b/KactusAPI/include/PortAbstractionInterface.h @@ -44,8 +44,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * The constructor. * - * @param [in] expressionParser The expression parser to use. - * @param [in] expressionFormatter The expression formatter to use. + * @param [in] expressionParser The expression parser to use. + * @param [in] expressionFormatter The expression formatter to use. */ PortAbstractionInterface(QSharedPointer expressionParser, QSharedPointer expressionFormatter); @@ -58,33 +58,33 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Setup the port abstractions. * - * @param [in] absDef Abstraction definition containing the port abstractions. + * @param [in] absDef Abstraction definition containing the port abstractions. */ void setAbsDef(QSharedPointer absDef); /*! * Set the validator to use. * - * @param [in] validator The validator to use. + * @param [in] validator The validator to use. */ void setPortAbstractionValidator(QSharedPointer validator); /*! * Get index of the first signal containing the selected port abstraction. * - * @param [in] itemName Name of the selected port abstraction. + * @param [in] itemName Name of the selected port abstraction. * - * @return Index of the selected signal. + * @return Index of the selected signal. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get index of the signal containing the selected port abstraction with the given mode. * - * @param [in] itemName Name of the selected port abstraction. - * @param [in] mode Mode of the selected port abstraction. + * @param [in] itemName Name of the selected port abstraction. + * @param [in] mode Mode of the selected port abstraction. * - * @return Index of the selected signal. + * @return Index of the selected signal. */ virtual int getItemIndex(std::string const& itemName, General::InterfaceMode mode, std::string const& systemGroup = std::string()) const; @@ -92,35 +92,35 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get name of the indexed port. * - * @param [in] itemIndex Index of the selected port. + * @param [in] itemIndex Index of the selected port. * - * @return Name of the selected port. + * @return Name of the selected port. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available port abstractions. * - * @return Number of available port abstractions. + * @return Number of available port abstractions. */ virtual int itemCount() const override final; /*! * Get the number of available signals in the selected port abstraction. * - * @param [in] portName Name of the selected port abstraction. + * @param [in] portName Name of the selected port abstraction. * - * @return Number of available signals in the selected port abstraction. + * @return Number of available signals in the selected port abstraction. */ int signalCount(std::string const& portName) const; /*! * Check if the selected port abstraction has multiples of the selected interface mode. * - * @param [in] portName Name of the selected port abstraction. - * @param [in] mode The selected interface mode. + * @param [in] portName Name of the selected port abstraction. + * @param [in] mode The selected interface mode. * - * @return True, if the selected port abstraction has multiples of the selected mode, false if the + * @return True, if the selected port abstraction has multiples of the selected mode, false if the * selected port abstraction has only a single signal of the selected mode or the interface * mode is system. */ @@ -129,33 +129,33 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a new name for the selected port abstraction. * - * @param [in] currentName Name of the selected port abstraction. - * @param [in] newName New name for the port abstraction. + * @param [in] currentName Name of the selected port abstraction. + * @param [in] newName New name for the port abstraction. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setName(std::string const& currentName, std::string const& newName) final; /*! * Validates the contained port abstractions. * - * @return True, if all the port abstractions are valid, false otherwise. + * @return True, if all the port abstractions are valid, false otherwise. */ bool validateItems() const final; /*! * Check if the selected port abstraction has a valid name. * - * @param [in] portName Name of the selected port abstraction. + * @param [in] portName Name of the selected port abstraction. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ bool itemHasValidName(std::string const& itemName) const final; /*! * Check if the width of the wire port is valid. * - * @param [in] portIndex The index of the selected signal. + * @param [in] portIndex The index of the selected signal. * * @return True, if the widht is valid, otherwise false. */ @@ -164,7 +164,7 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Check if the default value of the wire port is valid. * - * @param [in] portIndex The index of the selected signal. + * @param [in] portIndex The index of the selected signal. * * @return True, if the default value is valid, otherwise false. */ @@ -173,7 +173,7 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the match status of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * * @return True, if signal port has match, otherwise false. */ @@ -182,8 +182,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set the match status of the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] match Match flag to set. + * @param [in] portIndex Index of the selected signal. + * @param [in] match Match flag to set. * * @return True, if match could be set, otherwise false. */ @@ -192,17 +192,17 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the names of the available port abstractions. * - * @return Names of the available ports abstractions. + * @return Names of the available ports abstractions. */ std::vector getItemNames() const final; /*! * Get the list of logical ports with the selected bus interface mode and system group. * - * @param [in] busModeString The selected bus interface mode in string form. - * @param [in] systemGroup The selected system group. + * @param [in] busModeString The selected bus interface mode in string form. + * @param [in] systemGroup The selected system group. * - * @return A list of logical ports names. + * @return A list of logical ports names. */ std::vector getItemNamesWithModeAndGroup(std::string const& busModeString, std::string systemGroup) const; @@ -210,94 +210,94 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the interface mode of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Interface mode of the selected signal. + * @return Interface mode of the selected signal. */ General::InterfaceMode getMode(int const& portIndex) const; /*! * Get the interface mode of the selected signal in string form. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Interface mode string of the selected signal. + * @return Interface mode string of the selected signal. */ std::string getModeString(int const& portIndex) const; /*! * Set the interface mode for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newMode The new interface mode. + * @param [in] portIndex Index of the selected signal. + * @param [in] newMode The new interface mode. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMode(int const& portIndex, std::string const& newMode); /*! * Get the system group of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return System group of the selected signal. + * @return System group of the selected signal. */ std::string getSystemGroup(int const& portIndex) const; /*! * Get the system groups of the selected port abstraction. * - * @param [in] portName Name of the selected port abstraction. + * @param [in] portName Name of the selected port abstraction. * - * @return System groups of the selected port abstraction. + * @return System groups of the selected port abstraction. */ std::vector getSystemGroupsForPort(std::string const& portName) const; /*! * Set the system group for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newSystem The new system group. + * @param [in] portIndex Index of the selected signal. + * @param [in] newSystem The new system group. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setSystemGroup(int const& portIndex, std::string const& newSystem); /*! * Get the list of qualifiers of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return List of qualifiers of the selected signal. + * @return List of qualifiers of the selected signal. */ std::vector getQualifierStringList(int const& portIndex) const; /*! * Set the qualifier for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newQualifier The new qualifier. + * @param [in] portIndex Index of the selected signal. + * @param [in] newQualifier The new qualifier. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setQualifier(int const& portIndex, std::string const& newQualifier); /*! * Set a new list of qualifiers for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newQualifierList The new list of qualifiers. + * @param [in] portIndex Index of the selected signal. + * @param [in] newQualifierList The new list of qualifiers. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setQualifierStringList(int const& portIndex, std::vector const& newQualifierList); /*! * Get a chosen attribute of a qualifier. * - * @param [in] portIndex Index of the selected signal. - * @param [in] attributeName The name of the attribute to get. - * @param [in] qualifierTypeString The qualifier type. + * @param [in] portIndex Index of the selected signal. + * @param [in] attributeName The name of the attribute to get. + * @param [in] qualifierTypeString The qualifier type. * * @return The chosen attribute. */ @@ -306,10 +306,10 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a qualifier attribute for a specific qualifier type. * - * @param [in] portIndex Index of the selected signal. - * @param [in] attributeName The name of the attribute to set. - * @param [in] attributeValue The value of the attribute to set. - * @param [in] qualifierTypeString The qualifier type. + * @param [in] portIndex Index of the selected signal. + * @param [in] attributeName The name of the attribute to set. + * @param [in] attributeValue The value of the attribute to set. + * @param [in] qualifierTypeString The qualifier type. * * @return True, if attribute was successfully set, otherwise false. */ @@ -319,8 +319,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set all qualifier attributes at once. * - * @param [in] portIndex Index of the selected signal. - * @param [in] attributes Map of attributes to set as name-value pairs. + * @param [in] portIndex Index of the selected signal. + * @param [in] attributes Map of attributes to set as name-value pairs. * * @return True, if attributes were set, otherwise false. */ @@ -329,7 +329,7 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get all of the qualifier's attributes. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * * @return A map of attributes as name-value pairs. */ @@ -338,29 +338,29 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the direction of the selected signal in string form. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Direction string of the selected signal. + * @return Direction string of the selected signal. */ std::string getDirectionString(int const& portIndex) const; /*! * Get the direction of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Direction of the selected signal. + * @return Direction of the selected signal. */ DirectionTypes::Direction getDirection(int const& portIndex) const; /*! * Get the direction of the selected signal. * - * @param [in] portName The selected signal name. - * @param [in] mode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName The selected signal name. + * @param [in] mode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Direction of the selected signal. + * @return Direction of the selected signal. */ DirectionTypes::Direction getDirection(std::string const& portName, General::InterfaceMode mode, std::string const& systemGroup) const; @@ -368,30 +368,30 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a new direction for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newDirection The new direction. + * @param [in] portIndex Index of the selected signal. + * @param [in] newDirection The new direction. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDirection(int const& portIndex, std::string const& newDirection); /*! * Get the width expression of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Width of the selected signal. + * @return Width of the selected signal. */ std::string getWidthExpression(int const& portIndex) const; /*! * Get the width expression of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode in string form. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode in string form. + * @param [in] systemGroup The selected system group. * - * @return Width of the selected signal. + * @return Width of the selected signal. */ std::string getWidthExpression(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -399,11 +399,11 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the width expression of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Width of the selected signal. + * @return Width of the selected signal. */ std::string getWidthExpression(std::string const& portName, General::InterfaceMode interfaceMode, std::string const& systemGroup) const; @@ -411,7 +411,7 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the formatted expression for the width of the selected wire port. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * * @return The formatted expression of the width. */ @@ -420,8 +420,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the width value of the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] baseNumber Base number to format the value to. + * @param [in] portIndex Index of the selected signal. + * @param [in] baseNumber Base number to format the value to. * * @return The evaluated value of the wire width. */ @@ -430,9 +430,9 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the width value of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The interface mode of the port. - * @param [in] systemGroup The port system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The interface mode of the port. + * @param [in] systemGroup The port system group. * * @return The evaluated value of the wire width. */ @@ -441,30 +441,30 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a new width for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newWidth The new width. + * @param [in] portIndex Index of the selected signal. + * @param [in] newWidth The new width. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWidth(int const& portIndex, std::string const& newWidth); /*! * Get the presence of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Presence of the selected signal. + * @return Presence of the selected signal. */ PresenceTypes::Presence getPresence(int const& portIndex) const; /*! * Get the presence of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Presence of the selected signal. + * @return Presence of the selected signal. */ PresenceTypes::Presence getPresence(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -472,20 +472,20 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the presence of the selected signal in string form. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Presence string of the selected signal. + * @return Presence string of the selected signal. */ std::string getPresenceString(int const& portIndex) const; /*! * Get the presence of the selected signal in string form. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Presence string of the selected signal. + * @return Presence string of the selected signal. */ std::string getPresenceString(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -493,87 +493,87 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a new presence for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newPresence The new presence. + * @param [in] portIndex Index of the selected signal. + * @param [in] newPresence The new presence. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPresence(int const& portIndex, std::string const& newPresence); /*! * Get the default value expression of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Default value of the selected signal. + * @return Default value of the selected signal. */ std::string getDefaultValueExpression(int const& portIndex) const; /*! * Get the formatted expression default value of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Default value of the selected signal. + * @return Default value of the selected signal. */ std::string getDefaultValueFormattedExpression(int const& portIndex) const; /*! * Get the evaluated default value of the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] baseNumber The base to format the value to. + * @param [in] portIndex Index of the selected signal. + * @param [in] baseNumber The base to format the value to. * - * @return Default value of the selected signal. + * @return Default value of the selected signal. */ std::string getDefaultValueValue(int const& portIndex, int baseNumber = 0) const; /*! * Set a new default value for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newDefaultValue The new default value. + * @param [in] portIndex Index of the selected signal. + * @param [in] newDefaultValue The new default value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDefaultValue(int const& portIndex, std::string const& newDefaultValue); /*! * Get the driver of the selected signal in string form. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Driver string of the selected signal. + * @return Driver string of the selected signal. */ std::string getDriverString(int const& portIndex) const; /*! * Set a new driver type for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newDriver The new driver type. + * @param [in] portIndex Index of the selected signal. + * @param [in] newDriver The new driver type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDriverType(int const& portIndex, std::string const& newDriver); /*! * Get the bus width expression of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Bus width of the selected signal. + * @return Bus width of the selected signal. */ std::string getBusWidthExpression(int const& portIndex) const; /*! * Get the bus width expression of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Bus width of the selected signal. + * @return Bus width of the selected signal. */ std::string getBusWidthExpression(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -581,29 +581,29 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the formatted expression of the bus width of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Bus width of the selected signal. + * @return Bus width of the selected signal. */ std::string getBusWidthFormattedExpression(int signalIndex) const; /*! * Get the evaluated value of the bus width of the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] baseNumber The base to format the value to. + * @param [in] portIndex Index of the selected signal. + * @param [in] baseNumber The base to format the value to. * - * @return Bus width of the selected signal. + * @return Bus width of the selected signal. */ std::string getBusWidthValue(int portIndex, int baseNumber = 0) const; /*! * Set a new bus width for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newBusWidth The new bus width. + * @param [in] portIndex Index of the selected signal. + * @param [in] newBusWidth The new bus width. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBusWidth(int const& portIndex, std::string const& newBusWidth); @@ -612,20 +612,20 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the initiative of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Initiative of the selected signal. + * @return Initiative of the selected signal. */ std::string getInitiative(int const& portIndex) const; /*! * Get the initiative of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Initiative of the selected signal. + * @return Initiative of the selected signal. */ std::string getInitiative(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -633,207 +633,207 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Set a new initiative for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newInitiative The new initiative. + * @param [in] portIndex Index of the selected signal. + * @param [in] newInitiative The new initiative. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setInitiative(int const& portIndex, std::string const& newInitiative); /*! * Get the kind of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Kind of the selected signal. + * @return Kind of the selected signal. */ std::string getKind(int const& portIndex) const; /*! * Set a new kind for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newKind The new kind. + * @param [in] portIndex Index of the selected signal. + * @param [in] newKind The new kind. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setKind(int const& portIndex, std::string const& newKind); /*! * Check if the selected signal contains protocol. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return True, if the selected signal has protocol, false otherwise. + * @return True, if the selected signal has protocol, false otherwise. */ bool hasProtocol(int const& portIndex) const; /*! * Get the protocol type of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Protocol type of the selected signal. + * @return Protocol type of the selected signal. */ std::string getProtocolType(int const& portIndex) const; /*! * Set a new protocol type for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newProtocolType The new protocol type. + * @param [in] portIndex Index of the selected signal. + * @param [in] newProtocolType The new protocol type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setProtocolType(int const& portIndex, std::string const& newProtocolType); /*! * Get the payload name of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Payload name of the selected signal. + * @return Payload name of the selected signal. */ std::string getPayloadName(int const& portIndex); /*! * Set a new payload name for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newPayloadName The new payload name. + * @param [in] portIndex Index of the selected signal. + * @param [in] newPayloadName The new payload name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPayloadName(int const& portIndex, std::string const& newPayloadName); /*! * Get the payload type of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Payload type of the selected signal. + * @return Payload type of the selected signal. */ std::string getPayloadType(int const& portIndex); /*! * Set a new payload type for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newPayloadType The new payload type. + * @param [in] portIndex Index of the selected signal. + * @param [in] newPayloadType The new payload type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPayloadType(int const& portIndex, std::string const& newPayloadType); /*! * Get the payload extension of the selected signal. * - * @param [in] portIndex Index of the selected signal. + * @param [in] portIndex Index of the selected signal. * - * @return Payload extension of the selected signal. + * @return Payload extension of the selected signal. */ std::string getPayloadExtension(int const& portIndex); /*! * Set a new payload extension for the selected signal. * - * @param [in] portIndex Index of the selected signal. - * @param [in] newPayloadExtension The new payload extension. + * @param [in] portIndex Index of the selected signal. + * @param [in] newPayloadExtension The new payload extension. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPayloadExtension(int const& portIndex, std::string const& newPayloadExtension); /*! * Add a port abstraction containing wire. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ void addWirePort(std::string const& newPortName = std::string("")) final; /*! * Add a port abstraction containing transactional. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ void addTransactionalPort(std::string const& newPortName = std::string("")) final; /*! * Add a wire signal with the selected interface mode to the selected port abstraction. * - * @param [in] portName Name of the selected port abstraction. - * @param [in] newMode The selected interface mode. + * @param [in] portName Name of the selected port abstraction. + * @param [in] newMode The selected interface mode. */ void addModeSpecificWireSignal(std::string const& portName, General::InterfaceMode const& newMode); /*! * Add a new wire signal with the selected system group. * - * @param [in] portName Name of port abstraction containing the signal. - * @param [in] systemGroup The new system group. + * @param [in] portName Name of port abstraction containing the signal. + * @param [in] systemGroup The new system group. */ void addWireSystemSignal(std::string const& portName, std::string const& systemGroup); /*! * Add a transactional signal with the selected interface mode to the selected port abstraction. * - * @param [in] portName Name of the selected port abstraction. - * @param [in] newMode The selected interface mode. + * @param [in] portName Name of the selected port abstraction. + * @param [in] newMode The selected interface mode. */ void addModeSpecificTransactionalSignal(std::string const& portName, General::InterfaceMode const& newMode); /*! * Add a new transactional signal with the selected system group. * - * @param [in] portName Name of port abstraction containing the signal. - * @param [in] systemGroup The new system group. + * @param [in] portName Name of port abstraction containing the signal. + * @param [in] systemGroup The new system group. */ void addTransactionalSystemSignal(std::string const& portName, std::string const& systemGroup); /*! * Remove the selected signal. * - * @param [in] signalIndex Index of the selected signal. + * @param [in] signalIndex Index of the selected signal. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeSignal(int const& signalIndex); /*! * Check if the selected port abstraction contains a wire. * - * @param [in] portName Name of the selected port abstraction. + * @param [in] portName Name of the selected port abstraction. * - * @return True, if the selected port abstraction contains a wire, false otherwise. + * @return True, if the selected port abstraction contains a wire, false otherwise. */ bool portIsWire(std::string const& portName) const final; /*! * Check if the selected port abstraction contains a transactional. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port abstraction contains a transactional, false otherwise. + * @return True, if the selected port abstraction contains a transactional, false otherwise. */ bool portIsTransactional(std::string const& portName) const final; /*! * Get the icon path of the selected signal. * - * @param [in] signalIndex Index of the selected signal. + * @param [in] signalIndex Index of the selected signal. * - * @return Icon path for the selected signal. + * @return Icon path for the selected signal. */ std::string getIconPathForSignal(int const& signalIndex) const; /*! * Get the icon path of the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return Icon path for the selected signal. + * @return Icon path for the selected signal. */ std::string getIconPathForSignal(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) const; @@ -846,11 +846,11 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Check if the selected port has the selected bus interface mode and system group. * - * @param [in] portName Name of the selected port. - * @param [in] interfaceMode The selected bus interface mode. - * @param [in] systemGroup The selected system group. + * @param [in] portName Name of the selected port. + * @param [in] interfaceMode The selected bus interface mode. + * @param [in] systemGroup The selected system group. * - * @return True, if the port has the selected bus interface mode with the selected system group, false + * @return True, if the port has the selected bus interface mode with the selected system group, false * otherwise. */ bool portHasMode(std::string const& portName, std::string const& interfaceMode, std::string const& systemGroup) @@ -859,9 +859,9 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the port abstraction with the selected name. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return The port abstraction with the selected name. + * @return The port abstraction with the selected name. */ QSharedPointer getPort(std::string const& portName) const; @@ -876,8 +876,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the number of references made to itemID on a given signal row. * - * @param [in] signalIndex The index of the signal row. - * @param [in] itemID The parameter itemID to look for. + * @param [in] signalIndex The index of the signal row. + * @param [in] itemID The parameter itemID to look for. * * @return Return the number of references made to itemID. */ @@ -892,9 +892,9 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the port abstraction with the selected name, sliced to a NameGroup. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return The sliced port abstraction with the selected name. + * @return The sliced port abstraction with the selected name. */ QSharedPointer getItem(std::string const& portName) const override; @@ -916,8 +916,8 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * The default constructor. * - * @param [in] isWirePort Flag for wire ports. - * @param [in] isTransactionalPort Flag for transactional ports. + * @param [in] isWirePort Flag for wire ports. + * @param [in] isTransactionalPort Flag for transactional ports. */ SignalRow(bool isWirePort, bool isTransactionalPort); @@ -929,27 +929,27 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Comparison of two SignalRows. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if the SignalRows are equal, otherwise false. + * @return True, if the SignalRows are equal, otherwise false. */ bool operator==(SignalRow const& other) const; /*! * Comparison of two SignalRows. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if the SignalRows are not equal, otherwise false. + * @return True, if the SignalRows are not equal, otherwise false. */ bool operator!=(SignalRow const& other) const; /*! * Less than comparison of two SignalRows for table ordering. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if this precedes other, otherwise false. + * @return True, if this precedes other, otherwise false. */ bool operator<(SignalRow const& other) const; }; @@ -957,53 +957,53 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the signal of the selected index. * - * @param [in] signalIndex The selected index. + * @param [in] signalIndex The selected index. * - * @return The selected signal. + * @return The selected signal. */ QSharedPointer getSignal(int const& signalIndex) const; /*! * Get or create a transactional protocol for the selected signal. * - * @param [in] signalIndex Index of the selected signal. + * @param [in] signalIndex Index of the selected signal. * - * @return Protocol of the selected signal. + * @return Protocol of the selected signal. */ QSharedPointer getOrCreateProtocol(int const& signalIndex) const; /*! * Check if the selected protocol is empty and remove it if it is. * - * @param [in] signalIndex Index of the containing signal. - * @param [in] signalProtocol The selected protocol. + * @param [in] signalIndex Index of the containing signal. + * @param [in] signalProtocol The selected protocol. */ void removeEmptyProtocol(int const& signalIndex, QSharedPointer signalProtocol); /*! * Check if the protocol type of the selected protocol is empty. * - * @param [in] portProtocol The selected protocol. + * @param [in] portProtocol The selected protocol. * - * @return True, if the port protocol is empty, false otherwise. + * @return True, if the port protocol is empty, false otherwise. */ bool portProcotolTypeIsEmpty(QSharedPointer portProtocol) const; /*! * Get the protocol type of the selected protocol. * - * @param [in] portProtocol The selected protocol. + * @param [in] portProtocol The selected protocol. * - * @return The type of the selected protocol. + * @return The type of the selected protocol. */ QString getProtocolTypeText(QSharedPointer portProtocol) const; /*! * Create a wire signal. * - * @param [in] portAbs Port abstraction containing the signal. - * @param [in] modeSpesific Wire port data. - * @param [in] mode The interface mode. + * @param [in] portAbs Port abstraction containing the signal. + * @param [in] modeSpesific Wire port data. + * @param [in] mode The interface mode. */ void createWireSignal(QSharedPointer portAbs, QSharedPointer modeSpesific, General::InterfaceMode mode); @@ -1011,9 +1011,9 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Create a transactional signal. * - * @param [in] portAbs Port abstraction containing the signal. - * @param [in] modeSpesific Transactional port data. - * @param [in] mode The interface mode. + * @param [in] portAbs Port abstraction containing the signal. + * @param [in] modeSpesific Transactional port data. + * @param [in] mode The interface mode. */ void createTransactionalSignal(QSharedPointer portAbs, QSharedPointer modeSpesific, General::InterfaceMode mode); @@ -1021,19 +1021,19 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Write the selected signal to the selected port abstraction. * - * @param [in] portAbs The selected port abstraction. - * @param [in] i Index of the selected signal. + * @param [in] portAbs The selected port abstraction. + * @param [in] i Index of the selected signal. */ void savePort(QSharedPointer portAbs, int i); /*! * Check if the selected port already contains the selected signal. * - * @param [in] mode The selected signal. - * @param [in] portName Name of the selected port. - * @param [in] systemGroup The selected system group. + * @param [in] mode The selected signal. + * @param [in] portName Name of the selected port. + * @param [in] systemGroup The selected system group. * - * @return True, if the selected port already contains the selected signal, false otherwise. + * @return True, if the selected port already contains the selected signal, false otherwise. */ bool modeExistsForPort(General::InterfaceMode const& mode, QString const& portName, QString const& systemGroup = "") const; @@ -1041,9 +1041,9 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Construct a copy signal of the selected signal. * - * @param [in] signal The selected port signal. + * @param [in] signal The selected port signal. * - * @return The constructed copy of the signal. + * @return The constructed copy of the signal. */ QSharedPointer constructCopySignal(QSharedPointer port, bool isWire, bool isTransactional) const; @@ -1051,10 +1051,10 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the mirrored direction for the selected signal. * - * @param [in] portName Name of the selected port. - * @param [in] opposingMode The opposite interface mode of the selected signal. + * @param [in] portName Name of the selected port. + * @param [in] opposingMode The opposite interface mode of the selected signal. * - * @return The mirrored direction for the selected signal. + * @return The mirrored direction for the selected signal. */ DirectionTypes::Direction getMirroredDirectionForSignal(QString const& portName, General::InterfaceMode const& opposingMode) const; @@ -1062,7 +1062,7 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public /*! * Get the corresponding qualifier attribute for a given string. * - * @param [in] attributeName The attribute name to convert to attribute type. + * @param [in] attributeName The attribute name to convert to attribute type. * * @return The matching qualifier attribute type, or attribute type COUNT if there was no match. */ @@ -1072,10 +1072,10 @@ class KACTUS2_API PortAbstractionInterface : public MasterPortInterface, public * Calculate all the references to the selected ID in the selected item. Does nothing useful in this interface. * Replaced by getAllReferencesToIdInRow(). * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const final; diff --git a/KactusAPI/include/PortMapInterface.h b/KactusAPI/include/PortMapInterface.h index 122716908..55439bc6f 100644 --- a/KactusAPI/include/PortMapInterface.h +++ b/KactusAPI/include/PortMapInterface.h @@ -42,11 +42,11 @@ class KACTUS2_API PortMapInterface : public ParameterizableInterface, public Com /*! * The constructor. * - * @param [in] validator Validator for address blocks. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] physicalPortInterface Interface for accessing physical ports. - * @param [in] logicalPortInterface Interface for accessing logical ports. + * @param [in] validator Validator for address blocks. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] physicalPortInterface Interface for accessing physical ports. + * @param [in] logicalPortInterface Interface for accessing logical ports. */ PortMapInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -62,414 +62,414 @@ class KACTUS2_API PortMapInterface : public ParameterizableInterface, public Com /*! * Setup the abstraction definition. * - * @param [in] absDef The new abstraction definition. + * @param [in] absDef The new abstraction definition. */ void setupAbstractionDefinition(QSharedPointer absDef); /*! * Setup the available physical ports. * - * @param [in] component Component containing the selected ports. + * @param [in] component Component containing the selected ports. */ void setupPhysicalPorts(Port::List ports); /*! * Setup the available port maps. * - * @param [in] abstractionType Abstraction type containing the available port maps. + * @param [in] abstractionType Abstraction type containing the available port maps. */ virtual void setupPortMaps(QSharedPointer abstractionType); /*! * Setup the bus interface mode. * - * @param [in] busMode The new bus interface mode. + * @param [in] busMode The new bus interface mode. */ void setupBusMode(General::InterfaceMode busMode); /*! * Setup the system group. * - * @param [in] systemGroup The new system group. + * @param [in] systemGroup The new system group. */ void setupSystemGroup(QString const& systemGroup); /*! * Get name of the indexed logical port. * - * @param [in] itemIndex Index of the selected logical port. + * @param [in] itemIndex Index of the selected logical port. * - * @return Name of the selected logical port. + * @return Name of the selected logical port. */ virtual std::string getIndexedItemName(int const& itemIndex) const; /*! * Get the number of available port maps. * - * @return Number of available port maps. + * @return Number of available port maps. */ virtual int itemCount() const override final; /*! * Get the names of the available logical ports. * - * @return Names of the available logical ports. + * @return Names of the available logical ports. */ virtual std::vector getItemNames() const override final; /*! * Get the logical port name modified by the port map index. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Modified logical port name. + * @return Modified logical port name. */ std::string getLogicalPortName(int const& portMapIndex) const; /*! * Set a new name for the selected logical port. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newName New name for the item. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalPort(int const& portMapIndex, std::string const& newName); /*! * Check if the selected port map has a connected physical port. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the selected port map is connected to a logical port, false otherwise. + * @return True, if the selected port map is connected to a logical port, false otherwise. */ bool hasPhysicalPort(int const& portMapIndex) const; /*! * Get the name of the connected physical port in the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Name of the connected physical port in the selected port map. + * @return Name of the connected physical port in the selected port map. */ std::string getPhysicalPortName(int const& portMapIndex) const; /*! * Set a new name for the connected physical port in the selected port map. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newPhysicalName New name for the physical port. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newPhysicalName New name for the physical port. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPhysicalPort(int const& portMapIndex, std::string const& newPhysicalName); /*! * Get the logical presence of the logical port in the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Logical presence. + * @return Logical presence. */ std::string getLogicalPresence(int const& portMapIndex); /*! * Get the logical presence of the selected logical port. * - * @param [in] logicalPortName Name of the selected logical port. + * @param [in] logicalPortName Name of the selected logical port. * - * @return Logical presence of the selected logical port. + * @return Logical presence of the selected logical port. */ std::string getLogicalPresenceWithLogicalPort(std::string const& logicalName); /*! * Get the invert value of the logical port of the selected port map in string form. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Invert value of the selected logical port in string form. + * @return Invert value of the selected logical port in string form. */ std::string getInvertString(int const& portMapIndex) const; /*! * Get the invert value of the logical port of the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Invert value. + * @return Invert value. */ BooleanValue getInvertValue(int const& portMapIndex) const; /*! * Get the invert value of the logical port of the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Invert value. + * @return Invert value. */ bool getInvertBool(int const& portMapIndex) const; /*! * Set a new invert value for the selected logical port. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newInvertValue The new invert value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newInvertValue The new invert value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setInvertValue(int const& portMapIndex, bool newInvertValue) const; /*! * Get the is informative value of the selected port map in string form. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Is informative value of the selected port map in string form. + * @return Is informative value of the selected port map in string form. */ std::string getIsInformativeString(int const& portMapIndex) const; /*! * Get the is informative value of the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Is informative value of the selected port map. + * @return Is informative value of the selected port map. */ bool getIsInformativeValue(int const& portMapIndex) const; /*! * Set a new is informative value for the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsInformativeValue(int const& portMapIndex, bool newIsInformativeValue) const; /*! * Get the calculated logical tie off of the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated logical tie off value of the selected item. + * @return Calculated logical tie off value of the selected item. */ std::string getLogicalTieOffValue(int const& portMapIndex, int const& baseNumber = 0) const; /*! * Get the formatted logical tie off expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Formatted logical tie off expression of the selected item. + * @return Formatted logical tie off expression of the selected item. */ std::string getLogicalTieOffFormattedExpression(int const& portMapIndex) const; /*! * Get the logical tie off expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Logical tie off expression of the selected item. + * @return Logical tie off expression of the selected item. */ std::string getLogicalTieOffExpression(int const& portMapIndex) const; /*! * Set a new logical tie off value for the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newTieOff New logical tie off value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newTieOff New logical tie off value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalTieOff(int const& portMapIndex, std::string const& newTieOff); /*! * Get the calculated logical left bound of the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated logical left bound value of the selected item. + * @return Calculated logical left bound value of the selected item. */ std::string getLogicalLeftBoundValue(int const& portMapIndex, int const& baseNumber = 0) const; /*! * Get the formatted logical left bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Formatted logical left bound expression of the selected item. + * @return Formatted logical left bound expression of the selected item. */ std::string getLogicalLeftBoundFormattedExpression(int const& portMapIndex) const; /*! * Get the logical left bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Logical left bound expression of the selected item. + * @return Logical left bound expression of the selected item. */ std::string getLogicalLeftBoundExpression(int const& portMapIndex) const; /*! * Set a new logical left value for the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newLogicalLeft New logical left value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newLogicalLeft New logical left value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalLeftBound(int const& portMapIndex, std::string const& newLogicalLeft); /*! * Get the calculated logical right bound of the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated logical right bound value of the selected item. + * @return Calculated logical right bound value of the selected item. */ std::string getLogicalRightBoundValue(int const& portMapIndex, int const& baseNumber = 0) const; /*! * Get the formatted logical right bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Formatted logical right bound expression of the selected item. + * @return Formatted logical right bound expression of the selected item. */ std::string getLogicalRightBoundFormattedExpression(int const& portMapIndex) const; /*! * Get the logical right bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Logical right bound expression of the selected item. + * @return Logical right bound expression of the selected item. */ std::string getLogicalRightBoundExpression(int const& portMapIndex) const; /*! * Set a new logical right value for the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newLogicalRight New logical right value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newLogicalRight New logical right value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLogicalRightBound(int const& portMapIndex, std::string const& newLogicalRight); /*! * Get the calculated physical left bound of the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated physical left bound value of the selected item. + * @return Calculated physical left bound value of the selected item. */ std::string getPhysicalLeftBoundValue(int const& portMapIndex, int const& baseNumber = 0) const; /*! * Get the formatted physical left bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Formatted physical left bound expression of the selected item. + * @return Formatted physical left bound expression of the selected item. */ std::string getPhysicalLeftBoundFormattedExpression(int const& portMapIndex) const; /*! * Get the physical left bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Physical left bound expression of the selected item. + * @return Physical left bound expression of the selected item. */ std::string getPhysicalLeftBoundExpression(int const& portMapIndex) const; /*! * Set a new physical left bound value for the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newPhysicalLeft New physical left value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newPhysicalLeft New physical left value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPhysicalLeftBound(int const& portMapIndex, std::string const& newPhysicalLeft); /*! * Get the calculated physical right bound of the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated physical right bound value of the selected item. + * @return Calculated physical right bound value of the selected item. */ std::string getPhysicalRightBoundValue(int const& portMapIndex, int const& baseNumber = 0) const; /*! * Get the formatted physical right bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Formatted physical right bound expression of the selected item. + * @return Formatted physical right bound expression of the selected item. */ std::string getPhysicalRightBoundFormattedExpression(int const& portMapIndex) const; /*! * Get the physical right bound expression of the selected item. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Physical right bound expression of the selected item. + * @return Physical right bound expression of the selected item. */ std::string getPhysicalRightBoundExpression(int const& portMapIndex) const; /*! * Set a new physical right bound value for the selected item. * - * @param [in] portMapIndex Index of the selected port map. - * @param [in] newPhysicalRight New physical right value. + * @param [in] portMapIndex Index of the selected port map. + * @param [in] newPhysicalRight New physical right value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setPhysicalRightBound(int const& portMapIndex, std::string const& newPhysicalRight); /*! * Get the icon path for the logical port of the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Icon path. + * @return Icon path. */ std::string getLogicalPortIconPath(int const& portMapIndex) const; /*! * Get the icon path for the physical port of the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Icon path for the physical port in the selected port map. + * @return Icon path for the physical port in the selected port map. */ std::string getPhysicalPortIconPath(int const& portMapIndex) const; /*! * Check if the logical port of the selected port map exists. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the logical port exists, false otherwise. + * @return True, if the logical port exists, false otherwise. */ bool logicalPortExists(int const& portMapIndex) const; /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -477,155 +477,155 @@ class KACTUS2_API PortMapInterface : public ParameterizableInterface, public Com /*! * Get the expressions in the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Expressions in the selected component instantiations. + * @return Expressions in the selected component instantiations. */ std::vector getExpressionsInSelectedPortMap(int const& portMapIndex) const; /*! * Validates the contained items. * - * @return True, if all the port maps are valid, false otherwise. + * @return True, if all the port maps are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the logical port of the selected port map is valid. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the logical port is valid, false otherwise. + * @return True, if the logical port is valid, false otherwise. */ bool logicalPortIsValid(int const& portMapIndex) const; /*! * Check if the physical port of the selected port map is valid * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the physical port is valid, false otherwise. + * @return True, if the physical port is valid, false otherwise. */ bool physicalPortIsValid(int const& portMapIndex) const; /*! * Check if the physical mapping of the selected port map is valid * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the physical mapping is valid, false otherwise. + * @return True, if the physical mapping is valid, false otherwise. */ bool physicalMappingIsValid(int const& portMapIndex) const; /*! * Check if the mapped ports have valid port types. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the mapped ports have valid types, otherwise false. + * @return True, if the mapped ports have valid types, otherwise false. */ bool connectedPortsHaveValidPortTypes(int const& portMapIndex) const; /*! * Check if the connected ports of the selected port map have valid directions. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the directions are valid, otherwise false. + * @return True, if the directions are valid, otherwise false. */ bool connectedPortsHaveValidDirections(int const& portMapIndex) const; /*! * Check if the connected ports of the selected port map have valid initiatives. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the initiatives are valid, otherwise false. + * @return True, if the initiatives are valid, otherwise false. */ bool connectedPortsHaveValidInitiatives(int const& portMapIndex) const; /*! * Check if the connected ports of the selected port map have the same range. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the connected ports have the same range, otherwise false. + * @return True, if the connected ports have the same range, otherwise false. */ bool connectedPortsHaveSameRange(int const& portMapIndex) const; /*! * Check if the tie off value of the selected port map is valid. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the tie off value of the selected port map is valid, otherwise false. + * @return True, if the tie off value of the selected port map is valid, otherwise false. */ bool tieOffIsValid(int const& portMapIndex) const; /*! * Checks if the logical port of the selected port map has a valid range. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if the range is valid, otherwise false. + * @return True, if the range is valid, otherwise false. */ bool logicalPortHasValidRange(int const& portMapIndex) const; /*! * Connect the selected logical port to the selected physical port. * - * @param [in] logicalPortName Name of the selected logical port. - * @param [in] physicalPortName Name of the selected physical port. + * @param [in] logicalPortName Name of the selected logical port. + * @param [in] physicalPortName Name of the selected physical port. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool connectPorts(std::string const& logicalPortName, std::string const& physicalPortName); /*! * Add a new port map. * - * @param [in] row Row of the new port map. + * @param [in] row Row of the new port map. */ void addPortMap(int const& row); /*! * Remove the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removePortMap(int const& portMapIndex); /*! * Remove all the port maps from the selected logical port. * - * @param [in] logicalPortName Name of the selected logical port. + * @param [in] logicalPortName Name of the selected logical port. * - * @return List of connected physical port names. + * @return List of connected physical port names. */ std::vector removeAllPortMapsFromLogicalPort(std::string const& logicalPortName); /*! * Get a pointer to the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return Pointer to the selected port map. + * @return Pointer to the selected port map. */ PortMap* getPortMapPointer(int const& portMapIndex) const; /*! * Get the interface for accessing physical ports. * - * @return Interface for accessing physical ports. + * @return Interface for accessing physical ports. */ PortsInterface* getPhysicalPortInterface() const; /*! * Get the interface for accessing logical ports. * - * @return Interface for accessing logical ports. + * @return Interface for accessing logical ports. */ PortAbstractionInterface* getLogicalPortInterface() const; @@ -647,14 +647,14 @@ class KACTUS2_API PortMapInterface : public ParameterizableInterface, public Com /*! * Get the currently active bus interface mode. * - * @return The active interface mode. + * @return The active interface mode. */ General::InterfaceMode getInterfaceMode() const; /*! * Get the currently active system group. * - * @return The active system group. + * @return The active system group. */ std::string getSystemGroup() const; @@ -663,77 +663,77 @@ class KACTUS2_API PortMapInterface : public ParameterizableInterface, public Com /*! * Get a port map with the selected logical signal without connected physical port or assigned tie off. * - * @param [in] logicalPortName Name of the selected logical signal. + * @param [in] logicalPortName Name of the selected logical signal. * - * @return Port map with the connected logical port and unconnected physical. + * @return Port map with the connected logical port and unconnected physical. */ QSharedPointer getUnconnectedPortMap(std::string const& logicalPortName) const; /*! * Get the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return The selected port map. + * @return The selected port map. */ QSharedPointer getPortMap(int const& portMapIndex) const; /*! * Remove an empty logical port from the selected port map. * - * @param [in] editedPortMap The selected port map. + * @param [in] editedPortMap The selected port map. * - * @return True, if the logical port was removed, false otherwise. + * @return True, if the logical port was removed, false otherwise. */ bool removeEmptyLogicalPort(QSharedPointer editedPortMap); /*! * Remove an empty range container from the selected logical port. * - * @param [in] editedPortLogical The selected logical port. + * @param [in] editedPortLogical The selected logical port. */ bool removeEmptyRange(QSharedPointer editedPortLogical); /*! * Remove an empty physical port container from the selected port map. * - * @param [in] editedPortMap The selected port map. + * @param [in] editedPortMap The selected port map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeEmptyPhysicalPort(QSharedPointer editedPortMap); /*! * Remove an empty physical part select container from the selected physical port. * - * @param [in] editedPortMap The selected port map. + * @param [in] editedPortMap The selected port map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeEmptyPhysicalPartSelect(QSharedPointer physicalPort); /*! * Create a part select container for the physical port in the selected port map. * - * @param [in] portMapIndex Index of the selected port map. + * @param [in] portMapIndex Index of the selected port map. * - * @return The created part select. + * @return The created part select. */ QSharedPointer getPhysicalPartSelect(int const& portMapIndex); /*! * Create port maps with the selected presence. * - * @param [in] presence The selected presence. + * @param [in] presence The selected presence. */ void createPortMapsWithPresence(int presence); /*! * Check if a port map exists for the selected signal. * - * @param [in] signalName Name of the selected logical signal. + * @param [in] signalName Name of the selected logical signal. * - * @return True, if a port map exists for the selected signal, false otherwise. + * @return True, if a port map exists for the selected signal, false otherwise. */ bool portMapExistsForLogicalSignal(std::string const& signalName) const; diff --git a/KactusAPI/include/PortsInterface.h b/KactusAPI/include/PortsInterface.h index 0b8b96447..ec9b8c5d2 100644 --- a/KactusAPI/include/PortsInterface.h +++ b/KactusAPI/include/PortsInterface.h @@ -33,9 +33,9 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * The constructor. * - * @param [in] validator Validator for ports. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] validator Validator for ports. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ PortsInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -49,107 +49,107 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Set available ports. * - * @param [in] ports The ports to set. + * @param [in] ports The ports to set. */ void setPorts(Port::List ports); /*! * Check if the there are any available ports. * - * @return True, if there are available ports, false otherwise. + * @return True, if there are available ports, false otherwise. */ bool hasPorts() const; /*! * Get index of the selected port. * - * @param [in] itemName Name of the selected port. + * @param [in] itemName Name of the selected port. * - * @return Index of the selected port. + * @return Index of the selected port. */ int getItemIndex(std::string const& itemName) const final; /*! * Get name of the indexed port. * - * @param [in] portIndex Index of the selected port. + * @param [in] portIndex Index of the selected port. * - * @return Name of the selected port. + * @return Name of the selected port. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available ports. * - * @return Number of available ports. + * @return Number of available ports. */ int itemCount() const final; /*! * Get the names of the available ports. * - * @return Names of the available ports. + * @return Names of the available ports. */ std::vector getItemNames() const final; /*! * Set a new name for the selected port. * - * @param [in] currentPortName Name of the selected port. - * @param [in] newPortName New name for the port. + * @param [in] currentPortName Name of the selected port. + * @param [in] newPortName New name for the port. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setName(std::string const& currentName, std::string const& newName) final; /*! * Calculate all the references to the selected ID in the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] valueID The selected ID. + * @param [in] portName Name of the selected port. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected port. + * @return Number of references to the selected ID in the selected port. */ int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const final; /*! * Check if the selected port exists. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port exists, false otherwise. + * @return True, if the port exists, false otherwise. */ bool portExists(std::string const& portName) const; /*! * Validates the contained ports. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ bool validateItems() const final; /*! * Check if the selected port has a valid name. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ bool itemHasValidName(std::string const& itemName) const final; /*! * Get the type name of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Type name of the selected port. + * @return Type name of the selected port. */ std::string getTypeName(std::string const& portName) const; /*! * Get the type name and type view references as pairs. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * * @return Vector of pairs of type names and vectors of view references. */ @@ -158,7 +158,7 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Get the type name and type definitions as a list of pairs. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * * @return Vector containing pairs of type names and type definition vectors. */ @@ -167,8 +167,8 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Set the port type definition view refs. Should only be used in copy pasting, updates or overwrites existing type def view refs. * - * @param [in] portName Name of the selected port. - * @param [in] typeNameViews The type def name-view reference pairs to set. + * @param [in] portName Name of the selected port. + * @param [in] typeNameViews The type def name-view reference pairs to set. * * @return True, if the operation was successful, otherwise false. */ @@ -177,8 +177,8 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Set the port type definition type definitions. * - * @param [in] portName Name of the selected port. - * @param [in] typeDefinitions The type def name-typeDef pairs to set. + * @param [in] portName Name of the selected port. + * @param [in] typeDefinitions The type def name-typeDef pairs to set. * * @return True, if the operation was successful, otherwise false. */ @@ -187,7 +187,7 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Clear the type definitions of a selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * * @return True, if the selected port is found, otherwise false. */ @@ -196,648 +196,648 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Set a new type name for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newType New type name. + * @param [in] portName Name of the selected port. + * @param [in] newType New type name. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setTypeName(std::string const& portName, std::string const& newType) const; /*! * Get the calculated array left value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated array left value of the selected port. + * @return Calculated array left value of the selected port. */ std::string getArrayLeftValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted array left expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted array left expression of the selected port. + * @return Formatted array left expression of the selected port. */ std::string getArrayLeftFormattedExpression(std::string const& portName) const; /*! * Get the array left expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Array left expression of the selected port. + * @return Array left expression of the selected port. */ std::string getArrayLeftExpression(std::string const& portName) const; /*! * Set a new array left value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newArrayLeft New array left value. + * @param [in] portName Name of the selected port. + * @param [in] newArrayLeft New array left value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setArrayLeft(std::string const& portName, std::string const& newArrayLeft) const; /*! * Get the calculated array right value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated array right value of the selected port. + * @return Calculated array right value of the selected port. */ std::string getArrayRightValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted array right expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted array right expression of the selected port. + * @return Formatted array right expression of the selected port. */ std::string getArrayRightFormattedExpression(std::string const& portName) const; /*! * Get the array right expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Array right expression of the selected port. + * @return Array right expression of the selected port. */ std::string getArrayRightExpression(std::string const& portName) const; /*! * Set a new array right value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newArrayRight New array right value. + * @param [in] portName Name of the selected port. + * @param [in] newArrayRight New array right value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setArrayRight(std::string const& portName, std::string const& newArrayRight) const; /*! * Get the tags of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Tags of the selected port. + * @return Tags of the selected port. */ std::string getTags(std::string const& portName) const; /*! * Set new tags for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] tagList List of the new tags separated by ','. + * @param [in] portName Name of the selected port. + * @param [in] tagList List of the new tags separated by ','. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setTags(std::string const& portName, std::string const& tagList) const; /*! * Check if the selected port is ad hoc. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is ad hoc, false otherwise. + * @return True, if the selected port is ad hoc, false otherwise. */ bool isAdHoc(std::string const& portName) const; /*! * Set a new ad hoc visibility flag for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newAdHocVisibility Flag for ad hoc visibility. + * @param [in] portName Name of the selected port. + * @param [in] newAdHocVisibility Flag for ad hoc visibility. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAdHoc(std::string const& portName, bool newAdHocVisibility) const; /*! * Get the direction of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Direction of the selected port. + * @return Direction of the selected port. */ std::string getDirection(std::string const& portName) const; /*! * Get the direction of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Direction of the selected port. + * @return Direction of the selected port. */ DirectionTypes::Direction getDirectionType(std::string const& portName) const; /*! * Set direction for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newDirection New direction. + * @param [in] portName Name of the selected port. + * @param [in] newDirection New direction. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDirection(std::string const& portName, std::string const& newDirection) const; /*! * Get the calculated left bound value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated left bound value of the selected port. + * @return Calculated left bound value of the selected port. */ std::string getLeftBoundValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted left bound expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted left bound expression of the selected port. + * @return Formatted left bound expression of the selected port. */ std::string getLeftBoundFormattedExpression(std::string const& portName) const; /*! * Get the left bound expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Left bound expression of the selected port. + * @return Left bound expression of the selected port. */ std::string getLeftBoundExpression(std::string const& portName) const; /*! * Set a new left bound value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newLeftBound New left bound value. + * @param [in] portName Name of the selected port. + * @param [in] newLeftBound New left bound value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setLeftBound(std::string const& portName, std::string const& newLeftBound) const; /*! * Get the calculated right bound value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated right bound value of the selected port. + * @return Calculated right bound value of the selected port. */ std::string getRightBoundValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted right bound expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted right bound expression of the selected port. + * @return Formatted right bound expression of the selected port. */ std::string getRightBoundFormattedExpression(std::string const& portName) const; /*! * Get the right bound expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Right bound expression of the selected port. + * @return Right bound expression of the selected port. */ std::string getRightBoundExpression(std::string const& portName) const; /*! * Set a new right bound value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newRightBound New right bound value. + * @param [in] portName Name of the selected port. + * @param [in] newRightBound New right bound value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setRightBound(std::string const& portName, std::string const& newRightBound) const; /*! * Check if the selected port has an expression in the left or right bound values. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port has an expression in the left or right bound values, false otherwise. + * @return True, if the port has an expression in the left or right bound values, false otherwise. */ bool hasExpressionInLeftOrRightBound(std::string const& portName) const; /*! * Get the calculated width of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Calculated width of the selected port. + * @return Calculated width of the selected port. */ std::string getWidth(std::string const& portName) const; /*! * Set new values for the left and right bounds of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newWidth New width. + * @param [in] portName Name of the selected port. + * @param [in] newWidth New width. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setWidth(std::string const& portName, std::string const& newWidth) const; /*! * Get the calculated default value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated default value of the selected port. + * @return Calculated default value of the selected port. */ std::string getDefaultValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted default value expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted default value expression of the selected port. + * @return Formatted default value expression of the selected port. */ std::string getDefaultValueFormattedExpression(std::string const& portName) const; /*! * Get the default value expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Default value expression of the selected port. + * @return Default value expression of the selected port. */ std::string getDefaultValueExpression(std::string const& portName) const; /*! * Set a new default value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newDefaultValue New default value. + * @param [in] portName Name of the selected port. + * @param [in] newDefaultValue New default value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDefaultValue(std::string const& portName, std::string const& newDefaultValue) const; /*! * Get the calculated bus width value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated bus width value of the selected port. + * @return Calculated bus width value of the selected port. */ std::string getBusWidthValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted bus width expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted bus width expression of the selected port. + * @return Formatted bus width expression of the selected port. */ std::string getBusWidthFormattedExpression(std::string const& portName) const; /*! * Get the bus width expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Bus width expression of the selected port. + * @return Bus width expression of the selected port. */ std::string getBusWidthExpression(std::string const& portName) const; /*! * Set a new bus width for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newBusWidth New bus width. + * @param [in] portName Name of the selected port. + * @param [in] newBusWidth New bus width. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setBusWidth(std::string const& portName, std::string const& newBusWidth) const; /*! * Get the initiative of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Initiative of the selected port. + * @return Initiative of the selected port. */ std::string getInitiative(std::string const& portName) const; /*! * Set initiative for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newInitiative New initiative. + * @param [in] portName Name of the selected port. + * @param [in] newInitiative New initiative. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setInitiative(std::string const& portName, std::string const& newInitiative) const; /*! * Get the kind of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Kind of the selected port. + * @return Kind of the selected port. */ std::string getKind(std::string const& portName) const; /*! * Set kind for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newKind New kind. + * @param [in] portName Name of the selected port. + * @param [in] newKind New kind. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setKind(std::string const& portName, std::string const& newKind) const; /*! * Get the protocol type of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Protocol type of the selected port. + * @return Protocol type of the selected port. */ std::string getProtocolType(std::string const& portName) const; /*! * Set protocol type for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newProtocolType New protocol type. + * @param [in] portName Name of the selected port. + * @param [in] newProtocolType New protocol type. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setProtocolType(std::string const& portName, std::string const& newProtocolType) const; /*! * Get the calculated max connections value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated max connections value of the selected port. + * @return Calculated max connections value of the selected port. */ std::string getMaxConnectionsValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted max connections expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted max connections expression of the selected port. + * @return Formatted max connections expression of the selected port. */ std::string getMaxConnectionsFormattedExpression(std::string const& portName) const; /*! * Get the max connections expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Max connections expression of the selected port. + * @return Max connections expression of the selected port. */ std::string getMaxConnectionsExpression(std::string const& portName) const; /*! * Set a new max connections value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newMaxConnections New max connections value. + * @param [in] portName Name of the selected port. + * @param [in] newMaxConnections New max connections value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMaxConnections(std::string const& portName, std::string const& newMaxConnections) const; /*! * Get the calculated min connections value of the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] baseNumber Base for displaying the value. + * @param [in] portName Name of the selected port. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated min connections value of the selected port. + * @return Calculated min connections value of the selected port. */ std::string getMinConnectionsValue(std::string const& portName, unsigned int baseNumber = 10) const; /*! * Get the formatted min connections expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Formatted min connections expression of the selected port. + * @return Formatted min connections expression of the selected port. */ std::string getMinConnectionsFormattedExpression(std::string const& portName) const; /*! * Get the min connections expression of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Min connections expression of the selected port. + * @return Min connections expression of the selected port. */ std::string getMinConnectionsExpression(std::string const& portName) const; /*! * Set a new min connections value for the selected port. * - * @param [in] portName Name of the selected port. - * @param [in] newMinConnections New max connections value. + * @param [in] portName Name of the selected port. + * @param [in] newMinConnections New max connections value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMinConnections(std::string const& portName, std::string const& newMinConnections) const; /*! * Add a wire port. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ void addWirePort(std::string const& newPortName = std::string()) final; /*! * Add a transactional port. * - * @param [in] newPortName Name of the new port. + * @param [in] newPortName Name of the new port. */ void addTransactionalPort(std::string const& newPortName = std::string()) final; /*! * Remove the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. */ bool removePort(std::string const& portName) const; /*! * Check if the selected port has a valid left array value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the left array value is valid, false otherwise. + * @return True, if the left array value is valid, false otherwise. */ bool portLeftArrayValueIsValid(std::string const& portName) const; /*! * Check if the selected port has a valid right array value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the right array value is valid, false otherwise. + * @return True, if the right array value is valid, false otherwise. */ bool portRightArrayValueIsValid(std::string const& portName) const; /*! * Check if the selected port has valid types. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the types is valid, false otherwise. + * @return True, if the types is valid, false otherwise. */ bool portHasValidTypes(std::string const& portName) const; /*! * Check if the selected port is a wire. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is a wire, false otherwise. + * @return True, if the selected port is a wire, false otherwise. */ bool portIsWire(std::string const& portName) const final; /*! * Check if the selected port is a wire. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the selected port is a wire, false otherwise. + * @return True, if the selected port is a wire, false otherwise. */ bool portIsWire(QSharedPointer port) const; /*! * Check if the selected port has a valid left bound value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the left bound value is valid, false otherwise. + * @return True, if the left bound value is valid, false otherwise. */ bool portHasValidLeftBound(std::string const& portName) const; /*! * Check if the selected port has a valid right bound value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the right bound value is valid, false otherwise. + * @return True, if the right bound value is valid, false otherwise. */ bool portHasValidRightBound(std::string const& portName) const; /*! * Check if the selected port has a valid default value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the default value is valid, false otherwise. + * @return True, if the default value is valid, false otherwise. */ bool portHasValidDefaultValue(std::string const& portName) const; /*! * Check if the selected port is transactional. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is transactional, false otherwise. + * @return True, if the selected port is transactional, false otherwise. */ bool portIsTransactional(std::string const& portName) const final; /*! * Check if the selected port is transactional. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the selected port is transactional, false otherwise. + * @return True, if the selected port is transactional, false otherwise. */ bool portIsTransactional(QSharedPointer port) const; /*! * Check if the selected port has a valid bus width. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the bus width is valid, false otherwise. + * @return True, if the bus width is valid, false otherwise. */ bool portHasValidBusWidth(std::string const& portName) const; /*! * Check if the selected port has a valid initiative. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the initiative is valid, false otherwise. + * @return True, if the initiative is valid, false otherwise. */ bool portHasValidInitiative(std::string const& portName) const; /*! * Check if the selected port has a valid kind. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the kind is valid, false otherwise. + * @return True, if the kind is valid, false otherwise. */ bool portHasValidKind(std::string const& portName) const; /*! * Check if the selected port has a valid protocol. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the protocol is valid, false otherwise. + * @return True, if the protocol is valid, false otherwise. */ bool portHasValidProtocol(std::string const& portName) const; /*! * Check if the selected port has a valid max connections value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the max connections value is valid, false otherwise. + * @return True, if the max connections value is valid, false otherwise. */ bool portHasValidMaxConnections(std::string const& portName) const; /*! * Check if the selected port has a valid min connections value. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the min connections value is valid, false otherwise. + * @return True, if the min connections value is valid, false otherwise. */ bool portHasValidMinConnections(std::string const& portName) const; /*! * Get the icon path of the selected port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return Icon path for the selected port. + * @return Icon path for the selected port. */ std::string getIconPathForPort(std::string const& portName) const; /*! * Get the port with the selected name. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return The port with the selected name. + * @return The port with the selected name. */ QSharedPointer getPort(std::string const& portName) const; @@ -852,7 +852,7 @@ class KACTUS2_API PortsInterface : public ParameterizableInterface, public Maste /*! * Set the type name and definition of a port. * - * @param [in] port The selected port. + * @param [in] port The selected port. */ void setTypeNameAndDefinition(QSharedPointer port) const; diff --git a/KactusAPI/include/RegisterExpressionsGatherer.h b/KactusAPI/include/RegisterExpressionsGatherer.h index 17b69ff16..2b2c13711 100644 --- a/KactusAPI/include/RegisterExpressionsGatherer.h +++ b/KactusAPI/include/RegisterExpressionsGatherer.h @@ -38,9 +38,9 @@ class RegisterExpressionsGatherer /*! * Get the expressions from a given register. * - * @param [in] currentRegister The given register. + * @param [in] currentRegister The given register. * - * @return A list containing all the expressions used in a register. + * @return A list containing all the expressions used in a register. */ QStringList getExpressions(QSharedPointer currentRegister) const; diff --git a/KactusAPI/include/RegisterFileExpressionsGatherer.h b/KactusAPI/include/RegisterFileExpressionsGatherer.h index 4e9dda95e..5df8298f5 100644 --- a/KactusAPI/include/RegisterFileExpressionsGatherer.h +++ b/KactusAPI/include/RegisterFileExpressionsGatherer.h @@ -35,9 +35,9 @@ class KACTUS2_API RegisterFileExpressionsGatherer /*! * Get the expressions from a given register file. * - * @param [in] currentRegister The given register file. + * @param [in] currentRegister The given register file. * - * @return A list containing all the expressions used in a register file. + * @return A list containing all the expressions used in a register file. */ QStringList getExpressions(QSharedPointer currentRegisterFile) const; diff --git a/KactusAPI/include/RegisterInterface.h b/KactusAPI/include/RegisterInterface.h index 5fb5f1c51..383bbc3d5 100644 --- a/KactusAPI/include/RegisterInterface.h +++ b/KactusAPI/include/RegisterInterface.h @@ -39,10 +39,10 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * The constructor. * - * @param [in] validator Validator for registers. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] subInterface Interface for accessing fields. + * @param [in] validator Validator for registers. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] subInterface Interface for accessing fields. */ RegisterInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -58,276 +58,276 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * Set available registers. * - * @param [in] newRegisterData The new register data. + * @param [in] newRegisterData The new register data. */ void setRegisters(QSharedPointer > > newRegisterData); /*! * Get index of the selected item. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return Index of the selected item. + * @return Index of the selected item. */ virtual int getItemIndex(std::string const& itemName) const override final; /*! * Get name of the indexed item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. * - * @return Name of the selected item. + * @return Name of the selected item. */ std::string getIndexedItemName(int itemIndex) const final; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the number of register data. * - * @return Number of register data. + * @return Number of register data. */ int registerDataCount() const; /*! * Get the selected index as the index of register data. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The selected index transformed to register data index. + * @return The selected index transformed to register data index. */ int indexInRegisterData(int const& index) const; /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const override final; /*! * Set a new name for the selected item. * - * @param [in] currentName Name of the selected item. - * @param [in] newName New name for the item. + * @param [in] currentName Name of the selected item. + * @param [in] newName New name for the item. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ virtual bool setName(std::string const& currentName, std::string const& newName) override final; /*! * Get the calculated offset value of the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] baseNumber Base for displaying the value. + * @param [in] registerName Name of the selected register. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated offset value of the selected register. + * @return Calculated offset value of the selected register. */ std::string getOffsetValue(std::string const& registerName, int const& baseNumber = 0) const; /*! * Get the formatted offset expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Formatted offset expression of the selected register. + * @return Formatted offset expression of the selected register. */ std::string getOffsetFormattedExpression(std::string const& registerName) const; /*! * Get the offset expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Offset expression of the selected register. + * @return Offset expression of the selected register. */ std::string getOffsetExpression(std::string const& registerName) const; /*! * Set a new offset value for the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] newOffset New offset value. + * @param [in] registerName Name of the selected register. + * @param [in] newOffset New offset value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setOffset(std::string const& registerName, std::string const& newOffset); /*! * Get the calculated dimension value of the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] baseNumber Base for displaying the value. + * @param [in] registerName Name of the selected register. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated dimension value of the selected register. + * @return Calculated dimension value of the selected register. */ std::string getDimensionValue(std::string const& registerName, int const& baseNumber = 0) const; /*! * Get the formatted dimension expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Formatted dimension expression of the selected register. + * @return Formatted dimension expression of the selected register. */ std::string getDimensionFormattedExpression(std::string const& registerName) const; /*! * Get the dimension expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Dimension expression of the selected register. + * @return Dimension expression of the selected register. */ std::string getDimensionExpression(std::string const& registerName) const; /*! * Set a new dimension value for the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] newDimension New dimension value. + * @param [in] registerName Name of the selected register. + * @param [in] newDimension New dimension value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setDimension(std::string const& registerName, std::string const& newDimension); /*! * Get the calculated is present value of the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] baseNumber Base for displaying the value. + * @param [in] registerName Name of the selected register. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated is present value of the selected register. + * @return Calculated is present value of the selected register. */ std::string getIsPresentValue(std::string const& registerName, int const& baseNumber = 0) const; /*! * Get the formatted is present expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Formatted is present expression of the selected register. + * @return Formatted is present expression of the selected register. */ std::string getIsPresentFormattedExpression(std::string const& registerName) const; /*! * Get the is present expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Is present expression of the selected register. + * @return Is present expression of the selected register. */ std::string getIsPresentExpression(std::string const& registerName) const; /*! * Set a new is present value for the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] newIsPresent New is present value. + * @param [in] registerName Name of the selected register. + * @param [in] newIsPresent New is present value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsPresent(std::string const& registerName, std::string const& newIsPresent); /*! * Get the calculated size value of the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] baseNumber Base for displaying the value. + * @param [in] registerName Name of the selected register. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated size value of the selected register. + * @return Calculated size value of the selected register. */ std::string getSizeValue(std::string const& registerName, int const& baseNumber = 0) const; /*! * Get the formatted size expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Formatted size expression of the selected register. + * @return Formatted size expression of the selected register. */ std::string getSizeFormattedExpression(std::string const& registerName) const; /*! * Get the size expression of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return Size expression of the selected register. + * @return Size expression of the selected register. */ std::string getSizeExpression(std::string const& registerName) const; /*! * Set a new size value for the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] newSize New size value. + * @param [in] registerName Name of the selected register. + * @param [in] newSize New size value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setSize(std::string const& registerName, std::string const& newSize); /*! * Get the volatile of the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return The volatile value of the selected register. + * @return The volatile value of the selected register. */ std::string getVolatile(std::string const& registerName) const; /*! * Set the volatile for the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] newVolatile The new volatile value. + * @param [in] registerName Name of the selected register. + * @param [in] newVolatile The new volatile value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setVolatile(std::string const& registerName, std::string const& newVolatile); /*! * Get the access string of the selected register or first access policy. * - * @param [in] registerName Name of the selected register. - * @param [in] getAccessPolicyAccess Flag indicating if access is fetched from access policy or directly + * @param [in] registerName Name of the selected register. + * @param [in] getAccessPolicyAccess Flag indicating if access is fetched from access policy or directly * from register. Access is fetched from first access policy, if true. * - * @return The access string of the selected register. + * @return The access string of the selected register. */ std::string getAccessString(std::string const& registerName, bool getAccessPolicyAccess = false) const; /*! * Get the access of the selected register or access policy given by the access policy index. * - * @param [in] registerName Name of the selected register. - * @param [in] accessPolicyIndex The index of the selected access policy. + * @param [in] registerName Name of the selected register. + * @param [in] accessPolicyIndex The index of the selected access policy. * - * @return The access value of the selected register. + * @return The access value of the selected register. */ AccessTypes::Access getAccess(std::string const& registerName) const; /*! * Set the access value for the selected register or its access policy given by the access policy index. * - * @param [in] registerName Name of the selected register. - * @param [in] newAccess The new access value. - * @param [in] getAccessPolicyAccess Flag indicating if access is set to access policy or directly + * @param [in] registerName Name of the selected register. + * @param [in] newAccess The new access value. + * @param [in] getAccessPolicyAccess Flag indicating if access is set to access policy or directly * to register. Access is set to first access policy, if true. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setAccess(std::string const& registerName, std::string const& newAccess, bool setAccessPolicyAccess = false); /*! * Get the number of access policies for a given register. * - * @param [in] registerName The name of the register to get the number off access policies of. + * @param [in] registerName The name of the register to get the number off access policies of. * * @return The number of access policies for the given register. */ @@ -336,7 +336,7 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * Adds a new access policy to the selected register. * - * @param [in] registerName The selected register. + * @param [in] registerName The selected register. * * @return True, if operation was successful, otherwise false. */ @@ -345,10 +345,10 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * Calculate all the references to the selected ID in the selected item. * - * @param [in] itemName Name of the selected item. - * @param [in] valueID The selected ID. + * @param [in] itemName Name of the selected item. + * @param [in] valueID The selected ID. * - * @return Number of references to the selected ID in the selected item. + * @return Number of references to the selected ID in the selected item. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -356,115 +356,115 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected item has a valid name. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the name is valid, false otherwise. + * @return True, if the name is valid, false otherwise. */ virtual bool itemHasValidName(std::string const& itemName) const override final; /*! * Check if the selected register has a valid dimension. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return True, if the dimension is valid, false otherwise. + * @return True, if the dimension is valid, false otherwise. */ bool hasValidDimension(std::string const& registerName) const; /*! * Check if the selected register has a valid offset. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return True, if the offset is valid, false otherwise. + * @return True, if the offset is valid, false otherwise. */ bool hasValidOffset(std::string const& registerName) const; /*! * Check if the selected register has a valid is present value. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return True, if the is present value is valid, false otherwise. + * @return True, if the is present value is valid, false otherwise. */ bool hasValidIsPresent(std::string const& registerName) const; /*! * Check if the selected register has a valid size. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return True, if the size is valid, false otherwise. + * @return True, if the size is valid, false otherwise. */ bool hasValidSize(std::string const& registerName) const; /*! * Add a new register. * - * @param [in] row Row of the new register. - * @param [in] dataIndex Index of the new register in the register data. - * @param [in] newRegisterName Name of the new register. + * @param [in] row Row of the new register. + * @param [in] dataIndex Index of the new register in the register data. + * @param [in] newRegisterName Name of the new register. */ void addRegister(int const& row, int const& dataIndex, std::string const& newRegisterName = std::string("")); /*! * Remove the selected register. * - * @param [in] registerName Name of the selected register. - * @param [in] dataIndex Index of the removed register in the register data. + * @param [in] registerName Name of the selected register. + * @param [in] dataIndex Index of the removed register in the register data. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeRegister(std::string const& registerName, int const& dataIndex); /*! * Copy the selected registers. * - * @param [in] selectedRows Indexes of the selected registers. + * @param [in] selectedRows Indexes of the selected registers. */ void copyRows(std::vector const& selectedRows); /*! * Paste the selected registers. * - * @return Names of the pasted registers. + * @return Names of the pasted registers. */ std::vector pasteRows(); /*! * Get the number of pasted registers. * - * @return Number of the pasted registers. + * @return Number of the pasted registers. */ int getPasteRowCount() const; /*! * Get the expressions in the selected registers. * - * @param [in] registerNames Names of the selected registers. + * @param [in] registerNames Names of the selected registers. * - * @return The expressions of the selected registers. + * @return The expressions of the selected registers. */ std::vector getExpressionsInSelectedRegisters(std::vector const& registerNames) const; /*! * Change the value for address unit bits. * - * @param [in] newAddressUnitbits The new value for address unit bits. + * @param [in] newAddressUnitbits The new value for address unit bits. */ void setAddressUnitBits(int const& newAddressUnitbits); /*! * Get the sub interface. * - * @return Interface for accessing fields. + * @return Interface for accessing fields. */ FieldInterface* getSubInterface() const; @@ -480,18 +480,18 @@ class KACTUS2_API RegisterInterface : public ParameterizableInterface, public Na /*! * Get the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return The selected register. + * @return The selected register. */ QSharedPointer getRegister(std::string const& registerName) const; /*! * Get the register with the selected name, sliced to a NameGroup. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return The sliced register with the selected name. + * @return The sliced register with the selected name. */ QSharedPointer getItem(std::string const& registerName) const; diff --git a/KactusAPI/include/ResetInterface.h b/KactusAPI/include/ResetInterface.h index 0e0649174..e4018d775 100644 --- a/KactusAPI/include/ResetInterface.h +++ b/KactusAPI/include/ResetInterface.h @@ -32,9 +32,9 @@ class KACTUS2_API ResetInterface : public ParameterizableInterface, public Commo /*! * The constructor. * - * @param [in] validator Validator for fields. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] validator Validator for fields. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ ResetInterface(QSharedPointer validator, QSharedPointer expressionParser, @@ -48,176 +48,176 @@ class KACTUS2_API ResetInterface : public ParameterizableInterface, public Commo /*! * Set available resets. * - * @param [in] containingField Field containing the resets. + * @param [in] containingField Field containing the resets. */ void setResets(QSharedPointer containingField); /*! * Get the names of the available items. * - * @return Names of the available items. + * @return Names of the available items. */ virtual std::vector getItemNames() const; /*! * Get the number of available items. * - * @return Number of available items. + * @return Number of available items. */ virtual int itemCount() const override final; /*! * Get the reset type reference of the selected reset. * - * @param [in] itemIndex Index of the selected reset. + * @param [in] itemIndex Index of the selected reset. * - * @return Reset type reference of the selected reset. + * @return Reset type reference of the selected reset. */ std::string getResetTypeReference(int const& itemIndex) const; /*! * Set the reset type reference for the selected reset. * - * @param [in] resetIndex Index of the selected reset. - * @param [in] newResetType The new reset type reference. + * @param [in] resetIndex Index of the selected reset. + * @param [in] newResetType The new reset type reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setResetTypeReference(int const& resetIndex, std::string const& newResetType); /*! * Get the calculated reset value of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. - * @param [in] baseNumber Base for displaying the value. + * @param [in] resetIndex Index of the selected reset. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated reset value of the selected port. + * @return Calculated reset value of the selected port. */ std::string getResetValue(int const& resetIndex, int const& baseNumber = 0) const; /*! * Get the formatted reset value expression of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return Formatted reset value expression of the selected reset. + * @return Formatted reset value expression of the selected reset. */ std::string getResetValueFormattedExpression(int const& resetIndex) const; /*! * Get the reset value expression of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return Reset value expression of the selected reset. + * @return Reset value expression of the selected reset. */ std::string getResetValueExpression(int const& resetIndex) const; /*! * Set a new reset value for the selected reset type. * - * @param [in] resetIndex Index of the selected reset. - * @param [in] newResetValue New reset value. + * @param [in] resetIndex Index of the selected reset. + * @param [in] newResetValue New reset value. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setResetValue(int const& resetIndex, std::string const& newResetValue); /*! * Get the calculated reset mask value of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. - * @param [in] baseNumber Base for displaying the value. + * @param [in] resetIndex Index of the selected reset. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated reset mask value of the selected port. + * @return Calculated reset mask value of the selected port. */ std::string getResetMaskValue(int const& resetIndex, int const& baseNumber = 0) const; /*! * Get the formatted reset mask expression of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return Formatted reset mask expression of the selected reset. + * @return Formatted reset mask expression of the selected reset. */ std::string getResetMaskFormattedExpression(int const& resetIndex) const; /*! * Get the reset mask expression of the selected reset type. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return Reset mask expression of the selected reset. + * @return Reset mask expression of the selected reset. */ std::string getResetMaskExpression(int const& resetIndex) const; /*! * Set a new reset mask for the selected reset type. * - * @param [in] resetIndex Index of the selected reset. - * @param [in] newResetMask New reset mask. + * @param [in] resetIndex Index of the selected reset. + * @param [in] newResetMask New reset mask. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setResetMask(int const& resetIndex, std::string const& newResetMask); /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the reset type reference of the selected reset is valid. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return True, if the selected reset type reference is valid, false otherwise. + * @return True, if the selected reset type reference is valid, false otherwise. */ bool hasValidResetType(int const& resetIndex) const; /*! * Check if the reset value of the selected reset is valid. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return True, if the selected reset value is valid, false otherwise. + * @return True, if the selected reset value is valid, false otherwise. */ bool hasValidResetValue(int const& resetIndex) const; /*! * Check if the reset mask of the selected reset is valid. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return True, if the selected reset mask is valid, false otherwise. + * @return True, if the selected reset mask is valid, false otherwise. */ bool hasValidResetMask(int const& resetIndex) const; /*! * Add a new reset. * - * @param [in] row Row of the new reset. + * @param [in] row Row of the new reset. */ void addReset(int const& row); /*! * Remove the selected reset. * - * @param [in] resetName Name of the selected reset. + * @param [in] resetName Name of the selected reset. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeReset(int const& resetIndex); /*! * Get all the references made to the selected ID in the selected reset. * - * @param [in] itemName The reset type reference of the selected reset. - * @param [in] valueID The selected ID. + * @param [in] itemName The reset type reference of the selected reset. + * @param [in] valueID The selected ID. * - * @return Number of references made to the selected ID in the selected reset. + * @return Number of references made to the selected ID in the selected reset. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const override final; @@ -225,10 +225,10 @@ class KACTUS2_API ResetInterface : public ParameterizableInterface, public Commo /*! * Get all the references made to the selected ID in the selected reset. * - * @param [in] itemIndex Index of the selected reset. - * @param [in] valueID The selected ID. + * @param [in] itemIndex Index of the selected reset. + * @param [in] valueID The selected ID. * - * @return Number of references made to the selected ID in the selected reset. + * @return Number of references made to the selected ID in the selected reset. */ int getAllReferencesToIdInIndex(int const& itemIndex, std::string const& valueID) const; @@ -237,9 +237,9 @@ class KACTUS2_API ResetInterface : public ParameterizableInterface, public Commo /*! * Get the selected reset. * - * @param [in] resetIndex Index of the selected reset. + * @param [in] resetIndex Index of the selected reset. * - * @return The selected reset. + * @return The selected reset. */ QSharedPointer getReset(int const& resetIndex) const; diff --git a/KactusAPI/include/SubspaceMapInterface.h b/KactusAPI/include/SubspaceMapInterface.h index 97004b6bf..209d5454b 100644 --- a/KactusAPI/include/SubspaceMapInterface.h +++ b/KactusAPI/include/SubspaceMapInterface.h @@ -36,11 +36,11 @@ class KACTUS2_API SubspaceMapInterface : public MemoryBlockInterface /*! * The constructor. * - * @param [in] subspaceValidator Validator for subspace maps. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] busInterfaceInterface Interface for accessing bus interfaces. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] subspaceValidator Validator for subspace maps. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] busInterfaceInterface Interface for accessing bus interfaces. + * @param [in] parameterInterface Interface for accessing parameters. */ SubspaceMapInterface(QSharedPointer subspaceValidator, QSharedPointer expressionParser, @@ -56,99 +56,99 @@ class KACTUS2_API SubspaceMapInterface : public MemoryBlockInterface /*! * Check if the selected memory block is accepted. * - * @param [in] blockName Name of the selected memory block. + * @param [in] blockName Name of the selected memory block. * - * @return True, if the memory block is accepted, false otherwise. + * @return True, if the memory block is accepted, false otherwise. */ virtual bool acceptBlock(std::string const& blockName) const override final; /*! * Get the master bus interface reference of the selected subspace map. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return The master bus interface reference of the selected subspace map. + * @return The master bus interface reference of the selected subspace map. */ std::string getInitiatorReference(std::string const& itemName) const; /*! * Set the master bus interface reference of the selected subspace map. * - * @param [in] itemName Name of the selected subspace map. - * @param [in] newMasterReference New master bus interface reference for the selected subspace map. + * @param [in] itemName Name of the selected subspace map. + * @param [in] newMasterReference New master bus interface reference for the selected subspace map. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMasterReference(std::string const& itemName, std::string const& newMasterReference); /*! * Get the segment reference of the selected subspace map. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return Segment reference of the selected subspace map. + * @return Segment reference of the selected subspace map. */ std::string getSegmentReference(std::string const& itemName) const; /*! * Set a new segment reference for the selected subspace map. * - * @param [in] itemName Name of the selected subspace map. - * @param [in] newSegmentReference The new segment reference. + * @param [in] itemName Name of the selected subspace map. + * @param [in] newSegmentReference The new segment reference. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setSegmentReference(std::string const& itemName, std::string const& newSegmentReference); /*! * Get the calculated width value of the selected address block. * - * @param [in] blockName Name of the selected address block. - * @param [in] baseNumber Base for displaying the value. + * @param [in] blockName Name of the selected address block. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated width value of the selected address block. + * @return Calculated width value of the selected address block. */ std::string getWidthValue(std::string const& subspaceName, int const& baseNumber = 0) const; /*! * Validates the contained items. * - * @return True, if all the ports are valid, false otherwise. + * @return True, if all the ports are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Check if the selected subspace map has a valid master bus interface reference. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return True, if the master bus interface reference is valid, false otherwise. + * @return True, if the master bus interface reference is valid, false otherwise. */ bool hasValidMasterReference(std::string const& itemName) const; /*! * Check if the selected subspace map has a valid segment reference. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return True, if the segment reference is valid, false otherwise. + * @return True, if the segment reference is valid, false otherwise. */ bool hasValidSegmentReference(std::string const& itemName) const; /*! * Add a new subspace map. * - * @param [in] row Row of the new subspace map. - * @param [in] newBlockName Name of the new subspace map. + * @param [in] row Row of the new subspace map. + * @param [in] newBlockName Name of the new subspace map. */ virtual void addBlock(int const& row, std::string const& newBlockName = std::string("")) override final; /*! * Get the expressions in the selected items. * - * @param [in] itemNames Names of the selected items. + * @param [in] itemNames Names of the selected items. * - * @return The expressions of the selected items. + * @return The expressions of the selected items. */ virtual std::vector getExpressionsInSelectedItems(std::vector const& itemNames) const override final; @@ -161,50 +161,50 @@ class KACTUS2_API SubspaceMapInterface : public MemoryBlockInterface /*! * Get the selected subspace map. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return The selected subspace map. + * @return The selected subspace map. */ QSharedPointer getSubspaceMap(std::string const& itemName) const; /*! * Get the subspace map with the selected name, sliced to a NameGroup. * - * @param [in] itemName Name of the selected subspace map. + * @param [in] itemName Name of the selected subspace map. * - * @return The sliced subspace map with the selected name. + * @return The sliced subspace map with the selected name. */ QSharedPointer getItem(std::string const& itemName) const override; /*! * Get the default name for a subspace map. * - * @return Default name for a subspace map. + * @return Default name for a subspace map. */ virtual std::string getDefaultName() const override final; /*! * Get a list of the copied subspace maps. * - * @param [in] selectedRows Rows of the copied subspace maps. + * @param [in] selectedRows Rows of the copied subspace maps. * - * @return List of the copied subspace maps. + * @return List of the copied subspace maps. */ virtual QList > getCopiedBlocks(std::vector const& selectedRows) const override final; /*! * Get the mime type of the subspace map. * - * @return The mime type of the subspace map. + * @return The mime type of the subspace map. */ virtual QString getMimeType() const override final; /*! * Create a copy of the selected subspace map. * - * @param [in] copiedItem The selected subspace map- + * @param [in] copiedItem The selected subspace map- * - * @return Copy of the selected subspace map. + * @return Copy of the selected subspace map. */ virtual QSharedPointer createCopyBlock(QSharedPointer copiedItem) const override final; @@ -212,16 +212,16 @@ class KACTUS2_API SubspaceMapInterface : public MemoryBlockInterface /*! * Count the subspace map items in the selected list. * - * @param [in] itemList List of subspace map items. + * @param [in] itemList List of subspace map items. * - * @return Number of subspace map items in the selected list. + * @return Number of subspace map items in the selected list. */ virtual int countItems(QList > itemList) const override final; /*! * Get the subspace map validator. * - * @return The subspace map validator. + * @return The subspace map validator. */ virtual QSharedPointer getValidator() const override final; diff --git a/KactusAPI/include/SystemVerilogExpressionParser.h b/KactusAPI/include/SystemVerilogExpressionParser.h index d8efb8813..3d530f6e4 100644 --- a/KactusAPI/include/SystemVerilogExpressionParser.h +++ b/KactusAPI/include/SystemVerilogExpressionParser.h @@ -39,37 +39,37 @@ class KACTUS2_API SystemVerilogExpressionParser : public ExpressionParser /*! * Parses an expression to decimal number. * - * @param [in] expression The expression to parse. - * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. + * @param [in] expression The expression to parse. + * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. * - * @return The decimal value of the evaluated expression. + * @return The decimal value of the evaluated expression. */ QString parseExpression(QStringView expression, bool* validExpression = nullptr) const override; /*! * Check if the given expression is an array. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is an array, otherwise false. + * @return True, if the expression is an array, otherwise false. */ virtual bool isArrayExpression(QStringView expression) const noexcept; /*! * Checks if the given expression is a plain value and does not need evaluation. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a plain value, otherwise false. + * @return True, if the expression is a plain value, otherwise false. */ bool isPlainValue(QStringView expression) const override; /*! * Finds the common base in the expression. * - * @param [in] expression The expression to search in. + * @param [in] expression The expression to search in. * - * @return The common base for the expression. + * @return The common base for the expression. */ int baseForExpression(QStringView expression) const override; @@ -78,64 +78,64 @@ class KACTUS2_API SystemVerilogExpressionParser : public ExpressionParser /*! * Parses a token to a decimal number or string. * - * @param [in] token The constant to parse. + * @param [in] token The constant to parse. * - * @return The decimal value of the constant or the given string. + * @return The decimal value of the constant or the given string. */ QString parseConstant(QStringView token) const; /*! * Checks if the given expression is a symbol e.g. reference. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a symbol, otherwise false. + * @return True, if the expression is a symbol, otherwise false. */ virtual bool isSymbol(QStringView expression) const; /*! * Finds the value for given symbol. * - * @param [in] symbol The symbol whose value to find. + * @param [in] symbol The symbol whose value to find. * - * @return The found symbol value. + * @return The found symbol value. */ virtual QString findSymbolValue(QStringView symbol) const; /*! * Finds the base in the symbol. * - * @param [in] symbol The symbol whose base to find. + * @param [in] symbol The symbol whose base to find. * - * @return The base for the symbol. + * @return The base for the symbol. */ virtual int getBaseForSymbol(QStringView symbol) const; /*! * Get the operator precedence value for the given operator. * - * @param [in] oper The operator whose precedence to get. + * @param [in] oper The operator whose precedence to get. * - * @return The precedence value where bigger value has higher precedence. + * @return The precedence value where bigger value has higher precedence. */ static unsigned int operatorPrecedence(QStringView oper); /*! * Checks if the given token is a unary operator. * - * @param [in] expression The token to check. + * @param [in] expression The token to check. * - * @return True, if the token is a unary operator, otherwise false. + * @return True, if the token is a unary operator, otherwise false. */ virtual bool isUnaryOperator(QStringView token) const; /*! * Solves a binary operation. * - * @param [in] operation The operation to solve. - * @param [in] term The term for the operation. + * @param [in] operation The operation to solve. + * @param [in] term The term for the operation. * - * @return The result of the operation. + * @return The result of the operation. */ virtual QString solveUnary(QStringView operation, QString const& term) const; @@ -145,66 +145,66 @@ class KACTUS2_API SystemVerilogExpressionParser : public ExpressionParser * Converts the given expression to Reverse Polish Notation (RPN) format. * RPN is used to ensure the operations are calculated in the correct precedence order. * - * @param [in] expression The expression to convert. + * @param [in] expression The expression to convert. * - * @return The conversion result. + * @return The conversion result. */ static QVector convertToRPN(QString& expression); /*! * Solves the given RPN expression. * - * @param [in] rpn The expression to solve. - * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. + * @param [in] rpn The expression to solve. + * @param [out] validExpression Set to true, if the parsing was successful, otherwise false. * - * @return The solved result. + * @return The solved result. */ QString solveRPN(QVector rpn, bool* validExpression) const; /*! * Checks if the given expression is a string. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a string, otherwise false. + * @return True, if the expression is a string, otherwise false. */ bool isStringLiteral(QStringView expression) const noexcept; /*! * Checks if the given expression is a numeric literal. * - * @param [in] expression The expression to check. + * @param [in] expression The expression to check. * - * @return True, if the expression is a literal, otherwise false. + * @return True, if the expression is a literal, otherwise false. */ bool isLiteral(QStringView expression) const; /*! * Checks if the given token is a binary operator. * - * @param [in] expression The token to check. + * @param [in] expression The token to check. * - * @return True, if the token is a binary operator, otherwise false. + * @return True, if the token is a binary operator, otherwise false. */ bool isBinaryOperator(QStringView token) const; /*! * Checks if the given token is a ternary operator. * - * @param [in] expression The token to check. + * @param [in] expression The token to check. * - * @return True, if the token is a ternary operator, otherwise false. + * @return True, if the token is a ternary operator, otherwise false. */ bool isTernaryOperator(QStringView token) const; /*! * Solves a Ternary operation. * - * @param [in] condition The selecting condition of the ternary operation. - * @param [in] trueCase The value for true condition. - * @param [in] falseCase The value for false condition. + * @param [in] condition The selecting condition of the ternary operation. + * @param [in] trueCase The value for true condition. + * @param [in] falseCase The value for false condition. * - * @return The result of the operation. + * @return The result of the operation. */ QString solveTernary(QStringView condition, QString const& trueCase, QString const& falseCase) const; @@ -212,47 +212,47 @@ class KACTUS2_API SystemVerilogExpressionParser : public ExpressionParser /*! * Solves a binary operation. * - * @param [in] operation The operation to solve. - * @param [in] leftTerm The first term of the operation. - * @param [in] rightTerm The second term of the operation. + * @param [in] operation The operation to solve. + * @param [in] leftTerm The first term of the operation. + * @param [in] rightTerm The second term of the operation. * - * @return The result of the operation. + * @return The result of the operation. */ QString solveBinary(QStringView operation, QString const& leftTerm, QString const& rightTerm) const; /*! * Solves the SystemVerilog $clog2 function. * - * @param [in] value The value for which the function is called. + * @param [in] value The value for which the function is called. * - * @return The solved value. + * @return The solved value. */ QString solveClog2(QString const& value) const; /*! * Solves the SystemVerilog $sqrt function. * - * @param [in] value The value for which the function is called. + * @param [in] value The value for which the function is called. * - * @return The solved value. + * @return The solved value. */ QString solveSqrt(QString const& value) const; /*! * Get the precision used from the term. * - * @param [in] term The first term of the operation. + * @param [in] term The first term of the operation. * - * @return The precision of the decimal used in the given term. + * @return The precision of the decimal used in the given term. */ static int precisionOf(QStringView term) noexcept; /*! * Get the base for a given number. * - * @param [in] constantNumber The selected number. + * @param [in] constantNumber The selected number. * - * @return The base for the selected number. Either 2, 8, 10 or 16. + * @return The base for the selected number. Either 2, 8, 10 or 16. */ static int baseOf(QStringView constantNumber); }; diff --git a/KactusAPI/include/TagManager.h b/KactusAPI/include/TagManager.h index b1812de2b..d40369831 100644 --- a/KactusAPI/include/TagManager.h +++ b/KactusAPI/include/TagManager.h @@ -33,21 +33,21 @@ class KACTUS2_API TagManager /*! * Add new tags from the selected list. * - * @param [in] newTags The selected list of new tags. + * @param [in] newTags The selected list of new tags. */ void addNewTags(QVector newTags); /*! * Set new tags. * - * @param [in] newTags The selected list of new tags. + * @param [in] newTags The selected list of new tags. */ void setTags(QVector newTags); /*! * Get a list of the active tags. * - * @return List of the active tags. + * @return List of the active tags. */ QVector getTags() const; @@ -59,7 +59,7 @@ class KACTUS2_API TagManager /*! * Get the singleton instance of the tag manager. * - * @return The tag manager instance. + * @return The tag manager instance. */ static TagManager& getInstance(); @@ -76,9 +76,9 @@ class KACTUS2_API TagManager /*! * Check if the selected tag exists in the list. * - * @param [in] tag The selected tag. + * @param [in] tag The selected tag. * - * @return True, if the selected tag exists in the list, false otherwise. + * @return True, if the selected tag exists in the list, false otherwise. */ bool tagExists(TagData const& tag) const; diff --git a/KactusAPI/include/TransparentBridgeInterface.h b/KactusAPI/include/TransparentBridgeInterface.h index ac1f7c1a8..7fdfc910a 100644 --- a/KactusAPI/include/TransparentBridgeInterface.h +++ b/KactusAPI/include/TransparentBridgeInterface.h @@ -33,8 +33,8 @@ class KACTUS2_API TransparentBridgeInterface : public ParameterizableInterface, /*! * The constructor. * - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. */ TransparentBridgeInterface(QSharedPointer expressionParser, QSharedPointer expressionFormatter); @@ -47,132 +47,132 @@ class KACTUS2_API TransparentBridgeInterface : public ParameterizableInterface, /*! * Setup the transparent bridges. * - * @param [in] newBridges The new transparent bridges. + * @param [in] newBridges The new transparent bridges. */ void setBridges(QSharedPointer > > newBridges); /*! * Get index of the transparent bridge containing the selected master bus interface reference. * - * @param [in] masterReference The selected master bus interface reference. + * @param [in] masterReference The selected master bus interface reference. * - * @return Index of the selected transparent bridge. + * @return Index of the selected transparent bridge. */ int getItemIndex(std::string const& masterReference) const; /*! * Get master bus interface reference of the indexed transparent bridge. * - * @param [in] itemIndex Index of the selected transparent bridge. + * @param [in] itemIndex Index of the selected transparent bridge. * - * @return Master bus interface reference of the selected transparent bridge. + * @return Master bus interface reference of the selected transparent bridge. */ std::string getIndexedMasterReference(int const& itemIndex) const; /*! * Get the number of available transparent bridges. * - * @return Number of available transparent bridges. + * @return Number of available transparent bridges. */ virtual int itemCount() const override final; /*! * Get the master bus interface references of the available transparent bridges. * - * @return Master bus interface references of the available ports abstractions. + * @return Master bus interface references of the available ports abstractions. */ virtual std::vector getItemNames() const override final; /*! * Set a new master bus interface reference for the selected transparent bridge. * - * @param [in] currentMaster Master bus interface reference of the selected transparent bridge. - * @param [in] newMaster New master bus interface reference for the selected transparent bridge. + * @param [in] currentMaster Master bus interface reference of the selected transparent bridge. + * @param [in] newMaster New master bus interface reference for the selected transparent bridge. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setMasterReference(std::string const& currentMaster, std::string const& newMaster); /*! * Validates the contained transparent bridges. * - * @return True, if all the transparent bridges are valid, false otherwise. + * @return True, if all the transparent bridges are valid, false otherwise. */ virtual bool validateItems() const override final; /*! * Get the calculated is present value of the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. - * @param [in] baseNumber Base for displaying the value. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] baseNumber Base for displaying the value. * - * @return Calculated is present value of the selected transparent bridge. + * @return Calculated is present value of the selected transparent bridge. */ std::string getIsPresentValue(std::string const& masterReference, int const& baseNumber = 0) const; /*! * Get the formatted is present expression of the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. * - * @return Formatted is present expression of the selected transparent bridge. + * @return Formatted is present expression of the selected transparent bridge. */ std::string getIsPresentFormattedExpression(std::string const& masterReference) const; /*! * Get the is present expression of the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. * - * @return Is present expression of the selected transparent bridge. + * @return Is present expression of the selected transparent bridge. */ std::string getIsPresentExpression(std::string const& masterReference) const; /*! * Set the is present expression for the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. - * @param [in] newIsPresent New is present expression. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] newIsPresent New is present expression. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool setIsPresent(std::string const& masterReference, std::string const& newIsPresent); /*! * Add a new transparent bridge. * - * @param [in] bridgeIndex Index of the new transparent bridge. - * @param [in] bridgeName Master bus interface reference of the new transparent bridge. + * @param [in] bridgeIndex Index of the new transparent bridge. + * @param [in] bridgeName Master bus interface reference of the new transparent bridge. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addBridge(int const& bridgeIndex, std::string const& bridgeName = "") const; /*! * Remove the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeTransparentBridge(std::string const& masterReference); /*! * Get all the references made to the selected ID in the selected transparent bridge. * - * @param [in] itemName Master bus interface reference of the selected transparent bridge. - * @param [in] valueID The selected ID. + * @param [in] itemName Master bus interface reference of the selected transparent bridge. + * @param [in] valueID The selected ID. * - * @return Number of references made to the selected ID. + * @return Number of references made to the selected ID. */ virtual int getAllReferencesToIdInItem(const std::string& itemName, std::string const& valueID) const; /*! * Get all the expressions from the selected transparent bridge. * - * @param [in] masterReference Master reference of the selected transparent bridge. + * @param [in] masterReference Master reference of the selected transparent bridge. * - * @return List of expressions in the selected transparent bridge. + * @return List of expressions in the selected transparent bridge. */ std::vector getAllExpressions(std::string const& masterReference) const; @@ -185,9 +185,9 @@ class KACTUS2_API TransparentBridgeInterface : public ParameterizableInterface, /*! * Get the selected transparent bridge. * - * @param [in] masterReference Master bus interface reference of the selected transparent bridge. + * @param [in] masterReference Master bus interface reference of the selected transparent bridge. * - * @return The selected transparent bridge. + * @return The selected transparent bridge. */ QSharedPointer getTransparentBridge(std::string const& masterReference) const; diff --git a/KactusAPI/include/hierarchyitem.h b/KactusAPI/include/hierarchyitem.h index 0f58d8841..c03bb0534 100644 --- a/KactusAPI/include/hierarchyitem.h +++ b/KactusAPI/include/hierarchyitem.h @@ -58,11 +58,11 @@ class KACTUS2_API HierarchyItem : public QObject /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this object. - * @param [in] vlnv The vlnv to construct the item for. - * @param [in] implementation The implementation attribute needed by designs. - * @param [in] viewName The name of the view the design belongs to. + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this object. + * @param [in] vlnv The vlnv to construct the item for. + * @param [in] implementation The implementation attribute needed by designs. + * @param [in] viewName The name of the view the design belongs to. */ HierarchyItem(LibraryInterface* handler, HierarchyItem* parent, VLNV const& vlnv, KactusAttribute::Implementation implementation = KactusAttribute::KTS_IMPLEMENTATION_COUNT, @@ -72,8 +72,8 @@ class KACTUS2_API HierarchyItem : public QObject * * This constructor should only be used to create the root item and no other hierarchy items. * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this item. + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this item. */ HierarchyItem(LibraryInterface* handler, QObject* parent); @@ -84,20 +84,20 @@ class KACTUS2_API HierarchyItem : public QObject * * This function should only be called for the root item to create the tree. * - * @param [in] vlnv Identifies the component to represent. + * @param [in] vlnv Identifies the component to represent. */ void createChild(const VLNV& vlnv); /*! Get the parent of this item. * - * @return The parent of this item + * @return The parent of this item */ HierarchyItem* parent() const; /*! Get the vlnv of this item. * - * @return VLNV of the component this item represents. + * @return VLNV of the component this item represents. */ VLNV const& getVLNV() const; @@ -105,56 +105,56 @@ class KACTUS2_API HierarchyItem : public QObject * * If child with given index does not exist then return null pointer. * - * @param [in] index Row number of the child that's pointer is wanted. + * @param [in] index Row number of the child that's pointer is wanted. * - * @return HierarchyItem* + * @return HierarchyItem* */ HierarchyItem* child(int index) const; /*! Get the row number of this item on this item's parent. * - * @return The row number. + * @return The row number. */ int row(); /*! Get the number of children this item has. * - * @return The number of child items this item has. + * @return The number of child items this item has. */ int getNumberOfChildren() const; /*! Get the index of specified item. * - * @param [in] item The HierarchyItem that's row number is requested. + * @param [in] item The HierarchyItem that's row number is requested. * - * @return The row number of given item. Returns -1 if item is not found. + * @return The row number of given item. Returns -1 if item is not found. */ int getIndexOf(HierarchyItem* item); /*! Check if this item has children or not. * - * @return True if at least one child item exists. + * @return True if at least one child item exists. */ bool hasChildren() const; /*! Check if this item is valid or not. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const; /*! Set the validity of this item. * - * @param [in] valid Sets the valid value of the item. + * @param [in] valid Sets the valid value of the item. * */ void setValidity(bool valid); /*! Checks if the component or one of it's sub-components contains the vlnv. * - * @param [in] vlnv The vlnv that is searched in hierarchy. + * @param [in] vlnv The vlnv that is searched in hierarchy. * - * @return bool True if the vlnv is found. + * @return bool True if the vlnv is found. */ bool contains(const VLNV& vlnv) const; @@ -162,13 +162,13 @@ class KACTUS2_API HierarchyItem : public QObject * * Note: This function should be called only for the root item. * - * @return void + * @return void */ void cleanUp(); /*! Get pointer to the component that this item represents * - * @return QSharedPointer The component model. + * @return QSharedPointer The component model. */ QSharedPointer component() const; @@ -178,9 +178,9 @@ class KACTUS2_API HierarchyItem : public QObject * if same sub-component is instantiated in several components. If count that * contains only unique owners then you should use getOwners(). * - * @param [in] vlnv Identifies the component that's instances are searched. + * @param [in] vlnv Identifies the component that's instances are searched. * - * @return Number of found instances. + * @return Number of found instances. */ int referenceCount(const VLNV& vlnv) const; @@ -188,32 +188,32 @@ class KACTUS2_API HierarchyItem : public QObject * * This function makes sure each owner is appended to the list only once. * - * @param [out] list QList where owner vlnvs is appended. - * @param [in] vlnvToSearch The vlnv to that's parents are wanted. + * @param [out] list QList where owner vlnvs is appended. + * @param [in] vlnvToSearch The vlnv to that's parents are wanted. * - * @return Number of unique owners found. + * @return Number of unique owners found. */ int getOwners(QList& list, const VLNV& vlnvToSearch) const; /*! Remove the child items with given vlnv. * - * @param [in] vlnv Identifies the items to remove. + * @param [in] vlnv Identifies the items to remove. * - * @return Amount of child items removed from this item. + * @return Amount of child items removed from this item. */ int removeItems(const VLNV& vlnv); /*! Find the hierarchyItems that represent the given vlnv. * - * @param [in] vlnv Identifies the items. + * @param [in] vlnv Identifies the items. * - * @return QList contains pointers to the hierarchy items. + * @return QList contains pointers to the hierarchy items. */ QVector findItems(const VLNV& vlnv); /*! Update hierarchy items with given vlnv. * - * @param [in] vlnv Identifies the objects to update. + * @param [in] vlnv Identifies the objects to update. * */ void updateItems(const VLNV& vlnv); @@ -223,41 +223,41 @@ class KACTUS2_API HierarchyItem : public QObject * Function does not just search the direct parent but the whole parent-chain * up to the root item. * - * @param [in] vlnv Identifies the parent to search. + * @param [in] vlnv Identifies the parent to search. * - * @return bool True if parent with given vlnv is found. + * @return bool True if parent with given vlnv is found. */ bool hasParent(const VLNV& vlnv); /*! Check if the parent of this item is the root item. * - * @return bool true if the parent item is root item. If this is the root or + * @return bool true if the parent item is root item. If this is the root or * parent is normal item then returns false. */ bool parentIsRoot() const; /*! Check if this is the root item or not. * - * @return bool True if this is the root item. + * @return bool True if this is the root item. */ bool isRoot() const; /*! Check if this item is instantiated in some item or not. * - * @return bool true if item is contained as some item's child. + * @return bool true if item is contained as some item's child. */ bool isDuplicate() const; /*! Set the duplicate value for this item. * - * @param [in] isDuplicate If true then this item is set as duplicate. + * @param [in] isDuplicate If true then this item is set as duplicate. * */ void setDuplicate(bool isDuplicate); /*! Get the list of vlnvs this item and it's parents contain. * - * @return QList contains the list of vlnvs + * @return QList contains the list of vlnvs */ QVector getVLNVs() const; @@ -268,7 +268,7 @@ class KACTUS2_API HierarchyItem : public QObject /*! Checks if the component this item represents is hierarchical or not. * - * @return bool true if the component is hierarchical. + * @return bool true if the component is hierarchical. */ bool isHierarchical() const; @@ -276,13 +276,13 @@ class KACTUS2_API HierarchyItem : public QObject * * Note: This function can only be called for items of type component. * - * @return KactusAttribute::Implementation Specifies the implementation. + * @return KactusAttribute::Implementation Specifies the implementation. */ KactusAttribute::Implementation getImplementation() const; /*! Get the type of this hierarchy item. * - * @return ObjectType defines the type of the item. + * @return ObjectType defines the type of the item. */ ObjectType type() const; @@ -290,15 +290,15 @@ class KACTUS2_API HierarchyItem : public QObject * * This function must only be called to the root item. * - * @param [in] childList The list where the vlnvs of the children are appended. - * @param [in] owner Identifies the object that's children are searched. + * @param [in] childList The list where the vlnvs of the children are appended. + * @param [in] owner Identifies the object that's children are searched. * */ void getChildren(QList& childList, const VLNV& owner) const; /*! Get the vlnvs of the items that are this item's children. * - * @param [in] itemList The list where the vlnvs are appended to. + * @param [in] itemList The list where the vlnvs are appended to. * */ void getChildItems(QList& itemList) const; @@ -307,7 +307,7 @@ class KACTUS2_API HierarchyItem : public QObject * * For items that are not components this function returns -1 * - * @return The instance count in the containing design. + * @return The instance count in the containing design. */ int instanceCount() const; @@ -315,7 +315,7 @@ class KACTUS2_API HierarchyItem : public QObject * * If type() is other than design an empty string is returned. * - * @return QString containing the view name. + * @return QString containing the view name. */ QString getViewName() const; @@ -331,9 +331,9 @@ class KACTUS2_API HierarchyItem : public QObject /*! Count the number of instances for the given vlnv. * - * @param [in] componentVLNV The vlnv of the component that's instance count is counted. + * @param [in] componentVLNV The vlnv of the component that's instance count is counted. * - * @return The number of instantiation times. + * @return The number of instantiation times. */ int countInstances(const VLNV& componentVLNV); @@ -346,15 +346,15 @@ class KACTUS2_API HierarchyItem : public QObject /*! Checks if this HierarchyItem already has child for given vlnv. * - * @param [in] vlnv Identifies the child. + * @param [in] vlnv Identifies the child. * - * @return bool True if child with given vlnv is found. + * @return bool True if child with given vlnv is found. */ bool hasChild(const VLNV& vlnv); /*! Parse this hierarchy item to match a component * - * @param [in] vlnv The vlnv of the component. + * @param [in] vlnv The vlnv of the component. * */ void parseComponent(const VLNV& vlnv); @@ -364,69 +364,69 @@ class KACTUS2_API HierarchyItem : public QObject /*! * Finds the referenced design in a component view. * - * @param [in] view The view whose reference to find. + * @param [in] view The view whose reference to find. * - * @return The design referenced in the view. + * @return The design referenced in the view. */ VLNV findDesignReference(QSharedPointer view); /*! * Creates a child item for the given design. * - * @param [in] designVLNV The design to represent with the child. - * @param [in] implementation The implementation type of the design. - * @param [in] viewName The name of the view referencing the design. + * @param [in] designVLNV The design to represent with the child. + * @param [in] implementation The implementation type of the design. + * @param [in] viewName The name of the view referencing the design. */ void createChildItemForDesign(VLNV const& designVLNV, QString const& viewName); /*! Parse this hierarchy item to match a bus definition. * - * @param [in] vlnv The vlnv of the bus definition. + * @param [in] vlnv The vlnv of the bus definition. * */ void parseBusDefinition(const VLNV& vlnv); /*! Parse this hierarchy item to match an abstraction definition. * - * @param [in] vlnv The vlnv of the abstraction definition. + * @param [in] vlnv The vlnv of the abstraction definition. * */ void parseAbsDefinition(const VLNV& vlnv); /*! Parse this hierarchy item to match a COM definition. * - * @param [in] vlnv The vlnv of the COM definition. + * @param [in] vlnv The vlnv of the COM definition. * */ void parseComDefinition(const VLNV& vlnv); /*! Parse this hierarchy item to match an API definition. * - * @param [in] vlnv The vlnv of the API definition. + * @param [in] vlnv The vlnv of the API definition. * */ void parseApiDefinition(const VLNV& vlnv); /*! Parse this hierarchy item to match a design. * - * @param [in] vlnv The vlnv of the design. + * @param [in] vlnv The vlnv of the design. */ void parseDesign(const VLNV& vlnv, KactusAttribute::Implementation implementation, QString const& viewName); /*! * Finds the valid component references in a design item. * - * @return The valid VLVN references. + * @return The valid VLVN references. */ QVector getValidComponentsInDesign(QSharedPointer design); /*! * Checks if the given VLNV reference to a component is valid. * - * @param [in] componentVLNV The VLNV to check. + * @param [in] componentVLNV The VLNV to check. * - * @return True, if the VLVN reference is valid, otherwise false. + * @return True, if the VLVN reference is valid, otherwise false. */ bool isValidComponentInstanceVLNV(VLNV const& componentVLNV); diff --git a/KactusAPI/include/hierarchymodel.h b/KactusAPI/include/hierarchymodel.h index 02577a174..25da71a5f 100644 --- a/KactusAPI/include/hierarchymodel.h +++ b/KactusAPI/include/hierarchymodel.h @@ -41,8 +41,8 @@ class KACTUS2_API HierarchyModel : public QAbstractItemModel /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this model. + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this model. */ HierarchyModel(LibraryInterface* handler, QObject* parent); @@ -51,79 +51,79 @@ class KACTUS2_API HierarchyModel : public QAbstractItemModel /*! Get the data for the headers of this model. * - * @param [in] section Specifies the column of the header. - * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. - * @param [in] role Specifies the role of the data. + * @param [in] section Specifies the column of the header. + * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. + * @param [in] role Specifies the role of the data. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the number of columns in this model * - * @param [in] parent Model index identifying the item that's column count is + * @param [in] parent Model index identifying the item that's column count is * wanted. * - * @return Number of columns. + * @return Number of columns. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of rows an item has. * - * @param [in] parent Model index identifying the item that's row count is wanted + * @param [in] parent Model index identifying the item that's row count is wanted * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ virtual QModelIndex index(int row, int column, QModelIndex const& parent = QModelIndex()) const; /*! Get the model index of the parent of the object * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelIndex that identifies the parent of the given object. + * @return QModelIndex that identifies the parent of the given object. */ virtual QModelIndex parent(QModelIndex const& child) const; /*! Get the data associated with given object. * - * @param [in] index Model index that identifies the object that's data is wanted. - * @param [in] role Specifies the type of data wanted. + * @param [in] index Model index that identifies the object that's data is wanted. + * @param [in] role Specifies the type of data wanted. * - * @return QVariant Containing the requested data. + * @return QVariant Containing the requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Does the specified item have child items or not. * - * @param [in] parent Model index identifying the object that's children are asked. + * @param [in] parent Model index identifying the object that's children are asked. * - * @return True if object has child objects. + * @return True if object has child objects. */ virtual bool hasChildren(QModelIndex const& parent = QModelIndex()) const; /*! Get the flags that identify possible methods for given object. * - * @param [in] index Model index identifying the object that's flags are requested. + * @param [in] index Model index identifying the object that's flags are requested. * - * @return Qt::ItemFlags that specify how the object can be handled. + * @return Qt::ItemFlags that specify how the object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Create a model index for a library item * - * @param [in] item The LibraryItem that's model index is wanted + * @param [in] item The LibraryItem that's model index is wanted * - * @return QModelIndex that identifies the libraryItem. + * @return QModelIndex that identifies the libraryItem. */ QModelIndex index(HierarchyItem* item) const; @@ -133,9 +133,9 @@ class KACTUS2_API HierarchyModel : public QAbstractItemModel * if same sub-component is instantiated in several components. If count that * contains only unique owners then you should use getOwners(). * - * @param [in] vlnv Identifies the component that's instances are searched. + * @param [in] vlnv Identifies the component that's instances are searched. * - * @return Number of found instances. + * @return Number of found instances. */ int referenceCount(VLNV const& vlnv) const; @@ -143,26 +143,26 @@ class KACTUS2_API HierarchyModel : public QAbstractItemModel * * This function makes sure each owner is appended to the list only once. * - * @param [out] list QList where the search results are appended. - * @param [in] vlnvToSearch Identifies the component to search for. + * @param [out] list QList where the search results are appended. + * @param [in] vlnvToSearch Identifies the component to search for. * - * @return Number of owners found. + * @return Number of owners found. * */ virtual int getOwners(QList& list, VLNV const& vlnvToSearch) const; /*! Find model indexes of items that represent given vlnv. * - * @param [in] vlnv Identifies the objects to search for. + * @param [in] vlnv Identifies the objects to search for. * - * @return QModelIndexList contains indexes of items with given vlnv. + * @return QModelIndexList contains indexes of items with given vlnv. */ QModelIndexList findIndexes(VLNV const& vlnv); /*! Get the child items of given object. * - * @param [out] childList The list where the vlnvs of the children are appended. - * @param [in] owner Identifies the object that's children are searched. + * @param [out] childList The list where the vlnvs of the children are appended. + * @param [in] owner Identifies the object that's children are searched. * */ void getChildren(QList& childList, VLNV const& owner) const; @@ -209,7 +209,7 @@ public slots: * * Function updates the hierarchical model so that changes made to the document are visible. * - * @param [in] vlnv Identifies the document that changed. + * @param [in] vlnv Identifies the document that changed. */ void onDocumentUpdated(VLNV const& vlnv); diff --git a/Plugins/AlteraBSPGenerator/alterabspgenerator.h b/Plugins/AlteraBSPGenerator/alterabspgenerator.h index 9e83a2f5f..487e14bca 100644 --- a/Plugins/AlteraBSPGenerator/alterabspgenerator.h +++ b/Plugins/AlteraBSPGenerator/alterabspgenerator.h @@ -98,12 +98,12 @@ class ALTERABSPGENERATOR_EXPORT AlteraBSPGenerator : public QObject, public IGen /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -113,11 +113,11 @@ class ALTERABSPGENERATOR_EXPORT AlteraBSPGenerator : public QObject, public IGen * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -132,10 +132,10 @@ class ALTERABSPGENERATOR_EXPORT AlteraBSPGenerator : public QObject, public IGen /*! * Parse the entries in the file system and add them to specified file set. * - * @param [in] entry The entry to add. - * @param [in] xmlPath Path to the top component xml file. - * @param [in] fileSet The file set to add the entries to. - * @param [in] settings Contains the file type settings. + * @param [in] entry The entry to add. + * @param [in] xmlPath Path to the top component xml file. + * @param [in] fileSet The file set to add the entries to. + * @param [in] settings Contains the file type settings. */ void addEntry(const QFileInfo &entry, const QString& xmlPath, QSharedPointer fileSet, QSettings& settings); diff --git a/Plugins/CppSourceAnalyzer/CppSourceAnalyzer.h b/Plugins/CppSourceAnalyzer/CppSourceAnalyzer.h index 677f4686d..1a3a6d867 100644 --- a/Plugins/CppSourceAnalyzer/CppSourceAnalyzer.h +++ b/Plugins/CppSourceAnalyzer/CppSourceAnalyzer.h @@ -88,9 +88,9 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Calculates a language-dependent hash for the given file. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. * - * @return The hash value for the file. + * @return The hash value for the file. * * @remarks Comments and whitespace are ignored and do not affect the hash value. */ @@ -99,8 +99,8 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Begins the analysis for the given component. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any preparations needed for the file dependency analysis should be made here. */ @@ -109,8 +109,8 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Ends the analysis for the given component. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any cleanups needed should be made here. */ @@ -119,10 +119,10 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Retrieves all file dependencies the given file has. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. - * @param [in] filename The name of the file to which the analysis is run. - * @param [out] dependencies The list of found dependencies. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. + * @param [in] filename The name of the file to which the analysis is run. + * @param [out] dependencies The list of found dependencies. */ virtual QList getFileDependencies(Component const* component, QString const& componentPath, @@ -135,9 +135,9 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin * * Reads source file data from given file. Used by calulateHash and getFileDependencies. * - * @param [in] file The file that is read. + * @param [in] file The file that is read. * - * @return The meaningful source data of the file, with comments and empty lines removed. + * @return The meaningful source data of the file, with comments and empty lines removed. */ QString getSourceData(QFile& file); @@ -148,9 +148,9 @@ class CppSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin * * Removes comments from a string that consists of a C/C++ source code * - * @param [inout] data The input source code with comments. + * @param [inout] data The input source code with comments. * - * @return The meaningful source data of the file, with comments removed. + * @return The meaningful source data of the file, with comments removed. */ QString removeComments(QString const& source); diff --git a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDelegate.h b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDelegate.h index 63a4914b9..bd42bf3ab 100644 --- a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDelegate.h +++ b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDelegate.h @@ -36,9 +36,9 @@ class LinuxDeviceTreeCPUDelegate : public QStyledItemDelegate /*! * Renders an item in the given index. * - * @param [in] painter The painter to use for rendering. - * @param [in] option The style options for the rendering. - * @param [in] index The index to the data being rendered. + * @param [in] painter The painter to use for rendering. + * @param [in] option The style options for the rendering. + * @param [in] index The index to the data being rendered. */ virtual void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -51,12 +51,12 @@ class LinuxDeviceTreeCPUDelegate : public QStyledItemDelegate /*! * Handler for preprocessing events that starts editing. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the delegate handles the event, otherwise false. + * @return True, if the delegate handles the event, otherwise false. */ virtual bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDetails.h b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDetails.h index c42f6bfca..4eff95327 100644 --- a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDetails.h +++ b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUDetails.h @@ -44,12 +44,12 @@ namespace LinuxDeviceTreeCPUDetails /*! * Get containers for combined CPUs and interfaces. * - * @param [in] fileName Default file name for the containers. - * @param [in] topComponent The top level component. - * @param [in] viewName Name of the top level view. - * @param [in] library The library interface. + * @param [in] fileName Default file name for the containers. + * @param [in] topComponent The top level component. + * @param [in] viewName Name of the top level view. + * @param [in] library The library interface. * - * @return Containers containing combined CPUs and interfaces. + * @return Containers containing combined CPUs and interfaces. */ QVector > getCPUContainers(QString const& fileName, QSharedPointer topComponent, @@ -59,10 +59,10 @@ namespace LinuxDeviceTreeCPUDetails /*! * Get the component containing the selected interface. * - * @param [in] interfaceNode The selected interface. - * @param [in] library The library interface. + * @param [in] interfaceNode The selected interface. + * @param [in] library The library interface. * - * @return Component containing the selected interface. + * @return Component containing the selected interface. */ QSharedPointer getComponentContainingInterface( QSharedPointer interfaceNode, LibraryInterface* library); @@ -71,11 +71,11 @@ namespace LinuxDeviceTreeCPUDetails /*! * Get the memory data of the selected interface. * - * @param [in] deviceTreeContainer Container for the tree structure of a device tree interface. - * @param [in] baseAddress Currently active base address. - * @param [in] memoryItemRange Currently active range. + * @param [in] deviceTreeContainer Container for the tree structure of a device tree interface. + * @param [in] baseAddress Currently active base address. + * @param [in] memoryItemRange Currently active range. * - * @return List of memory data connected to the selected interface. + * @return List of memory data connected to the selected interface. */ QVector getMemories(QSharedPointer deviceTreeContainer, quint64 baseAddress, @@ -84,9 +84,9 @@ namespace LinuxDeviceTreeCPUDetails /*! * Check if the selected interface contains memory data. * - * @param [in] memoryInterface The selected interface. + * @param [in] memoryInterface The selected interface. * - * @return True, if the selected interface contains memory data, false otherwise. + * @return True, if the selected interface contains memory data, false otherwise. */ bool interfacedItemIsMemory(QSharedPointer memoryInterface); } diff --git a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUEditor.h b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUEditor.h index 8d2f55d00..28a762d71 100644 --- a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUEditor.h +++ b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUEditor.h @@ -32,7 +32,7 @@ class LinuxDeviceTreeCPUEditor : public QWidget /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ LinuxDeviceTreeCPUEditor(QWidget *parent = 0); @@ -44,14 +44,14 @@ class LinuxDeviceTreeCPUEditor : public QWidget /*! * Setup the selected CPU containers. * - * @param [in] cpuDetails The selected CPU containers. + * @param [in] cpuDetails The selected CPU containers. */ void setupCPUDetails(QVector > cpuDetails); /*! * Get the selected CPU containers. * - * @return The selected CPU containers. + * @return The selected CPU containers. */ QVector > getAcceptedContainers() const; diff --git a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUModel.h b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUModel.h index 8e3b198ff..1b0c67208 100644 --- a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUModel.h +++ b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCPUModel.h @@ -31,7 +31,7 @@ class LinuxDeviceTreeCPUModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ LinuxDeviceTreeCPUModel(QObject *parent); @@ -43,73 +43,73 @@ class LinuxDeviceTreeCPUModel : public QAbstractTableModel /*! * Setup the selected CPU containers. * - * @param [in] cpuDetails The selected CPU containers. + * @param [in] cpuDetails The selected CPU containers. */ void setupCPUDetails(QVector > cpuDetails); /*! * Get the selected CPU containers. * - * @return List of CPU containers that should be written into files. + * @return List of CPU containers that should be written into files. */ QVector > getCPUDetails() const; /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -122,18 +122,18 @@ class LinuxDeviceTreeCPUModel : public QAbstractTableModel /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the tooltip value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The tooltip data in the given index. + * @return The tooltip data in the given index. */ QVariant tooltipForIndex(QModelIndex const& index) const; diff --git a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCpuRoutesContainer.h b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCpuRoutesContainer.h index 3ff29ed04..8746f1208 100644 --- a/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCpuRoutesContainer.h +++ b/Plugins/LinuxDeviceTree/CPUSelection/LinuxDeviceTreeCpuRoutesContainer.h @@ -39,7 +39,7 @@ class LinuxDeviceTreeCpuRoutesContainer : public CpuRoutesContainer /*! * The constructor. * - * @param [in] CPU The CPU. + * @param [in] CPU The CPU. */ LinuxDeviceTreeCpuRoutesContainer(); @@ -51,63 +51,63 @@ class LinuxDeviceTreeCpuRoutesContainer : public CpuRoutesContainer /*! * Copy constructor. * - * @param [in] other The original to be copied. + * @param [in] other The original to be copied. */ LinuxDeviceTreeCpuRoutesContainer(const CpuRoutesContainer& other); /*! * Get the contained CPUs. * - * @return The contained CPUs. + * @return The contained CPUs. */ QVector > getCpus() const; /*! * Set the contained CPUs. * - * @param [in] newCpu The new CPUs. + * @param [in] newCpu The new CPUs. */ void setCpus(QVector > newCpus); /*! * Add a new connected CPU. * - * @param [in] newCpu The new CPU. + * @param [in] newCpu The new CPU. */ void addCpu(QSharedPointer newCpu); /*! * Get the file path. * - * @return The file path. + * @return The file path. */ QString getFilePath() const; /*! * Set the file path. * - * @param [in] newFilePath The new file path. + * @param [in] newFilePath The new file path. */ void setFilePath(QString const& newFilePath); /*! * Get a list of the interface trees connected to this container. * - * @return List of interface trees connected to this container. + * @return List of interface trees connected to this container. */ QVector > getDeviceTreeRoutes() const; /*! * Set the connected interface trees for this container. * - * @param [in] newContainers The new connected interface trees. + * @param [in] newContainers The new connected interface trees. */ virtual void setRoutes(QVector > newContainers) override final; /*! * Add a new connected interface tree for this container. * - * @param [in] newContainer The new connected interface tree. + * @param [in] newContainer The new connected interface tree. */ virtual void addRoute(QSharedPointer newContainer) override final; @@ -120,24 +120,24 @@ class LinuxDeviceTreeCpuRoutesContainer : public CpuRoutesContainer /*! * Set up the device tree route containers. * - * @param [in] newRouteContainers List of the CPU route containers. + * @param [in] newRouteContainers List of the CPU route containers. */ void setupDeviceTreeRoutes(QVector > newRouteContainers); /*! * Set up a single device tree route container. * - * @param [in] routeContainers The CPU route container. + * @param [in] routeContainers The CPU route container. */ void setupSingleDeviceTreeRoute(QSharedPointer routeContainer); /*! * Get the device tree route container for the selected interface route. * - * @param [in] route The selected route. - * @param [in] treeRoutes List of the available device tree route containers. + * @param [in] route The selected route. + * @param [in] treeRoutes List of the available device tree route containers. * - * @return The device tree route container containing the selected interface route. + * @return The device tree route container containing the selected interface route. */ QSharedPointer getDeviceTreeForRoute( QVector > route, @@ -146,10 +146,10 @@ class LinuxDeviceTreeCpuRoutesContainer : public CpuRoutesContainer /*! * Get the device tree route container for the selected interface. * - * @param [in] interfaceNode The selected interface. - * @param [in] treeContainers List of available device tree route containers. + * @param [in] interfaceNode The selected interface. + * @param [in] treeContainers List of available device tree route containers. * - * @return The device tree route container containing the selected interface. + * @return The device tree route container containing the selected interface. */ QSharedPointer getDeviceTreeContainerForInterface( QSharedPointer interfaceNode, diff --git a/Plugins/LinuxDeviceTree/LinuxDeviceTreeDialog.h b/Plugins/LinuxDeviceTree/LinuxDeviceTreeDialog.h index 1a3675a24..954cb030e 100644 --- a/Plugins/LinuxDeviceTree/LinuxDeviceTreeDialog.h +++ b/Plugins/LinuxDeviceTree/LinuxDeviceTreeDialog.h @@ -48,7 +48,7 @@ class LinuxDeviceTreeDialog: public QDialog * @param [in] defaultPath The default path for the Linux Device Tree file. * @param [in] component The top component of the selected design. * @param [in] design The selected design. - * @param [in] library The library interface. + * @param [in] library The library interface. * @param [in] parent Parent item for the dialog. */ LinuxDeviceTreeDialog(QString const& defaultPath, QSharedPointer component, @@ -69,35 +69,35 @@ class LinuxDeviceTreeDialog: public QDialog /*! * Get the top component view from which the device tree file is constructed from. * - * @return The name of the selected view. + * @return The name of the selected view. */ QString getSelectedView() const; /*! * Check if the file should be saved to a file set. * - * @return True, if the file should be saved to a file set, false otherwise. + * @return True, if the file should be saved to a file set, false otherwise. */ bool saveFileToFileSet() const; /*! * Get the name of the file set where to save the file to. * - * @return The name of the selected file set. + * @return The name of the selected file set. */ QString getTargetFileSet() const; /*! * Check if address blocks should be written. * - * @return True, if address blocks should be written, false otherwise. + * @return True, if address blocks should be written, false otherwise. */ bool allowAddressBlocks() const; /*! * Get the list of the selected CPU containers. * - * @return List of the selected CPU containers. + * @return List of the selected CPU containers. */ QVector > getAcceptedContainers() const; @@ -118,7 +118,7 @@ private slots: /*! * Setup the CPU editor. * - * @param [in] view Name of the active view. + * @param [in] view Name of the active view. */ void setupCPUEditor(QString const& view); @@ -147,7 +147,7 @@ private slots: * Get the name of the design referenced by the currently active view. * * - * @return + * @return */ QString getDesignName(); diff --git a/Plugins/LinuxDeviceTree/LinuxDeviceTreeGenerator.h b/Plugins/LinuxDeviceTree/LinuxDeviceTreeGenerator.h index 3a66c2a3f..841acb5c5 100644 --- a/Plugins/LinuxDeviceTree/LinuxDeviceTreeGenerator.h +++ b/Plugins/LinuxDeviceTree/LinuxDeviceTreeGenerator.h @@ -42,7 +42,7 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * The Constructor. * - * @param [in] library Interface to the library. + * @param [in] library Interface to the library. */ LinuxDeviceTreeGenerator(LibraryInterface* library); @@ -54,11 +54,11 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Generates the linux device tree. * - * @param [in] topComponent The top component in the hierarchy to generate listing for. - * @param [in] activeView The active view for the generation. - * @param [in] writeAddressBlocks Flag for writing address block data. - * @param [in] cpuContainers List of CPU containers. - * @param [in] outputFolder Path to the output folder. + * @param [in] topComponent The top component in the hierarchy to generate listing for. + * @param [in] activeView The active view for the generation. + * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] cpuContainers List of CPU containers. + * @param [in] outputFolder Path to the output folder. */ bool generate(QSharedPointer topComponent, QString const& activeView, @@ -75,11 +75,11 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write the device tree file. * - * @param [in] designVendor Vendor of the selected design. - * @param [in] designName Name of the selected design. - * @param [in] cpuContainer Container for CPUs. - * @param [in] writeAddressBlocks Flag for writing address block data. - * @param [in] outputFolder Path for the folder. + * @param [in] designVendor Vendor of the selected design. + * @param [in] designName Name of the selected design. + * @param [in] cpuContainer Container for CPUs. + * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] outputFolder Path for the folder. */ void writeFile(QString const& designVendor, QString const& designName, @@ -91,20 +91,20 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator * Write the start of the device tree. * * @param [in] outputStream The stream to write into. - * @param [in] designVendor Vendor of the selected design. - * @param [in] designName Name of the selected design. - * @param [in] masterRoots Roots of the connectivity graph. - * @param [in] prefix Current tab prefix of the items. + * @param [in] designVendor Vendor of the selected design. + * @param [in] designName Name of the selected design. + * @param [in] masterRoots Roots of the connectivity graph. + * @param [in] prefix Current tab prefix of the items. */ void writeTreeStart(QTextStream& outputStream, QString const& designVendor, QString const& designName, QString const& prefix, int addressSize, int rangeSize) const; /*! * Write the found memory paths of the selected CPU container. * - * @param [in] outputStream The stream to write into. - * @param [in] cpuContainer The selected CPU container. - * @param [in] writeAddressBlocks Flag for writing address block data. - * @param [in] prefix Current tab prefix of the items. + * @param [in] outputStream The stream to write into. + * @param [in] cpuContainer The selected CPU container. + * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] prefix Current tab prefix of the items. */ void writeContainer(QTextStream& outputStream, QSharedPointer cpuContainer, bool writeAddressBlocks, @@ -113,11 +113,11 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write the selected interface path. * - * @param [in] outputStream The stream to write into. - * @param [in] pathRootNode Root interface of the path. - * @param [in] cpuContainer CPU container containing the path. - * @param [in] writeAddressBlocks Flag for writing address block data. - * @param [in] prefix Current tab prefix of the items. + * @param [in] outputStream The stream to write into. + * @param [in] pathRootNode Root interface of the path. + * @param [in] cpuContainer CPU container containing the path. + * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] prefix Current tab prefix of the items. */ void startPathWriting(QTextStream& outputStream, QSharedPointer nodeContainer, @@ -130,9 +130,9 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator * Write an introduction to the CPUs. * * @param [in] outputStream The stream to write into. - * @param [in] cpus The selected CPUs. - * @param [in] componentVLNV VLNV of the component containing the CPUs. - * @param [in] prefix The prefix for CPUs. + * @param [in] cpus The selected CPUs. + * @param [in] componentVLNV VLNV of the component containing the CPUs. + * @param [in] prefix The prefix for CPUs. */ void writeIntroductionToCPUs(QTextStream& outputStream, QVector > cpus, QString const& componentVLNV, QString& prefix); @@ -141,10 +141,10 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator * Write a single CPU. * * @param [in] outputStream The stream to write into. - * @param [in] CPUName Name of the selected CPU. - * @param [in] componentVLNV VLNV of the component containing the selected CPU. + * @param [in] CPUName Name of the selected CPU. + * @param [in] componentVLNV VLNV of the component containing the selected CPU. * @param [in] cpuNumber Number of the CPU. - * @param [in] prefix The prefix for a single CPU. + * @param [in] prefix The prefix for a single CPU. */ void writeCPU(QTextStream& outputStream, QString const& CPUName, QString const& componentVLNV, int cpuNumber, QString& prefix); @@ -152,15 +152,15 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write the selected interface node. * - * @param [in] outputStream The stream to write into. - * @param [in] previousInterface The previously written interface. - * @param [in] nodeContainer Container for the interface node. - * @param [in] baseAddress Currently effective base address. - * @param [in] memoryItemRange Currently effective range of the memory item. - * @param [in] prefix Current tab prefix of the items. - * @param [in] writeAddressBlocks Flag for writing address block data. - * @param [in] addressSize Current address size. - * @param [in] rangeSize Current range size. + * @param [in] outputStream The stream to write into. + * @param [in] previousInterface The previously written interface. + * @param [in] nodeContainer Container for the interface node. + * @param [in] baseAddress Currently effective base address. + * @param [in] memoryItemRange Currently effective range of the memory item. + * @param [in] prefix Current tab prefix of the items. + * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] addressSize Current address size. + * @param [in] rangeSize Current range size. */ void writePathNode(QTextStream& outputStream, QSharedPointer previousInterface, @@ -175,10 +175,10 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Check if an interface node has access to memory interface nodes. * - * @param [in] interfaceNode The selected interface node. - * @param [in] previousNode Previous interface node on the tree. + * @param [in] interfaceNode The selected interface node. + * @param [in] previousNode Previous interface node on the tree. * - * @return True, if an interface has access to memory interface nodes, false otherwise. + * @return True, if an interface has access to memory interface nodes, false otherwise. */ bool canWriteNode(QSharedPointer interfaceNode, QSharedPointer previousNode) const; @@ -194,12 +194,12 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write a single bridge. * - * @param [in] outputStream The stream to write into. - * @param [in] interfaceNode Interface containing the bridge. - * @param [in] bridgeType The bridge type. - * @param [in] baseAddress The current base address of the connection chain. - * @param [in] memoryRange Range given for memory items. - * @param [in] prefix The prefix for the bridge. + * @param [in] outputStream The stream to write into. + * @param [in] interfaceNode Interface containing the bridge. + * @param [in] bridgeType The bridge type. + * @param [in] baseAddress The current base address of the connection chain. + * @param [in] memoryRange Range given for memory items. + * @param [in] prefix The prefix for the bridge. */ void writeBridge(QTextStream& outputStream, QSharedPointer interfaceNode, QString const& bridgeType, int addressSize, int rangeSize, QString& prefix); @@ -207,13 +207,13 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Get address and size requirements of the selected interface node. * - * @param [in] rootContainer Container containing the selected interface node. - * @param [in] previousNode Previous node in the connectivity graph. - * @param [in] baseAddress The current base address of the connection chain. - * @param [in] memoryRange Current range for the memory items. - * @param [in] stopAtBridges Flag for stopping the requirement check at bridge components. + * @param [in] rootContainer Container containing the selected interface node. + * @param [in] previousNode Previous node in the connectivity graph. + * @param [in] baseAddress The current base address of the connection chain. + * @param [in] memoryRange Current range for the memory items. + * @param [in] stopAtBridges Flag for stopping the requirement check at bridge components. * - * @return Addres / size requirement pair. + * @return Addres / size requirement pair. */ QPair getAddressAndSizeRequirements(QSharedPointer rootContainer, QSharedPointer previousNode, @@ -224,25 +224,25 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Calculate the amount of 32 bit sizes of the selected value. * - * @param [in] requirementValue The selected value. + * @param [in] requirementValue The selected value. * - * @return The amount of 32 bit sizes of the selected value. + * @return The amount of 32 bit sizes of the selected value. */ unsigned int calculateWordSize(quint64 const& requirementValue) const; /*! * Write memory item. * - * @param [in] outputStream Stream to write into. - * @param [in] itemName Name of the memory item. - * @param [in] instanceName Name of the instance containing the memory item. - * @param [in] componentVLNV VLNV of the component instance. - * @param [in] baseAddress Base address of the memory item. - * @param [in] range Range of the memory item. - * @param [in] isMemory Item memory usage. - * @param [in] prefix Prefix of the memory item. - * @param [in] memoryNode Interface containing the memory item. - * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] outputStream Stream to write into. + * @param [in] itemName Name of the memory item. + * @param [in] instanceName Name of the instance containing the memory item. + * @param [in] componentVLNV VLNV of the component instance. + * @param [in] baseAddress Base address of the memory item. + * @param [in] range Range of the memory item. + * @param [in] isMemory Item memory usage. + * @param [in] prefix Prefix of the memory item. + * @param [in] memoryNode Interface containing the memory item. + * @param [in] writeAddressBlocks Flag for writing address block data. */ void writeMemoryData(QTextStream& outputStream, quint64 const& itemBaseAddress, quint64 const& mapBaseAddress, quint64 const& range, @@ -252,10 +252,10 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write address blocks. * - * @param [in] outputStream Stream to write into. - * @param [in] memoryNode Interface containing the memory item. - * @param [in] itemBaseAddress Base address of the memory location. - * @param [in] prefix Prefix of the address blocks. + * @param [in] outputStream Stream to write into. + * @param [in] memoryNode Interface containing the memory item. + * @param [in] itemBaseAddress Base address of the memory location. + * @param [in] prefix Prefix of the address blocks. */ void writeAddressBlocksData(QTextStream& outputStream, QSharedPointer memoryNode, quint64 const& itemBaseAddress, int addressSize, int rangeSize, QString& prefix) const; @@ -263,11 +263,11 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write the selected address block. * - * @param [in] outputStream Stream to write into. - * @param [in] memoryNode Interface containing the memory item. - * @param [in] blockItem The selected address block memory item. - * @param [in] itemBaseAddress Base address of the memory location. - * @param [in] prefix Prefix of the address blocks. + * @param [in] outputStream Stream to write into. + * @param [in] memoryNode Interface containing the memory item. + * @param [in] blockItem The selected address block memory item. + * @param [in] itemBaseAddress Base address of the memory location. + * @param [in] prefix Prefix of the address blocks. */ void writeSingleAddressBlock(QTextStream& outputStream, QString const& vendorName, QSharedPointer blockItem, @@ -284,10 +284,10 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator /*! * Write the memory items with usage memory. * - * @param [in] outputStream Stream to write into. - * @param [in] cpuContainer CPU containing the memories. - * @param [in] prefix Prefix of the memories. - * @param [in] writeAddressBlocks Flag for writing address block data. + * @param [in] outputStream Stream to write into. + * @param [in] cpuContainer CPU containing the memories. + * @param [in] prefix Prefix of the memories. + * @param [in] writeAddressBlocks Flag for writing address block data. */ void writeMemories(QTextStream& outputStream, QSharedPointer cpuContainer, QString& prefix, @@ -299,7 +299,7 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator * @param [in] containingComponent Component containing the views. * @param [in] viewName Name of the currently active view. * - * @return The currently active view. + * @return The currently active view. */ QSharedPointer getView(QSharedPointer containingComponent, QString const& viewName) const; @@ -310,7 +310,7 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreeGenerator * @param [in] containingComponent Component containing the required items. * @param [in] referencingView The selected view. * - * @return Design configuration referenced by the selected view. + * @return Design configuration referenced by the selected view. */ QSharedPointer getDesignConfiguration( QSharedPointer containingComponent, QSharedPointer referencingView) const; diff --git a/Plugins/LinuxDeviceTree/LinuxDeviceTreePlugin.h b/Plugins/LinuxDeviceTree/LinuxDeviceTreePlugin.h index f09dd524f..182042fe6 100644 --- a/Plugins/LinuxDeviceTree/LinuxDeviceTreePlugin.h +++ b/Plugins/LinuxDeviceTree/LinuxDeviceTreePlugin.h @@ -99,12 +99,12 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreePlugin : public QObject, pu /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration) const; @@ -113,11 +113,11 @@ class LINUXDEVICETREEGENERATOR_EXPORT LinuxDeviceTreePlugin : public QObject, pu * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration); @@ -140,7 +140,7 @@ public slots: /*! * Called when an error is reported to us. * - * @param [in] report The error message. + * @param [in] report The error message. */ void onErrorReport(const QString& report); @@ -169,19 +169,19 @@ public slots: /*! * Create a path containing the default file name. * - * @param [in] suggestedPath The suggested path for the device tree file. - * @param [in] componentName Name of the component. + * @param [in] suggestedPath The suggested path for the device tree file. + * @param [in] componentName Name of the component. */ QString createFileNamePath(QString const& suggestedPath, QString const& componentName) const; /*! * Generate the device tree. * - * @param [in] component The selected top component. - * @param [in] activeView View of the selected top component. - * @param [in] folderPath Folder path for the device tree files. - * @param [in] writeBlocks Flag for writing address block data. - * @param [in] acceptedContainers List of CPU containers to be written. + * @param [in] component The selected top component. + * @param [in] activeView View of the selected top component. + * @param [in] folderPath Folder path for the device tree files. + * @param [in] writeBlocks Flag for writing address block data. + * @param [in] acceptedContainers List of CPU containers to be written. */ void generateDeviceTree(QSharedPointer component, QString const& activeView, QString const& folderPath, bool writeBlocks, diff --git a/Plugins/MCAPICodeGenerator/MCAPICodeGenerator.h b/Plugins/MCAPICodeGenerator/MCAPICodeGenerator.h index c17687b22..254b32a30 100644 --- a/Plugins/MCAPICodeGenerator/MCAPICodeGenerator.h +++ b/Plugins/MCAPICodeGenerator/MCAPICodeGenerator.h @@ -31,8 +31,8 @@ class MCAPICodeGenerator /*! * Generates MCAPI code for the given component. * - * @param [in] QString dir The directory for the generated code. - * @param [in] QSharedPointer component The component which MCAPI code will be generated. + * @param [in] QString dir The directory for the generated code. + * @param [in] QSharedPointer component The component which MCAPI code will be generated. */ void generateMCAPIForComponent(QString dir, QSharedPointer component); @@ -46,17 +46,17 @@ class MCAPICodeGenerator /*! * Checks if MCAPI code may be generated for the given component. * - * @param [in] component The component, which is checked. - * @return True, if MCAPI code can be generated for the component. + * @param [in] component The component, which is checked. + * @return True, if MCAPI code can be generated for the component. */ bool canGenerateMCAPIComponent(QSharedPointer component); /*! * Checks if all properties required in given ComDefintion are set in the given ComInterface. * - * @param [in] comDef The ComDefinition under inspection. - * @param [in] comIf The ComInterface under inspection. - * @param [in] errorList Missing properties will be reported in this list. + * @param [in] comDef The ComDefinition under inspection. + * @param [in] comIf The ComInterface under inspection. + * @param [in] errorList Missing properties will be reported in this list. */ void checkRequiredPropertiesSet(QString componentVLNV, QSharedPointer comDef, QSharedPointer comIf, QStringList &errorList); @@ -64,168 +64,168 @@ class MCAPICodeGenerator /*! * Generates the MCAPI code header file. * - * @param [in] filename The name of the header file to write. + * @param [in] filename The name of the header file to write. */ void generateHeader(QString const& filename); /*! * Writes function declarations for the generated code. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void writeFunctionDeclarations(CSourceWriter &writer); /*! * Generates the MCAPI code source file. * - * @param [in] filename The name of the source file to write. + * @param [in] filename The name of the source file to write. */ void generateSource(QString const& filename); /*! * Generates port identifiers for the local endpoints. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void writeLocalPorts(CSourceWriter &writer); /*! * Writes declarations for remote endpoint variables and handles. * - * @param [in] writer The source writer. - * @param [in] isExtern True, if extern is added to variable declaration. + * @param [in] writer The source writer. + * @param [in] isExtern True, if extern is added to variable declaration. */ void writeRemoteEndpoints(CSourceWriter &writer, bool isExtern); /*! * Writes declarations for local endpoint variables. * - * @param [in] writer The source writer. - * @param [in] isExtern True, if extern is added to variable declaration. + * @param [in] writer The source writer. + * @param [in] isExtern True, if extern is added to variable declaration. */ void writeLocalEndpoints(CSourceWriter &writer, bool isExtern); /*! * Generates the template source containing the program main(). * - * @param [in] filename The name of the file to write. + * @param [in] filename The name of the file to write. */ void generateMainTemplate(QString const& filename); /*! * Generates the initializeMCAPI() function based on the component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void generateInitializeMCAPIFunc(CSourceWriter& writer); /*! * Generates the node initialization code. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void createInitialization(CSourceWriter &writer); /*! * Generates code to get remote endpoints for the given component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void getRemoteEndpoints(CSourceWriter &writer); /*! * Generates code to create local endpoints for the given component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void createLocalEndpoints(CSourceWriter &writer); /*! * Generates the connectChannels() function based on the component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void generateConnectChannelsFunc(CSourceWriter& writer); /*! * Generates the openConnections() function based on the component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void generateOpenConnectionsFunc(CSourceWriter& writer); /*! * Generates the closeConnections() function based on the component. * - * @param [in] writer The source writer. + * @param [in] writer The source writer. */ void generateCloseConnectionsFunc(CSourceWriter& writer); /*! * Generates variables used in connection, open, or close function. * - * @param [in] writer The source writer. - * @param [in] interfaceCount Number of interfaces in the component. - * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. + * @param [in] writer The source writer. + * @param [in] interfaceCount Number of interfaces in the component. + * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. */ void writeConnectionVariables(CSourceWriter &writer, QString interfaceCount, QString name); /*! * Writes connection call for the given interface. * - * @param [in] comIf Interface, which connection call is written. - * @param [in] writer The source writer. - * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. + * @param [in] comIf Interface, which connection call is written. + * @param [in] writer The source writer. + * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. */ void writeCon(MCAPIParser::EndPointData epd, CSourceWriter &writer, QString name); /*! * Writes open call for the given interface. * - * @param [in] comIf Interface, which open call is written. - * @param [in] writer The source writer. - * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. + * @param [in] comIf Interface, which open call is written. + * @param [in] writer The source writer. + * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. */ void writeOpen(MCAPIParser::EndPointData epd, CSourceWriter &writer, QString name); /*! * Writes close call for the given interface. * - * @param [in] comIf Interface, which close call is written. - * @param [in] writer The source writer. - * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. + * @param [in] comIf Interface, which close call is written. + * @param [in] writer The source writer. + * @param [in] name Name of transfer type, ideally 'pkt' or 'scl'. */ void writeClose(MCAPIParser::EndPointData epd, CSourceWriter &writer, QString name); /*! * Writes loop which tries to connect, open or close for preset times. * - * @param [in] writer The source writer. - * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. + * @param [in] writer The source writer. + * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. */ void writeRetryLoop(CSourceWriter &writer, QString name); /*! * Call which waits for request for givent time. * - * @param [in] writer The source writer. - * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. + * @param [in] writer The source writer. + * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. */ void writeIterationWait(CSourceWriter &writer, QString name); /*! * Checks if all connect, open or close calls are complete. * - * @param [in] writer The source writer. - * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. + * @param [in] writer The source writer. + * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. */ void writeCompleteCheck(CSourceWriter &writer, QString name); /*! * Writes an MCAPI status check, which waits in case of pending. * - * @param [in] writer The source writer. - * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. + * @param [in] writer The source writer. + * @param [in] name Name of the operation, ideally 'connect', 'open', or 'close'. */ void writePendStatusCheck(CSourceWriter &writer, QString name); diff --git a/Plugins/MCAPICodeGenerator/MCAPICodeGeneratorPlugin.h b/Plugins/MCAPICodeGenerator/MCAPICodeGeneratorPlugin.h index 4e829d317..f80f2d742 100644 --- a/Plugins/MCAPICodeGenerator/MCAPICodeGeneratorPlugin.h +++ b/Plugins/MCAPICodeGenerator/MCAPICodeGeneratorPlugin.h @@ -76,12 +76,12 @@ class MCAPICodeGeneratorPlugin : public QObject, public IGeneratorPlugin /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -91,11 +91,11 @@ class MCAPICodeGeneratorPlugin : public QObject, public IGeneratorPlugin * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, diff --git a/Plugins/MCAPICodeGenerator/MCAPIHeaderGenerator.h b/Plugins/MCAPICodeGenerator/MCAPIHeaderGenerator.h index eb287213f..9987c4185 100644 --- a/Plugins/MCAPICodeGenerator/MCAPIHeaderGenerator.h +++ b/Plugins/MCAPICodeGenerator/MCAPIHeaderGenerator.h @@ -23,8 +23,8 @@ class MCAPIHeaderGenerator /*! * The constructor. * - * @param [in] parser A parser that has already parsed the design for MCAPI generation. - * @param [in] utility The same IPluginUtility, which is fed to the plugin class as parameter. + * @param [in] parser A parser that has already parsed the design for MCAPI generation. + * @param [in] utility The same IPluginUtility, which is fed to the plugin class as parameter. */ MCAPIHeaderGenerator( MCAPIParser& parser, IPluginUtility* utility ); @@ -37,9 +37,9 @@ class MCAPIHeaderGenerator /*! * Generates source files associated with the top level component of the design. * - * @param [in] topComponent The top level component associated with the design. - * @param [in] desgConf The design configuration associated with the design. - * @param [in] topDir The location of the top level component in the file system. + * @param [in] topComponent The top level component associated with the design. + * @param [in] desgConf The design configuration associated with the design. + * @param [in] topDir The location of the top level component in the file system. */ void generateTopLevel(QSharedPointer topComponent, QSharedPointer desgConf, QString topDir); @@ -54,18 +54,18 @@ class MCAPIHeaderGenerator /*! * Generates a header file containing data specific to a software instance. * - * @param [in] filename The name of the source file to write. - * @param [in] nodeData MCAPI node data associated with the instance. + * @param [in] filename The name of the source file to write. + * @param [in] nodeData MCAPI node data associated with the instance. */ void generateInstanceHeader(QString const& directory, MCAPIParser::NodeData const& nodeData); /*! * Add generated MCAPI code files to the fileSet of the associated component. * - * @param [in] directory The directory, where the files are inserted on the file system. - * @param [in] topComponent The top level component associated with the design. - * @param [in] instance The software instance, which instance header was generated. - * @param [in] desgConf The design configuration associated with the design. + * @param [in] directory The directory, where the files are inserted on the file system. + * @param [in] topComponent The top level component associated with the design. + * @param [in] instance The software instance, which instance header was generated. + * @param [in] desgConf The design configuration associated with the design. */ void addGeneratedMCAPIToFileset(QString directory, QSharedPointer topComponent, QSharedPointer instance, QSharedPointer desgConf); @@ -74,10 +74,10 @@ class MCAPIHeaderGenerator * Find connections of given software instance and returns a list of pairs, where the first is from the * end of the given instance, and second the other end. * - * @param [in] design The design where the software instance belongs to. - * @param [in] ourInstance The software instance, which connections are listed. - * @param [in] component The software component of ourInstance. - * @return List of "our" interfaces paired with their connected interfaces. + * @param [in] design The design where the software instance belongs to. + * @param [in] ourInstance The software instance, which connections are listed. + * @param [in] component The software component of ourInstance. + * @return List of "our" interfaces paired with their connected interfaces. */ QList, PortReference> > findConnectedComInterfaces( QSharedPointer design, QSharedPointer ourInstance, @@ -87,10 +87,10 @@ class MCAPIHeaderGenerator * Writes remote endpoint of 'ourInterface' and endpoint definitions of both given interfaces. * The definitions are appended to the list 'endpointDefs'. * - * @param [in] writer The source writer. - * @param [in] ourEnd Data associated with end point in "our" end of connection. - * @param [in] theirEnd Data associated with end point in "their" end of connection. - * @param [in] endpointDefs The list of endpoint definition names. + * @param [in] writer The source writer. + * @param [in] ourEnd Data associated with end point in "our" end of connection. + * @param [in] theirEnd Data associated with end point in "their" end of connection. + * @param [in] endpointDefs The list of endpoint definition names. */ void writeRemoteEndpoint(CSourceWriter &writer, MCAPIParser::EndPointData ourEnd, MCAPIParser::EndPointData theirEnd, QStringList& endpointDefs); @@ -98,34 +98,34 @@ class MCAPIHeaderGenerator /*! * Writes the given endpoint definition names to array. * - * @param [in] writer The source writer. - * @param [in] endpointDefs The list of endpoint definition names. + * @param [in] writer The source writer. + * @param [in] endpointDefs The list of endpoint definition names. */ void writeEndpointDefList(CSourceWriter &writer, QStringList &endpointDefs); /*! * Converts direction string of Kactus2 to enum used by PMQ-MCAPI. * - * @param [in] direction Direction string to be converted. - * @return The created enum. + * @param [in] direction Direction string to be converted. + * @return The created enum. */ QString transferDirectionToEString(DirectionTypes::Direction direction); /*! * Converts transfer type string of Kactus2 to enum used by PMQ-MCAPI. * - * @param [in] transferType Transfer type string to be converted. - * @return The created enum. + * @param [in] transferType Transfer type string to be converted. + * @return The created enum. */ QString transferTypeToEString(QString transferType); /*! * Makes an endpoint identifier understood by PMQ-MCAPI. * - * @param [in] domainID The domain of the endpoint. - * @param [in] nodeID The node of the endpoint. - * @param [in] portID The port of the endpoint. - * @return The created string. + * @param [in] domainID The domain of the endpoint. + * @param [in] nodeID The node of the endpoint. + * @param [in] portID The port of the endpoint. + * @return The created string. */ QString makeIdString(QString domainID, QString nodeID, QString portID); diff --git a/Plugins/MCAPICodeGenerator/MCAPIParser.h b/Plugins/MCAPICodeGenerator/MCAPIParser.h index 87a9664af..f6da4808a 100644 --- a/Plugins/MCAPICodeGenerator/MCAPIParser.h +++ b/Plugins/MCAPICodeGenerator/MCAPIParser.h @@ -73,16 +73,16 @@ class MCAPIParser /*! * Generates MCAPI code for the given component. * - * @param [in] component The component, which is being parsed. + * @param [in] component The component, which is being parsed. */ void parseMCAPIForComponent(QSharedPointer component); /*! * Generates source files associated with the top level component of the design. * - * @param [in] design The design subject to generation. - * @param [in] topComponent The top level component associated with the design. - * @param [in] desgConf The design configuration associated with the design. + * @param [in] design The design subject to generation. + * @param [in] topComponent The top level component associated with the design. + * @param [in] desgConf The design configuration associated with the design. */ void parseTopLevel(QSharedPointer design, QSharedPointer topComponent, QSharedPointer desgConf); @@ -92,18 +92,18 @@ class MCAPIParser /*! * Checks if MCAPI code may be generated for the given component. * - * @param [in] component The component, which is checked. - * @return True, if MCAPI code can be generated for the component. + * @param [in] component The component, which is checked. + * @return True, if MCAPI code can be generated for the component. */ bool canGenerateMCAPIComponent(QSharedPointer component); /*! * Checks if all properties required in given ComDefintion are set in the given ComInterface. * - * @param [in] componentVLNV VLNV associated with component where the interface belongs to. - * @param [in] comDef The ComDefinition under inspection. - * @param [in] comIf The ComInterface under inspection. - * @param [in] errorList Missing properties will be reported in this list. + * @param [in] componentVLNV VLNV associated with component where the interface belongs to. + * @param [in] comDef The ComDefinition under inspection. + * @param [in] comIf The ComInterface under inspection. + * @param [in] errorList Missing properties will be reported in this list. */ void checkRequiredPropertiesSet(QString componentVLNV, QSharedPointer comDef, QSharedPointer comIf, QStringList &errorList); @@ -111,10 +111,10 @@ class MCAPIParser /*! * Parses all endpoint definitions of given software instance. * - * @param [in] design The design where the software instance belongs to. - * @param [in] ourInstance The software instance, which endpoint definitions are written. - * @param [in] component The software component of ourInstance. - * @param [in] nodeData Node associated with the instance. + * @param [in] design The design where the software instance belongs to. + * @param [in] ourInstance The software instance, which endpoint definitions are written. + * @param [in] component The software component of ourInstance. + * @param [in] nodeData Node associated with the instance. */ void findEndpointDefinitions(QSharedPointer design, QSharedPointer ourInstance, QSharedPointer component, NodeData& nodeData); @@ -123,11 +123,11 @@ class MCAPIParser * Find connections of given software instance and returns a list of pairs, where the first is from the * end of the given instance, and second the other end. * - * @param [in] design The design where the software instance belongs to. - * @param [in] ourInstance The software instance, which connections are listed. - * @param [in] component The software component of ourInstance. + * @param [in] design The design where the software instance belongs to. + * @param [in] ourInstance The software instance, which connections are listed. + * @param [in] component The software component of ourInstance. * - * @return List of "our" interfaces paired with their connected interfaces. + * @return List of "our" interfaces paired with their connected interfaces. */ QList, PortReference> > findConnectedComInterfaces( QSharedPointer design, QSharedPointer ourInstance, @@ -136,17 +136,17 @@ class MCAPIParser /*! * Parses data associated with an endpoint from given ComInterface and assigns it to the given endpoint. * - * @param [in] comIf Source of the parsed data. + * @param [in] comIf Source of the parsed data. * - * @return The parsed data. + * @return The parsed data. */ EndPointData parseEndpoint(QSharedPointer comIf); /*! * Warns if all fields of endpoint identifier may be not found in given interface and its instance. * - * @param [in] targetInterface Interface, which port ID is to be checked. - * @param [in] targetInstance Instance, which node ID and domain ID are to be checked. + * @param [in] targetInterface Interface, which port ID is to be checked. + * @param [in] targetInstance Instance, which node ID and domain ID are to be checked. */ void checkEndpointIdentifier(QSharedPointer targetInterface, QSharedPointer targetInstance); @@ -154,10 +154,10 @@ class MCAPIParser /*! * Warns if the transfer types of given interfaces are not compatible. * - * @param [in] ourInterface Interface of connection in "our" end. - * @param [in] targetInterface Interface of connection in "their" end. - * @param [in] ourInstance Instance of connection in "our" end. - * @param [in] targetInstance Instance of connection in "their" end. + * @param [in] ourInterface Interface of connection in "our" end. + * @param [in] targetInterface Interface of connection in "their" end. + * @param [in] ourInstance Instance of connection in "our" end. + * @param [in] targetInstance Instance of connection in "their" end. */ void checkTransferType(QSharedPointer ourInstance, QSharedPointer ourInterface, QSharedPointer targetInstance, QSharedPointer targetInterface); @@ -165,10 +165,10 @@ class MCAPIParser /*! * Warns if the scalar sizes of given interfaces are not compatible. * - * @param [in] ourInterface Interface of connection in "our" end. - * @param [in] targetInterface Interface of connection in "their" end. - * @param [in] ourInstance Instance of connection in "our" end. - * @param [in] targetInstance Instance of connection in "their" end. + * @param [in] ourInterface Interface of connection in "our" end. + * @param [in] targetInterface Interface of connection in "their" end. + * @param [in] ourInstance Instance of connection in "our" end. + * @param [in] targetInstance Instance of connection in "their" end. */ void checkScalarSize(QSharedPointer ourInstance, QSharedPointer ourInterface, QSharedPointer targetInstance, QSharedPointer targetInterface); diff --git a/Plugins/MakefileGenerator/MakeConfiguration.h b/Plugins/MakefileGenerator/MakeConfiguration.h index 8cdb0b4d5..789ac7194 100644 --- a/Plugins/MakefileGenerator/MakeConfiguration.h +++ b/Plugins/MakefileGenerator/MakeConfiguration.h @@ -25,15 +25,15 @@ struct MakeDocument : public GenerationOutput /*! * Writes the content. * - * @param [in] outputDirectory The possible output directory. + * @param [in] outputDirectory The possible output directory. */ virtual void write(QString const& /*outputDirectory*/) override final {} /*! * Finds position for body text highlight in document, if any exists. * - * @param [out] begin The position where the highlight begins, if successful. - * @param [out] end The position where the highlight ends, if successful. + * @param [out] begin The position where the highlight begins, if successful. + * @param [out] end The position where the highlight ends, if successful. */ virtual void getBodyHighlight(int& /*begin*/, int& /*end*/) const override final {} }; @@ -60,7 +60,7 @@ class MakeConfiguration : public QObject /*! * Checks if the generation configuration is valid. * - * @param [out] warning The stated reason for not accepting. + * @param [out] warning The stated reason for not accepting. */ bool validSelections(QString &warning); diff --git a/Plugins/MakefileGenerator/MakefileGenerator.h b/Plugins/MakefileGenerator/MakefileGenerator.h index 3818fefcc..e6251a74d 100644 --- a/Plugins/MakefileGenerator/MakefileGenerator.h +++ b/Plugins/MakefileGenerator/MakefileGenerator.h @@ -23,9 +23,9 @@ class MakefileGenerator /*! * The constructor. * - * @param [in] parser The parser which parsed the meta data to data structures directly usable by the generator. - * @param [in] utility The provided plugin utility. - * @param [in] generalFileSet The file set, where design configuration specific things belong to. + * @param [in] parser The parser which parsed the meta data to data structures directly usable by the generator. + * @param [in] utility The provided plugin utility. + * @param [in] generalFileSet The file set, where design configuration specific things belong to. */ MakefileGenerator( MakefileParser& parser, IPluginUtility* utility, QSharedPointer generalFileSet ); @@ -42,11 +42,11 @@ class MakefileGenerator /*! * Generates all makefiles based on the parsed data. * - * @param [in] targetPath The path, where the makefiles are created. - * @param [in] topPath The path, where the top component is. - * @param [in] sysViewName Name of the system view pointing to used design configuration. + * @param [in] targetPath The path, where the makefiles are created. + * @param [in] topPath The path, where the top component is. + * @param [in] sysViewName Name of the system view pointing to used design configuration. * - * @return How many executables got a makefile. + * @return How many executables got a makefile. */ int generate(QString const& targetPath, QString const& topPath); @@ -57,10 +57,10 @@ class MakefileGenerator * Creates a makefile for a single software instance, and thus for a single executable. * The makefile is also placed to the instance headers. Will add the name to makeNames. * - * @param [in] targetPath The path, where the makefiles are created. - * @param [in] componentPath The path of the component which will be associated with the created make file. - * @param [in] makeData The make data associated with the makefile as whole. - * @param [in/out] makeNames The directory of the created makefile must be added here. + * @param [in] targetPath The path, where the makefiles are created. + * @param [in] componentPath The path of the component which will be associated with the created make file. + * @param [in] makeData The make data associated with the makefile as whole. + * @param [in/out] makeNames The directory of the created makefile must be added here. */ void generateInstanceMakefile(QString const& targetPath, QString const& componentPath, QSharedPointer makeData, QStringList& makeNames); @@ -69,48 +69,48 @@ class MakefileGenerator * Creates a makefile calling all the other makefiles associated with the design. * The makefile is also placed to the instance headers. * - * @param [in] basePath The path, where the makefile is created. - * @param [in] componentPath The path of the component which will be associated with the created make file. - * @param [in] makeNames The names of all created make files so far. + * @param [in] basePath The path, where the makefile is created. + * @param [in] componentPath The path of the component which will be associated with the created make file. + * @param [in] makeNames The names of all created make files so far. */ void generateMainMakefile(QString const& targetPath, QString const& componentPath, QStringList& makeNames) const; /*! * Writes data used in building the executable to the stream. * - * @param [in] mfd The make data associated with the makefile as whole. - * @param [in] outStream The stream where the makefile is written. + * @param [in] mfd The make data associated with the makefile as whole. + * @param [in] outStream The stream where the makefile is written. */ void writeFinalFlagsAndBuilder(QSharedPointer mfd, QTextStream& outStream) const; /*! * Writes the list of the built and used objects to the stream. * - * @param [in] mfd The make data associated with the makefile as whole. - * @param [in] outStream The stream where the makefile is written. + * @param [in] mfd The make data associated with the makefile as whole. + * @param [in] outStream The stream where the makefile is written. */ void writeObjectList(QSharedPointer mfd, QTextStream& outStream) const; /*! * Writes the build command of the executable to the stream. * - * @param [in] outStream The stream where the makefile is written. + * @param [in] outStream The stream where the makefile is written. */ void writeExeBuild(QTextStream& outStream) const; /*! * Writes the cleaning rules for makefile, which removes both object and dependency files. * - * @param [in] outStream The stream where the makefile is written. + * @param [in] outStream The stream where the makefile is written. */ void writeCleanRules(QTextStream& outStream) const; /*! * Writes the build rules for the object files of the makefile. * - * @param [in] outStream The stream where the makefile is written. - * @param [in] objects The list of the objects written. - * @param [in] instancePath Path of the makefile and thus the path where it is called from. + * @param [in] outStream The stream where the makefile is written. + * @param [in] objects The list of the objects written. + * @param [in] instancePath Path of the makefile and thus the path where it is called from. */ void writeMakeObjects(QTextStream& outStream, QList > const& objects, QString instancePath) const; diff --git a/Plugins/MakefileGenerator/MakefileGeneratorPlugin.h b/Plugins/MakefileGenerator/MakefileGeneratorPlugin.h index ec30a3438..204bbe375 100644 --- a/Plugins/MakefileGenerator/MakefileGeneratorPlugin.h +++ b/Plugins/MakefileGenerator/MakefileGeneratorPlugin.h @@ -83,12 +83,12 @@ class MAKEFILEGENERATOR_EXPORT MakefileGeneratorPlugin : public QObject, public /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport( QSharedPointer component, @@ -99,11 +99,11 @@ class MAKEFILEGENERATOR_EXPORT MakefileGeneratorPlugin : public QObject, public * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -113,12 +113,12 @@ class MAKEFILEGENERATOR_EXPORT MakefileGeneratorPlugin : public QObject, public /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration, @@ -127,7 +127,7 @@ class MAKEFILEGENERATOR_EXPORT MakefileGeneratorPlugin : public QObject, public /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const override; diff --git a/Plugins/MakefileGenerator/MakefileParser.h b/Plugins/MakefileGenerator/MakefileParser.h index 6815b71c3..c1cfe0cb5 100644 --- a/Plugins/MakefileGenerator/MakefileParser.h +++ b/Plugins/MakefileGenerator/MakefileParser.h @@ -30,8 +30,8 @@ class MakefileParser /*! * The constructor. * - * @param [in] library The library containing all components in the design. - * @param [in] parser The parsed software stack containing needed references. + * @param [in] library The library containing all components in the design. + * @param [in] parser The parsed software stack containing needed references. */ MakefileParser( LibraryInterface* library, SWStackParser& swStackParser ); @@ -50,10 +50,10 @@ class MakefileParser /*! * Parses all source files in all file sets in the given part of a stack. * - * @param [in] makeData The make data associated with the makefile as whole. - * @param [in] view The software view, where the files belong to. - * @param [in] buildCmd The build command of the associated software view. - * @param [in] component The component of softInstance. + * @param [in] makeData The make data associated with the makefile as whole. + * @param [in] view The software view, where the files belong to. + * @param [in] buildCmd The build command of the associated software view. + * @param [in] component The component of softInstance. */ void parseMakeObjects( QSharedPointer makeData, QSharedPointer stackPart ); @@ -62,11 +62,11 @@ class MakefileParser * Parses all files of parameters fset, adding the to parameters objects. * Parsing involves defining the file as header, and determining its relevant build commands and path. * - * @param [in] fset The inspected file set - * @param [in] objects The list of parsed objects, where the file data will be appended. - * @param [in] makeData The make data associated with the makefile as whole. - * @param [in] buildCmd The build command - * @param [in] componentPath Path to the component where the file sets belong to. + * @param [in] fset The inspected file set + * @param [in] objects The list of parsed objects, where the file data will be appended. + * @param [in] makeData The make data associated with the makefile as whole. + * @param [in] buildCmd The build command + * @param [in] componentPath Path to the component where the file sets belong to. */ void parseFileSet(QSharedPointer fset, QSharedPointer makeData, QSharedPointer stackPart, QString& componentPath); @@ -74,20 +74,20 @@ class MakefileParser /*! * Gets the compiler used for the file. * - * @param [in] mod The make data associated with the object file. - * @param [in] hardView Software view of the associated hardware component. + * @param [in] mod The make data associated with the object file. + * @param [in] hardView Software view of the associated hardware component. * - * @return The resolved compiler for the file. + * @return The resolved compiler for the file. */ QString getFileCompiler(QSharedPointer mod, QSharedPointer hardBuilder) const; /*! * Gets concatenated the build flags of the file with those fileSet and software views. * - * @param [in] mod The make data associated with the object file. - * @param [in] mfd The make data associated with the makefile as whole. + * @param [in] mod The make data associated with the object file. + * @param [in] mfd The make data associated with the makefile as whole. * - * @return The resolved flags for the file. + * @return The resolved flags for the file. */ QString getFileFlags(QSharedPointer component, QSharedPointer &mod, QSharedPointer makeData) const; @@ -95,7 +95,7 @@ class MakefileParser /*! * Finds conflicting files within the stack: The same file with different meta data. * - * @param [in] makeData The make data associated with the makefile as whole. + * @param [in] makeData The make data associated with the makefile as whole. */ void findConflicts(QSharedPointer makeData); diff --git a/Plugins/MakefileGenerator/SWStackParser.h b/Plugins/MakefileGenerator/SWStackParser.h index d2a700d47..e8f26eafb 100644 --- a/Plugins/MakefileGenerator/SWStackParser.h +++ b/Plugins/MakefileGenerator/SWStackParser.h @@ -51,7 +51,7 @@ class SWStackParser /*! * Parses all software components from the design for the data needed in makefiles. * - * @param [in] sysViewName Name of the system view pointing to used design configuration. + * @param [in] sysViewName Name of the system view pointing to used design configuration. */ void parse(QString const& sysViewName); @@ -60,20 +60,20 @@ class SWStackParser /*! * Checks if softInstance is the topmost instance in its stack. * - * @param [in] softInstance The software instance to be checked. - * @param [in] softComponent The software component of the instance. + * @param [in] softInstance The software instance to be checked. + * @param [in] softComponent The software component of the instance. * - * @return True, if the softInstance is the topmost instance in its stack. Otherwise false. + * @return True, if the softInstance is the topmost instance in its stack. Otherwise false. */ bool isTopOfStack(QSharedPointer softInstance, QSharedPointer softComponent); /*! * Recursively parses source files for the whole stack for the given software instance. * - * @param [in] softComponent The component of softInstance. - * @param [in] softInstance The software instance which active view is to be parsed. - * @param [in] makeData The make data associated with the makefile as whole. - * @param [in] sysViewName Name of the system view pointing to used design configuration. + * @param [in] softComponent The component of softInstance. + * @param [in] softInstance The software instance which active view is to be parsed. + * @param [in] makeData The make data associated with the makefile as whole. + * @param [in] sysViewName Name of the system view pointing to used design configuration. */ void parseStackObjects(QSharedPointer softComponent, QSharedPointer softInstance, QSharedPointer makeData, QString const& systemViewName); @@ -81,10 +81,10 @@ class SWStackParser /*! * Tries to find a software instance by name and the component associated with it. * - * @param [in] instanceName Name of the searched software instance. - * @param [out] targetInstance The found software instance. + * @param [in] instanceName Name of the searched software instance. + * @param [out] targetInstance The found software instance. * - * @return The component of the found instance. + * @return The component of the found instance. */ QSharedPointer searchSWComponent(QString instanceName, QSharedPointer& targetInstance); diff --git a/Plugins/MemoryMapHeaderGenerator/BaseMemoryMapHeaderWriter.h b/Plugins/MemoryMapHeaderGenerator/BaseMemoryMapHeaderWriter.h index 2d11fff93..e667b591a 100644 --- a/Plugins/MemoryMapHeaderGenerator/BaseMemoryMapHeaderWriter.h +++ b/Plugins/MemoryMapHeaderGenerator/BaseMemoryMapHeaderWriter.h @@ -44,7 +44,7 @@ class BaseMemoryMapHeaderWriter /*! * The constructor. * - * @param [in] utility Interface which offers core utilities for plugins. + * @param [in] utility Interface which offers core utilities for plugins. */ BaseMemoryMapHeaderWriter(IPluginUtility* utility); @@ -58,24 +58,24 @@ class BaseMemoryMapHeaderWriter /*! * Check that the directory structure exists for the file. * - * @param [in] dir The directory for the file. + * @param [in] dir The directory for the file. */ void checkDirectoryStructure(QDir dir); /*! * Display an error message when opening a file. * - * @param [in] absoluteFilePath The file path of the file that couldn't be opened. + * @param [in] absoluteFilePath The file path of the file that couldn't be opened. */ void openFileErrorMessage(QString const& absoluteFilePath); /*! * Write the top part of the header file. * - * @param [in] stream The text stream used for writing. - * @param [in] fileName The name of the file being written. - * @param [in] header The header guard of the file. - * @param [in] description The description of the file. + * @param [in] stream The text stream used for writing. + * @param [in] fileName The name of the file being written. + * @param [in] header The header guard of the file. + * @param [in] description The description of the file. */ void writeTopOfHeaderFile(QTextStream& stream, QString const& fileName, QString const& header, QString const& description); @@ -83,11 +83,11 @@ class BaseMemoryMapHeaderWriter /*! * Add a generated file to the file sets of a component. * - * @param [in] component Pointer to the component where the file is added to. - * @param [in] fileInfo Contains the info on the generated file. - * @param [in] filesetName The name of the file set to add the header file to. - * @param [in] swViewNames Contains the names of the sw views to add the file set reference to. - * @param [in] instanceId The id of the instance which is used when generating global headers. + * @param [in] component Pointer to the component where the file is added to. + * @param [in] fileInfo Contains the info on the generated file. + * @param [in] filesetName The name of the file set to add the header file to. + * @param [in] swViewNames Contains the names of the sw views to add the file set reference to. + * @param [in] instanceId The id of the instance which is used when generating global headers. */ void addHeaderFile(QSharedPointer component, const QFileInfo& fileInfo, const QString& filesetName, const QStringList& swViewNames = QStringList(), const QString& instanceId = QString()) const; @@ -95,19 +95,19 @@ class BaseMemoryMapHeaderWriter /*! * Display the created memory map header file for the user. * - * @param [in] filePath The path to the created file. + * @param [in] filePath The path to the created file. */ virtual void displayMemoryMapHeader(QString const& filePath) const; /*! * Write the registers contained in a memory map. * - * @param [in] finder The parameter finder containing the referenced parameters. - * @param [in] containingMemoryMap The base memory map containing the registers. - * @param [in] stream The text stream to write into. - * @param [in] useAddressBlockID Tells if an address block id is needed for the register name. - * @param [in] offset The current offset. - * @param [in] idString Helps to identify non-unique registers. + * @param [in] finder The parameter finder containing the referenced parameters. + * @param [in] containingMemoryMap The base memory map containing the registers. + * @param [in] stream The text stream to write into. + * @param [in] useAddressBlockID Tells if an address block id is needed for the register name. + * @param [in] offset The current offset. + * @param [in] idString Helps to identify non-unique registers. */ void writeRegisterFromMemoryMap(QSharedPointer finder, QSharedPointer containingMemoryMap, QTextStream& stream, bool useAddressBlockID, @@ -116,13 +116,13 @@ class BaseMemoryMapHeaderWriter /*! * Write registers contained in an address block. * - * @param [in] expressionParser The expression parser. - * @param [in] formatter The expression formatter, for changing parameter ids into names. - * @param [in] currentAddressBlock Pointer to the address block. - * @param [in] stream The text stream to write into. - * @param [in] useAddressBlockID Tells if an address block id is needed for the register name. - * @param [in] offset The current offset. - * @param [in] idString Helps to identify non-unique registers. + * @param [in] expressionParser The expression parser. + * @param [in] formatter The expression formatter, for changing parameter ids into names. + * @param [in] currentAddressBlock Pointer to the address block. + * @param [in] stream The text stream to write into. + * @param [in] useAddressBlockID Tells if an address block id is needed for the register name. + * @param [in] offset The current offset. + * @param [in] idString Helps to identify non-unique registers. */ void writeRegistersFromAddressBlock(QSharedPointer expressionParser, QSharedPointer formatter, QSharedPointer currentAddressBlock, @@ -131,12 +131,12 @@ class BaseMemoryMapHeaderWriter /*! * Write the register information to a text stream. * - * @param [in] expressionParser The expression parser. - * @param [in] formatter The expression formatter, used to change parameter ids into names. - * @param [in] currentRegister The current register. - * @param [in] stream The text stream to write into. - * @param [in] addressBlockOffset The current offset. - * @param [in] idString Helps to identify non-unique registers. + * @param [in] expressionParser The expression parser. + * @param [in] formatter The expression formatter, used to change parameter ids into names. + * @param [in] currentRegister The current register. + * @param [in] stream The text stream to write into. + * @param [in] addressBlockOffset The current offset. + * @param [in] idString Helps to identify non-unique registers. */ void writeRegister(QSharedPointer expressionParser, QSharedPointer formatter, QSharedPointer currentRegister, QTextStream& stream, @@ -145,11 +145,11 @@ class BaseMemoryMapHeaderWriter /*! * Write the memory names and given addresses. * - * @param [in] finder The parameter finder containing the referenced parameters. - * @param [in] targetMemoryMap The used base memory map. - * @param [in] stream The text stream to write into. - * @param [in] offset The current offset. - * @param [in] idString Helps to identify non-unique elements. + * @param [in] finder The parameter finder containing the referenced parameters. + * @param [in] targetMemoryMap The used base memory map. + * @param [in] stream The text stream to write into. + * @param [in] offset The current offset. + * @param [in] idString Helps to identify non-unique elements. */ void writeMemoryAddresses(QSharedPointer finder, QSharedPointer targetMemoryMap, QTextStream& stream, quint64 offset, @@ -158,10 +158,10 @@ class BaseMemoryMapHeaderWriter /*! * Gets the ending address of an address block. * - * @param [in] targetAddressBlock The address block being examined. - * @param [in] expressionParser The expression parser. + * @param [in] targetAddressBlock The address block being examined. + * @param [in] expressionParser The expression parser. * - * @return The ending address of the address block. + * @return The ending address of the address block. */ QString getAddressBlockLastAddress(QSharedPointer targetAddressBlock, QSharedPointer expressionParser) const; @@ -169,10 +169,10 @@ class BaseMemoryMapHeaderWriter /*! * Get the parsed value for a given expression. * - * @param [in] expression The expression to be parsed. - * @param [in] finder The parameter finder used in the parser. + * @param [in] expression The expression to be parsed. + * @param [in] finder The parameter finder used in the parser. * - * @return The parsed value for the given expression. + * @return The parsed value for the given expression. */ QString parsedValueFor(QString const& expression, QSharedPointer finder) const; @@ -184,7 +184,7 @@ class BaseMemoryMapHeaderWriter /*! * Inform when the writing has been finished. * - * @param [in] outputFile The name of the output file. + * @param [in] outputFile The name of the output file. */ void informWritingFinished(QString const& outputFile) const; diff --git a/Plugins/MemoryMapHeaderGenerator/GlobalMemoryMapHeaderWriter.h b/Plugins/MemoryMapHeaderGenerator/GlobalMemoryMapHeaderWriter.h index fbde28a71..8b66e2eba 100644 --- a/Plugins/MemoryMapHeaderGenerator/GlobalMemoryMapHeaderWriter.h +++ b/Plugins/MemoryMapHeaderGenerator/GlobalMemoryMapHeaderWriter.h @@ -45,10 +45,10 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * The constructor. * - * @param [in] utility The interface which offers core utilities for plugins. - * @param [in] componentDesign The design currently in use. - * @param [in] componentDesignConfig The design configuration currently in use. - * @param [in] parentObject The parent object of this writer. + * @param [in] utility The interface which offers core utilities for plugins. + * @param [in] componentDesign The design currently in use. + * @param [in] componentDesignConfig The design configuration currently in use. + * @param [in] parentObject The parent object of this writer. */ GlobalMemoryMapHeaderWriter(IPluginUtility* utility, QSharedPointer componentDesign, QSharedPointer componentDesignConfig, QObject* parentObject); @@ -61,8 +61,8 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Write the memory map header into a file. * - * @param [in] globalComponent The top component of the design. - * @param [in] saveOptions The save options for the memory map header. + * @param [in] globalComponent The top component of the design. + * @param [in] saveOptions The save options for the memory map header. */ virtual void writeMemoryMapHeader(QSharedPointer globalComponent, QList saveOptions); @@ -72,7 +72,7 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Display the created memory map header. * - * @param [in] filePath The file path. + * @param [in] filePath The file path. */ virtual void displayMemoryMapHeader(QString const& filePath) const; @@ -87,19 +87,19 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Parse the interface and its connections. * - * @param [in] offset The current offset. - * @param [in] stream The text stream to write into. - * @param [in] interface Identifies the current interface to parse. + * @param [in] offset The current offset. + * @param [in] stream The text stream to write into. + * @param [in] interface Identifies the current interface to parse. */ void parseInterface(qint64 offset, QTextStream& stream, QSharedPointer interface); /*! * Parse the master interface. * - * @param [in] offset The current offset. - * @param [in] component The component in use. - * @param [in] stream The text stream to write into. - * @param [in] interFace Identifies the current interface to parse. + * @param [in] offset The current offset. + * @param [in] component The component in use. + * @param [in] stream The text stream to write into. + * @param [in] interFace Identifies the current interface to parse. */ void parseMasterInterface(qint64 offset, QSharedPointer component, QTextStream& stream, QSharedPointer interface); @@ -107,10 +107,10 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Parse the slave interface. * - * @param [in] offset The current offset. - * @param [in] component The component in use. - * @param [in] stream The text stream to write into. - * @param [in] interFace Identifies the current interface to parse. + * @param [in] offset The current offset. + * @param [in] component The component in use. + * @param [in] stream The text stream to write into. + * @param [in] interFace Identifies the current interface to parse. */ void parseSlaveInterface(qint64 offset, QSharedPointer component, QTextStream& stream, QSharedPointer interface); @@ -118,10 +118,10 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Parse the mirrored slave interface. * - * @param [in] offset The current offset. - * @param [in] component The component in use. - * @param [in] stream The text stream to write into. - * @param [in] interFace Identifies the current interface to parse. + * @param [in] offset The current offset. + * @param [in] component The component in use. + * @param [in] stream The text stream to write into. + * @param [in] interFace Identifies the current interface to parse. */ void parseMirroredSlaveInterface(qint64 offset, QSharedPointer component, QTextStream& stream, QSharedPointer interface); @@ -129,10 +129,10 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Parse the mirrored master interface. * - * @param [in] offset The current offset. - * @param [in] component The component in use. - * @param [in] stream The text stream to write into. - * @param [in] interFace Identifies the current interface to parse. + * @param [in] offset The current offset. + * @param [in] component The component in use. + * @param [in] stream The text stream to write into. + * @param [in] interFace Identifies the current interface to parse. */ void parseMirroredMasterInterface(qint64 offset, QSharedPointer component, QTextStream& stream, QSharedPointer interface); @@ -140,10 +140,10 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Creates the parameter finder using configurable element values of the instance. * - * @param [in] instanceID The uuid of the instance of the configurable element values. - * @param [in] component The component of the instance. + * @param [in] instanceID The uuid of the instance of the configurable element values. + * @param [in] component The component of the instance. * - * @return A list parameter finder containing the configurable element values of the instance. + * @return A list parameter finder containing the configurable element values of the instance. */ QSharedPointer createParameterFinder(QString const& instanceID, QSharedPointer component); @@ -151,27 +151,27 @@ class GlobalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Gets the uuid of an instance. * - * @param [in] interfaceReference The name of the component instance. + * @param [in] interfaceReference The name of the component instance. * - * @return Uuid of the instance. + * @return Uuid of the instance. */ QString getInstanceID(QString const& interfaceReference) const; /*! * Get configurable elements from the selected instance. * - * @param [in] instanceId The id of the selected instance. + * @param [in] instanceId The id of the selected instance. * - * @return Map containing the configurable elements from the selected instance as ID / value pairs. + * @return Map containing the configurable elements from the selected instance as ID / value pairs. */ QMap getConfigurableElementsFromInstance(QString const& instanceId) const; /*! * Get the connected interfaces. * - * @param [in] interface The start point interface of the connection. + * @param [in] interface The start point interface of the connection. * - * @return A list of interfaces connected to the selected interface. + * @return A list of interfaces connected to the selected interface. */ QList > getConnectedInterfaces(QSharedPointer interface); diff --git a/Plugins/MemoryMapHeaderGenerator/LocalMemoryMapHeaderWriter.h b/Plugins/MemoryMapHeaderGenerator/LocalMemoryMapHeaderWriter.h index 0815e36af..9066e199f 100644 --- a/Plugins/MemoryMapHeaderGenerator/LocalMemoryMapHeaderWriter.h +++ b/Plugins/MemoryMapHeaderGenerator/LocalMemoryMapHeaderWriter.h @@ -36,9 +36,9 @@ class LocalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * The constructor. * - * @param [in] utility The interface which offers core utilities for plugins. - * @param [in] localComponent The selected component. - * @param [in] parentObject The parent object of this writer. + * @param [in] utility The interface which offers core utilities for plugins. + * @param [in] localComponent The selected component. + * @param [in] parentObject The parent object of this writer. */ LocalMemoryMapHeaderWriter(IPluginUtility* utility, QSharedPointer localComponent, QObject* parentObject); @@ -51,7 +51,7 @@ class LocalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Write the memory map header file. * - * @param [in] saveOptions The save options for the memory map header. + * @param [in] saveOptions The save options for the memory map header. */ virtual void writeMemoryMapHeader(QList saveOptions); @@ -60,7 +60,7 @@ class LocalMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Display the created memory map header. * - * @param [in] filePath The file path to the memory map header. + * @param [in] filePath The file path to the memory map header. */ virtual void displayMemoryMapHeader(QString const& filePath) const; diff --git a/Plugins/MemoryMapHeaderGenerator/SystemMemoryMapHeaderWriter.h b/Plugins/MemoryMapHeaderGenerator/SystemMemoryMapHeaderWriter.h index 9077b786d..2673adeef 100644 --- a/Plugins/MemoryMapHeaderGenerator/SystemMemoryMapHeaderWriter.h +++ b/Plugins/MemoryMapHeaderGenerator/SystemMemoryMapHeaderWriter.h @@ -45,8 +45,8 @@ class SystemMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * The constructor. * - * @param [in] utility The interface which offers core utilites for plugins. - * @param [in] parentObject The parent object of this writer. + * @param [in] utility The interface which offers core utilites for plugins. + * @param [in] parentObject The parent object of this writer. */ SystemMemoryMapHeaderWriter(IPluginUtility* utility, QObject* parentObject); @@ -58,9 +58,9 @@ class SystemMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Write the memory map header file. * - * @param [in] component The component whose header file is being written. - * @param [in] designConfiguration The design configuration for the component. - * @param [in] design The designg for the component. + * @param [in] component The component whose header file is being written. + * @param [in] designConfiguration The design configuration for the component. + * @param [in] design The designg for the component. */ virtual void writeMemoryMapHeader(QSharedPointer component, QSharedPointer designConfiguration, QSharedPointer design); @@ -78,16 +78,16 @@ class SystemMemoryMapHeaderWriter : public BaseMemoryMapHeaderWriter /*! * Search the CPU instances and their containing component to find the generated global headers. * - * @param [in] component Pointer to the hierarchical component to search. - * @param [in] hwViewName The name of the hierarchical view on the component. + * @param [in] component Pointer to the hierarchical component to search. + * @param [in] hwViewName The name of the hierarchical view on the component. */ void searchInstanceFiles(QSharedPointer component, const QString& hwViewName); /*! * Find the system view currently used in the system design. * - * @param [in] component The component whose system view is in use. - * @param [in] designConfiguration The design configuration of the component. + * @param [in] component The component whose system view is in use. + * @param [in] designConfiguration The design configuration of the component. */ QSharedPointer findSystemView(QSharedPointer component, QSharedPointer designConfiguration) const; diff --git a/Plugins/MemoryMapHeaderGenerator/globalheadersavemodel.h b/Plugins/MemoryMapHeaderGenerator/globalheadersavemodel.h index 7de4356db..7d49bcc7f 100644 --- a/Plugins/MemoryMapHeaderGenerator/globalheadersavemodel.h +++ b/Plugins/MemoryMapHeaderGenerator/globalheadersavemodel.h @@ -65,8 +65,8 @@ class GlobalHeaderSaveModel : public QAbstractTableModel /*! * The constructor * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of the model. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of the model. */ GlobalHeaderSaveModel(LibraryInterface* handler, QObject *parent); @@ -76,74 +76,74 @@ class GlobalHeaderSaveModel : public QAbstractTableModel /*! * Set the design for which the global headers are generated. * - * @param [in] topComp Pointer to the component which contains the design. - * @param [in] design Pointer to the design which instantiates the components. + * @param [in] topComp Pointer to the component which contains the design. + * @param [in] design Pointer to the design which instantiates the components. */ void setDesign(QSharedPointer topComp, QSharedPointer design); /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the options defining locations for headers to generate. * - * @return QList containing the save options. + * @return QList containing the save options. */ const QList& getHeaderOptions() const; diff --git a/Plugins/MemoryMapHeaderGenerator/localheadersavedelegate.h b/Plugins/MemoryMapHeaderGenerator/localheadersavedelegate.h index 8a2b7dc6b..be0ec2ad5 100644 --- a/Plugins/MemoryMapHeaderGenerator/localheadersavedelegate.h +++ b/Plugins/MemoryMapHeaderGenerator/localheadersavedelegate.h @@ -29,8 +29,8 @@ class LocalHeaderSaveDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] component Pointer to the component to generate the headers for. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] component Pointer to the component to generate the headers for. + * @param [in] parent Pointer to the owner of the delegate. */ LocalHeaderSaveDelegate(QSharedPointer component, QObject *parent); @@ -40,11 +40,11 @@ class LocalHeaderSaveDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -52,17 +52,17 @@ class LocalHeaderSaveDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; diff --git a/Plugins/MemoryMapHeaderGenerator/localheadersavemodel.h b/Plugins/MemoryMapHeaderGenerator/localheadersavemodel.h index da067028d..214103655 100644 --- a/Plugins/MemoryMapHeaderGenerator/localheadersavemodel.h +++ b/Plugins/MemoryMapHeaderGenerator/localheadersavemodel.h @@ -57,8 +57,8 @@ class LocalHeaderSaveModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of the model. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of the model. */ LocalHeaderSaveModel(LibraryInterface* handler, QObject *parent); @@ -68,73 +68,73 @@ class LocalHeaderSaveModel : public QAbstractTableModel /*! * Set the component in which the local memory maps are displayed. * - * @param [in] component The pointer to the component to create the local memory maps for. + * @param [in] component The pointer to the component to create the local memory maps for. */ void setComponent(QSharedPointer component); /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the options defining locations for headers to generate. * - * @return QList containing the save options. + * @return QList containing the save options. */ const QList& getHeaderOptions() const; diff --git a/Plugins/MemoryMapHeaderGenerator/memorymapheadergenerator.h b/Plugins/MemoryMapHeaderGenerator/memorymapheadergenerator.h index d60a1ed79..eacb5ae1d 100644 --- a/Plugins/MemoryMapHeaderGenerator/memorymapheadergenerator.h +++ b/Plugins/MemoryMapHeaderGenerator/memorymapheadergenerator.h @@ -55,49 +55,49 @@ class MEMORYMAPHEADERGENERATOR_EXPORT MemoryMapHeaderGenerator : public QObject, /*! * Get the name of the plugin. * - * @return The name of the plugin. + * @return The name of the plugin. */ virtual QString getName() const; /*! * Get the version of the plugin. * - * @return The version of the plugin. + * @return The version of the plugin. */ virtual QString getVersion() const; /*! * Get the description of the plugin. * - * @return The description of the plugin. + * @return The description of the plugin. */ virtual QString getDescription() const; /*! * Get the vendor of the plugin. * - * @return The vendor of the plugin. + * @return The vendor of the plugin. */ virtual QString getVendor() const; /*! * Get the license of the plugin. * - * @return The license of the plugin. + * @return The license of the plugin. */ virtual QString getLicense() const; /*! * Get the holder of the license of the plugin. * - * @return The holder of the license of the plugin. + * @return The holder of the license of the plugin. */ virtual QString getLicenseHolder() const; /*! * Get the settings widget for the plugin. * - * @return The plugin settings widget. + * @return The plugin settings widget. */ virtual QWidget* getSettingsWidget(); @@ -109,19 +109,19 @@ class MEMORYMAPHEADERGENERATOR_EXPORT MemoryMapHeaderGenerator : public QObject, /*! * Get the icon for the generator. * - * @return The icon for the generator. + * @return The icon for the generator. */ virtual QIcon getIcon() const; /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -131,11 +131,11 @@ class MEMORYMAPHEADERGENERATOR_EXPORT MemoryMapHeaderGenerator : public QObject, * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -145,27 +145,27 @@ class MEMORYMAPHEADERGENERATOR_EXPORT MemoryMapHeaderGenerator : public QObject, /*! * Get the external program requirements of the plugin. * - * @return A list of external program requirements. + * @return A list of external program requirements. */ virtual QList getProgramRequirements(); /*! * Set the save options for a local writer. * - * @param [in] localMemoryMap The local memory map of an address space. - * @param [in] fileInfo The file information for the header file. - * @param [in] swViewName The name of the sw view. + * @param [in] localMemoryMap The local memory map of an address space. + * @param [in] fileInfo The file information for the header file. + * @param [in] swViewName The name of the sw view. */ void setLocalSaveFileOptions(QSharedPointer localMemoryMap, QFileInfo fileInfo, QString swViewName); /*! * Set the save options for a global writer. * - * @param [in] component The top component of the design. - * @param [in] instanceName The name of the instance containing the interface. - * @param [in] instanceId The id of the instance. - * @param [in] masterInterfaceName The name of the master interface to create the header for. - * @param [in] fileInfo The file information for the header file. + * @param [in] component The top component of the design. + * @param [in] instanceName The name of the instance containing the interface. + * @param [in] instanceId The id of the instance. + * @param [in] masterInterfaceName The name of the master interface to create the header for. + * @param [in] fileInfo The file information for the header file. */ void setGlobalSaveFileOptions(QSharedPointer component, QString const& instanceName, QString const& instanceId, QString const& masterInterfaceName, QFileInfo fileInfo); diff --git a/Plugins/MemoryViewGenerator/MemoryViewGenerator.h b/Plugins/MemoryViewGenerator/MemoryViewGenerator.h index d7f204342..858b6284c 100755 --- a/Plugins/MemoryViewGenerator/MemoryViewGenerator.h +++ b/Plugins/MemoryViewGenerator/MemoryViewGenerator.h @@ -55,8 +55,8 @@ class MEMORYVIEWGENERATOR_EXPORT MemoryViewGenerator /*! * Generates slave memory listing for the given component. * - * @param [in] topComponent The top component in the hierarchy to generate listing for. - * @param [in] outputPath Path to the output file. + * @param [in] topComponent The top component in the hierarchy to generate listing for. + * @param [in] outputPath Path to the output file. */ void generate(QSharedPointer topComponent, QString const& activeView, QString const& outputPath); @@ -69,16 +69,16 @@ class MEMORYVIEWGENERATOR_EXPORT MemoryViewGenerator /*! * Writes the listing into a given file. * - * @param [in] outputPath The path to the output file. + * @param [in] outputPath The path to the output file. */ void writeFile(QString const& outputPath, QVector > > masterRoutes); /*! * Writes the given memory element into output. * - * @param [in] item The memory element to write. - * @param [in] addressOffset Offset for the memory item. - * @param [in] outputStream The output to write the element into. + * @param [in] item The memory element to write. + * @param [in] addressOffset Offset for the memory item. + * @param [in] outputStream The output to write the element into. */ void writeItem(QSharedPointer item, int addressOffset, QTextStream& outputStream); diff --git a/Plugins/MemoryViewGenerator/MemoryViewGeneratorPlugin.h b/Plugins/MemoryViewGenerator/MemoryViewGeneratorPlugin.h index 516d6d46d..4ebf16a5a 100644 --- a/Plugins/MemoryViewGenerator/MemoryViewGeneratorPlugin.h +++ b/Plugins/MemoryViewGenerator/MemoryViewGeneratorPlugin.h @@ -76,12 +76,12 @@ class MEMORYVIEWGENERATOR_EXPORT MemoryViewGeneratorPlugin : public QObject, pub /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -91,11 +91,11 @@ class MEMORYVIEWGENERATOR_EXPORT MemoryViewGeneratorPlugin : public QObject, pub * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -110,11 +110,11 @@ class MEMORYVIEWGENERATOR_EXPORT MemoryViewGeneratorPlugin : public QObject, pub /*! * Saves the generated file to top component fileset. * - * @param [in] targetFile The generated file path. - * @param [in] component The top level component. - * @param [in] utility The plugin utility interface. + * @param [in] targetFile The generated file path. + * @param [in] component The top level component. + * @param [in] utility The plugin utility interface. * - * @return . + * @return . */ void saveToFileset(QString const& targetFile, QSharedPointer component, IPluginUtility* utility); }; diff --git a/Plugins/ModelSimGenerator/ModelSimGeneratorPlugin.h b/Plugins/ModelSimGenerator/ModelSimGeneratorPlugin.h index 0fe358688..85a9121af 100644 --- a/Plugins/ModelSimGenerator/ModelSimGeneratorPlugin.h +++ b/Plugins/ModelSimGenerator/ModelSimGeneratorPlugin.h @@ -86,12 +86,12 @@ class MODELSIMGENERATOR_EXPORT ModelSimGeneratorPlugin : public QObject, public /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -101,11 +101,11 @@ class MODELSIMGENERATOR_EXPORT ModelSimGeneratorPlugin : public QObject, public * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -115,12 +115,12 @@ class MODELSIMGENERATOR_EXPORT ModelSimGeneratorPlugin : public QObject, public /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration, @@ -129,7 +129,7 @@ class MODELSIMGENERATOR_EXPORT ModelSimGeneratorPlugin : public QObject, public /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const override; diff --git a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimDocument.h b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimDocument.h index 8acb8379b..be4ce6a3b 100644 --- a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimDocument.h +++ b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimDocument.h @@ -34,15 +34,15 @@ struct ModelSimDocument : public GenerationOutput /*! * Writes the content. * - * @param [in] outputDirectory The possible output directory. + * @param [in] outputDirectory The possible output directory. */ void write(QString const& outputDirectory); /*! * Finds position for body text highlight in document, if any exists. * - * @param [out] begin The position where the highlight begins, if successful. - * @param [out] end The position where the highlight ends, if successful. + * @param [out] begin The position where the highlight begins, if successful. + * @param [out] end The position where the highlight ends, if successful. */ void getBodyHighlight(int& begin, int& end) const; diff --git a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriter.h b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriter.h index e12d014a2..db3f1c1c9 100644 --- a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriter.h +++ b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriter.h @@ -27,7 +27,7 @@ struct ModelSimWriter /*! * Writes the content to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ void write(QTextStream& output, QString const& outputDirectory) const; diff --git a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriterFactory.h b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriterFactory.h index 49a6f9ad2..3397778e3 100644 --- a/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriterFactory.h +++ b/Plugins/ModelSimGenerator/ModelSimWriterFactory/ModelSimWriterFactory.h @@ -28,11 +28,11 @@ class ModelSimWriterFactory : public IWriterFactory /*! * The constructor. * - * @param [in] library The component library. - * @param [in] messages For message output. - * @param [in] settings Points to the settings to be used within the generation. - * @param [in] kactusVersion The version of the current Kactus build. - * @param [in] generatorVersion The current version of the generator. + * @param [in] library The component library. + * @param [in] messages For message output. + * @param [in] settings Points to the settings to be used within the generation. + * @param [in] kactusVersion The version of the current Kactus build. + * @param [in] generatorVersion The current version of the generator. */ ModelSimWriterFactory(LibraryInterface* library, MessageMediator* messages, GenerationSettings* settings, @@ -48,10 +48,10 @@ class ModelSimWriterFactory : public IWriterFactory /*! * Creates writers for the given formatted HDL component. * - * @param [in] outputPath The path to the output file. - * @param [in] component The component which is needs writing. + * @param [in] outputPath The path to the output file. + * @param [in] component The component which is needs writing. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QSharedPointer prepareComponent(QString const& outputPath, QSharedPointer component); @@ -59,9 +59,9 @@ class ModelSimWriterFactory : public IWriterFactory /*! * Creates writers for the given parsed meta design. * - * @param [in] design The design which is needs writing. + * @param [in] design The design which is needs writing. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QList > prepareDesign(QList >& designs); diff --git a/Plugins/PadsPartGenerator/PadsPartGenerator.h b/Plugins/PadsPartGenerator/PadsPartGenerator.h index e2e8ad8e5..be76d5291 100644 --- a/Plugins/PadsPartGenerator/PadsPartGenerator.h +++ b/Plugins/PadsPartGenerator/PadsPartGenerator.h @@ -101,12 +101,12 @@ class PadsPartGenerator : public QObject, public IGeneratorPlugin /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -116,11 +116,11 @@ class PadsPartGenerator : public QObject, public IGeneratorPlugin * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -135,40 +135,40 @@ class PadsPartGenerator : public QObject, public IGeneratorPlugin /*! * Writes the PADS part file. * - * @param [in] file The file to write to. - * @param [in] partDescription The part description to write. + * @param [in] file The file to write to. + * @param [in] partDescription The part description to write. * - * @return True, if part file was successfully written, otherwise false. + * @return True, if part file was successfully written, otherwise false. */ bool generatePartFile(QFile* file, QString const& partDescription); /*! * Writes the PADS CAE decal file. * - * @param [in] file The file to write to. - * @param [in] partTitle The part title displayed on all gates. - * @param [in] partDescription The PADS part description. + * @param [in] file The file to write to. + * @param [in] partTitle The part title displayed on all gates. + * @param [in] partDescription The PADS part description. * - * @return True, if CAE file was successfully written, otherwise false. + * @return True, if CAE file was successfully written, otherwise false. */ bool generateCAEFile(QFile* file, QString const& partTitle, QString const& partDescription); /*! * Generates the CAE decal terminals and prints them into an output stream. * - * @param [in] output The output stream for generation. - * @param [in] drawSymbol The rectangle used as a drawing symbol for decal. - * @param [in] pinCount The number of terminals in the decal. + * @param [in] output The output stream for generation. + * @param [in] drawSymbol The rectangle used as a drawing symbol for decal. + * @param [in] pinCount The number of terminals in the decal. */ void insertCAETerminals( QTextStream& output, QRect const& drawSymbol, int pinCount ); /*! * Generates the CAE decal and prints it into an output stream. * - * @param [in] output The output stream for generation. - * @param [in] drawSymbol The rectangle used as a drawing symbol for decal. - * @param [in] gateTitle The title of the gate. - * @param [in] gateName The name of the gate used as a decal name. + * @param [in] output The output stream for generation. + * @param [in] drawSymbol The rectangle used as a drawing symbol for decal. + * @param [in] gateTitle The title of the gate. + * @param [in] gateName The name of the gate used as a decal name. */ void insertCAEDecal(QTextStream& output, QRect const& drawSymbol, QString const& gateTitle, QString const& gateName); @@ -177,10 +177,10 @@ class PadsPartGenerator : public QObject, public IGeneratorPlugin /*! * Generates the CAE header lines and prints them into an output stream. * - * @param [in] output The output stream for generation. - * @param [in] timestamp Header line with timestamp to insert. - * @param [in] gateName The name of the gate used as a decal name. - * @param [in] pinCount The number of terminals in the decal. + * @param [in] output The output stream for generation. + * @param [in] timestamp Header line with timestamp to insert. + * @param [in] gateName The name of the gate used as a decal name. + * @param [in] pinCount The number of terminals in the decal. */ void insertCAEHeader( QTextStream& output, QString const& timestamp, QString const& gateName, int pinCount ); @@ -190,12 +190,12 @@ class PadsPartGenerator : public QObject, public IGeneratorPlugin /*! * Adds a file to a file set with defined file types. * - * @param [in] fileSet The file set. - * @param [in] filePath The path to file which is added. - * @param [in] basePath The base path of the component xlm file. - * @param [in] fileTypes The filetypes of the added file. + * @param [in] fileSet The file set. + * @param [in] filePath The path to file which is added. + * @param [in] basePath The base path of the component xlm file. + * @param [in] fileTypes The filetypes of the added file. * - * @return True, if the file was successfully added to file set, otherwise false. + * @return True, if the file was successfully added to file set, otherwise false. */ bool addFileToFileset(QSharedPointer fileSet, QString const& filePath, QString const& basePath, const QStringList& fileTypes); diff --git a/Plugins/PadsPartGenerator/PadsPartGeneratorDialog.h b/Plugins/PadsPartGenerator/PadsPartGeneratorDialog.h index f52a716bb..b93109cda 100644 --- a/Plugins/PadsPartGenerator/PadsPartGeneratorDialog.h +++ b/Plugins/PadsPartGenerator/PadsPartGeneratorDialog.h @@ -47,14 +47,14 @@ class PadsPartGeneratorDialog : public QDialog /*! * The constructor. * - * @param [in] libIf The library interface. - * @param [in] component The component for which generation is done. - * @param [in] expressionParser The parser for expressions. - * @param [in] generatorName The utilizing generator name. - * @param [in] generatorVersion The utilizing generator version. - * @param [in] parent The parent widget. + * @param [in] libIf The library interface. + * @param [in] component The component for which generation is done. + * @param [in] expressionParser The parser for expressions. + * @param [in] generatorName The utilizing generator name. + * @param [in] generatorVersion The utilizing generator version. + * @param [in] parent The parent widget. * - * @return + * @return */ PadsPartGeneratorDialog(LibraryInterface* libIf, QSharedPointer component, QSharedPointer expressionParser, @@ -68,28 +68,28 @@ class PadsPartGeneratorDialog : public QDialog /*! * Returns the name for the generated part. * - * @return The name of the part. + * @return The name of the part. */ QString getPartName() const; /*! * Returns the name of the target fileset. * - * @return Name of the selected fileset. + * @return Name of the selected fileset. */ QString getFileSetName() const; /*! * Returns the text in the preview. * - * @return the preview text. + * @return the preview text. */ QString getPreviewText(); /*! * Returns the selected gate generation type (single/multiple). * - * @return The selected type. + * @return The selected type. */ gateGenerationType getGategenerationType() const; @@ -108,18 +108,18 @@ public slots: /*! * Count the number of physical pins in a bus interface. * - * @param [in] busInterface The bus interface whose physical pins to count. + * @param [in] busInterface The bus interface whose physical pins to count. * - * @return The number of physical pins in the interface. + * @return The number of physical pins in the interface. */ int countInterfacePins(QSharedPointer busInterface); /*! * Count the number of physical pins in a port map. * - * @param [in] portMap The port map whose physical pins to count. + * @param [in] portMap The port map whose physical pins to count. * - * @return The number of physical pins in the port map. + * @return The number of physical pins in the port map. */ int countPortMapPins(QSharedPointer portMap); @@ -170,35 +170,35 @@ private slots: /*! * Adds pin declarations for interface ports. * - * @param [in] busInterface The interface whose ports to add. - * @param [in] cursor Cursor to the correct position in preview. + * @param [in] busInterface The interface whose ports to add. + * @param [in] cursor Cursor to the correct position in preview. */ void insertPins(QSharedPointer busInterface, QTextCursor &cursor); /*! * Adds a gate declaration. * - * @param [in] name The name of the gate. - * @param [in] decals Number of decals for the gate. - * @param [in] pins Number of pins in the gate. - * @param [in] gateswap Gate swap type. - * @param [in] cursor Cursor to the correct position in preview. + * @param [in] name The name of the gate. + * @param [in] decals Number of decals for the gate. + * @param [in] pins Number of pins in the gate. + * @param [in] gateswap Gate swap type. + * @param [in] cursor Cursor to the correct position in preview. */ void insertGate(QString const& name, int decals, int pins, int gateswap, QTextCursor &cursor); /*! * Inserts a line of text to the preview. * - * @param [in] line The line to insert. - * @param [in] cursor Cursor to the correct position in preview. - * @param [in] validatingExp RegExp for checking the line correctness. + * @param [in] line The line to insert. + * @param [in] cursor Cursor to the correct position in preview. + * @param [in] validatingExp RegExp for checking the line correctness. */ void insertLine(QString const& line, QTextCursor cursor, QRegularExpression const& validatingExp = QRegularExpression() ); /*! * Inserts part attributes to the preview. * - * @param [in] cursor Cursor to the correct position in preview. + * @param [in] cursor Cursor to the correct position in preview. */ void insertAttributes( QTextCursor& cursor ); diff --git a/Plugins/PluginSystem/GeneratorPlugin/FileOutputWidget.h b/Plugins/PluginSystem/GeneratorPlugin/FileOutputWidget.h index 6d6f06c4a..b20bd7049 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/FileOutputWidget.h +++ b/Plugins/PluginSystem/GeneratorPlugin/FileOutputWidget.h @@ -32,7 +32,7 @@ class FileOutputWidget : public QWidget /*! * Checks if the output setting can be accepted. * - * @return True, if acceptable, otherwise false. + * @return True, if acceptable, otherwise false. */ bool canAccept() const; @@ -47,7 +47,7 @@ class FileOutputWidget : public QWidget /*! * Informs of filename change. * - * @param [in] fileIndex Index of the changed file. + * @param [in] fileIndex Index of the changed file. */ void fileNameChanged(int const& fileIndex); diff --git a/Plugins/PluginSystem/GeneratorPlugin/GenerationControl.h b/Plugins/PluginSystem/GeneratorPlugin/GenerationControl.h index 315458b53..4692bb504 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/GenerationControl.h +++ b/Plugins/PluginSystem/GeneratorPlugin/GenerationControl.h @@ -61,7 +61,7 @@ class GenerationControl /*! * Checks if the generation configuration is valid. * - * @param [out] warning The stated reason for not accepting. + * @param [out] warning The stated reason for not accepting. */ bool validSelections(QString &warning); @@ -98,18 +98,18 @@ class GenerationControl /*! * Finds the possible views for generation. * - * @param [in] input The relevant IP-XACT documents. + * @param [in] input The relevant IP-XACT documents. * - * @return List of possible view names for which to run the generation. + * @return List of possible view names for which to run the generation. */ static QSharedPointer > > findPossibleViews(GenerationTuple input); /*! * Reconfigure the selected file. * - * @param [in] fileIndex Index of the selected file. + * @param [in] fileIndex Index of the selected file. * - * @return The reconfigured file output. + * @return The reconfigured file output. */ QSharedPointer setupRenamedSelection(int const& fileIndex); @@ -118,9 +118,9 @@ class GenerationControl /*! * Finds the possible views for generation. * - * @param [in,out] targetComponent The component for which the generator is run. + * @param [in,out] targetComponent The component for which the generator is run. * - * @return List of possible view names for which to run the generation. + * @return List of possible view names for which to run the generation. */ QSharedPointer > > findPossibleViews(QSharedPointer targetComponent) const; @@ -134,16 +134,16 @@ class GenerationControl /*! * Re-initialize the generation documents. * - * @param [in] generationOutputs Current documents. + * @param [in] generationOutputs Current documents. */ void reInitializeDocuments(QSharedPointer > > generationOutputs); /*! * Get the existing generation output matching the selected generation output. * - * @param [in] output The selected generation output. + * @param [in] output The selected generation output. * - * @return The matching generation output. + * @return The matching generation output. */ QSharedPointer getMatchingMetaDesignOutput(QSharedPointer output) const; @@ -155,16 +155,16 @@ class GenerationControl /*! * Gets the relative path from the top component xml file to the given absolute path. * - * @param [in] filePath The absolute path to the target file. + * @param [in] filePath The absolute path to the target file. * - * @return Relative path from the top component xml file to the target file. + * @return Relative path from the top component xml file to the target file. */ QString relativePathFromXmlToFile(QString const& filePath) const; /*! * Inserts description to a generated file. * - * @param [in] file The file which needs to be described. + * @param [in] file The file which needs to be described. */ void insertFileDescription(QSharedPointer file); diff --git a/Plugins/PluginSystem/GeneratorPlugin/HDLGenerationDialog.h b/Plugins/PluginSystem/GeneratorPlugin/HDLGenerationDialog.h index adf99a729..5dcc9098c 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/HDLGenerationDialog.h +++ b/Plugins/PluginSystem/GeneratorPlugin/HDLGenerationDialog.h @@ -42,7 +42,7 @@ class HDLGenerationDialog : public QDialog /*! * Sets syntax highlighter for the generation preview. * - * @param [in] highlighter The highlighter to use for preview. + * @param [in] highlighter The highlighter to use for preview. */ void setPreviewHighlighter(QSyntaxHighlighter* highlighter); @@ -62,7 +62,7 @@ private slots: /*! * Handle the file name change. * - * @param [in] itemIndex Index of the changed file. + * @param [in] itemIndex Index of the changed file. */ void onFileNameChanged(int const& itemIndex); diff --git a/Plugins/PluginSystem/GeneratorPlugin/IWriterFactory.h b/Plugins/PluginSystem/GeneratorPlugin/IWriterFactory.h index 1d8fd1b0a..674db138a 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/IWriterFactory.h +++ b/Plugins/PluginSystem/GeneratorPlugin/IWriterFactory.h @@ -28,10 +28,10 @@ class IWriterFactory /*! * Creates writers for the given formatted HDL component. * - * @param [in] outputPath The path to the output file. - * @param [in] component The component which is needs writing. + * @param [in] outputPath The path to the output file. + * @param [in] component The component which is needs writing. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QSharedPointer prepareComponent(QString const& outputPath, QSharedPointer component) = 0; @@ -39,9 +39,9 @@ class IWriterFactory /*! * Creates writers for the given meta designs. * - * @param [in] designs The designs that will yield documents. + * @param [in] designs The designs that will yield documents. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QList > prepareDesign(QList >& designs) = 0; diff --git a/Plugins/PluginSystem/GeneratorPlugin/OutputControl.h b/Plugins/PluginSystem/GeneratorPlugin/OutputControl.h index 927813062..49c4da057 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/OutputControl.h +++ b/Plugins/PluginSystem/GeneratorPlugin/OutputControl.h @@ -48,8 +48,8 @@ struct GenerationOutput /*! * Finds position for body text highlight in document, if any exists. * - * @param [out] begin The position where the highlight begins, if successful. - * @param [out] end The position where the highlight ends, if successful. + * @param [out] begin The position where the highlight begins, if successful. + * @param [out] end The position where the highlight ends, if successful. */ virtual void getBodyHighlight(int& begin, int& end) const = 0; }; @@ -70,21 +70,21 @@ class OutputControl /*! * Checks if the file output configuration is valid. * - * @param [out] warning The stated reason for not accepting. + * @param [out] warning The stated reason for not accepting. */ bool validSelections(QString &warning); /*! * Sets the path for the output file for the generation. * - * @param [in] path The path to set. + * @param [in] path The path to set. */ void setOutputPath(QString const& path); /*! * Gets the output path for generation. * - * @return The path to output file. + * @return The path to output file. */ QString getOutputPath() const; @@ -96,10 +96,10 @@ class OutputControl /*! * Tries to change the file name of an output. Will rewrite the content. * - * @param [in] index The position of the output within the list. - * @param [in] newName The would-be new name for the file. + * @param [in] index The position of the output within the list. + * @param [in] newName The would-be new name for the file. * - * @return The changed output if the change was successful. + * @return The changed output if the change was successful. */ QSharedPointer changeFileName(int index, QString const& newName); diff --git a/Plugins/PluginSystem/GeneratorPlugin/ViewSelection.h b/Plugins/PluginSystem/GeneratorPlugin/ViewSelection.h index 8dc8ab5f7..f0378f85b 100644 --- a/Plugins/PluginSystem/GeneratorPlugin/ViewSelection.h +++ b/Plugins/PluginSystem/GeneratorPlugin/ViewSelection.h @@ -41,7 +41,7 @@ class ViewSelection /*! * Checks if the view configuration is valid. * - * @param [out] warning The stated reason for not accepting. + * @param [out] warning The stated reason for not accepting. */ bool validSelections(QString &warning); @@ -63,7 +63,7 @@ class ViewSelection /*! * Sets the view for the top component in generation, if it exists. * - * @param [in] viewName The name of the active view. + * @param [in] viewName The name of the active view. */ void setView(QString const& viewName); @@ -90,14 +90,14 @@ class ViewSelection /*! * Sets the file set referred by the instantiation. * - * @param [in] fileSetRef The fileSetRef to set. + * @param [in] fileSetRef The fileSetRef to set. */ bool setFileSet(QString const& fileSetRef); /*! * Gets the file set referred by the instantiation. * - * @return The fileSetRef. + * @return The fileSetRef. */ QSharedPointer getFileSet() const; @@ -109,14 +109,14 @@ class ViewSelection /*! * Sets whether the output file should be added to top component file sets or not. * - * @param [in] shouldSave True for saving, false for not saving. + * @param [in] shouldSave True for saving, false for not saving. */ void setSaveToFileset(bool shouldSave); /*! * Checks if the output file should be added to top component file sets. * - * @return True, if file should be saved, false otherwise. + * @return True, if file should be saved, false otherwise. */ bool getSaveToFileset() const; diff --git a/Plugins/QuartusPinImportPlugin/QuartusPinImportPlugin.h b/Plugins/QuartusPinImportPlugin/QuartusPinImportPlugin.h index 82c061966..5b58461c2 100644 --- a/Plugins/QuartusPinImportPlugin/QuartusPinImportPlugin.h +++ b/Plugins/QuartusPinImportPlugin/QuartusPinImportPlugin.h @@ -82,48 +82,48 @@ class QUARTUSPINIMPORTPLUGIN_EXPORT QuartusPinImportPlugin : public QObject, /*! * Sets the given highlighter to be used by the plugin. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); /*! * Returns the supported import file types. * - * @return The file types the import plugin supports. + * @return The file types the import plugin supports. */ virtual QStringList getSupportedFileTypes() const; /*! * Gets any compatibility warnings for the plugin. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const; /*! * Get component declarations from the selected input file. * - * @param [in] input The selected input file. + * @param [in] input The selected input file. * - * @return List of component declarations found in the selected input. + * @return List of component declarations found in the selected input. */ virtual QStringList getFileComponents(QString const& input) const override final; /*! * Get the name of the selected component declaration. * - * @param [in] componentDeclaration The selected component declaration. + * @param [in] componentDeclaration The selected component declaration. * - * @return Name of the selected component declaration. + * @return Name of the selected component declaration. */ virtual QString getComponentName(QString const& componentDeclaration) const override final; /*! * Runs the import by parsing the given input and applying the parsed elements to the given component. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration Declaration of the selected component. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration Declaration of the selected component. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent); @@ -139,17 +139,17 @@ class QUARTUSPINIMPORTPLUGIN_EXPORT QuartusPinImportPlugin : public QObject, /*! * Creates a port in the component from the given line in the pin file. * - * @param [in] line The line to parse as port. - * @param [in] targetComponent The component to add the port into. + * @param [in] line The line to parse as port. + * @param [in] targetComponent The component to add the port into. */ void createPort(QString const& line, QSharedPointer targetComponent); /*! * Parses pin direction to IP-XACT port direction. * - * @param [in] direction The direction to parse. + * @param [in] direction The direction to parse. * - * @return The port direction. + * @return The port direction. */ DirectionTypes::Direction parseDirection(QString const& direction); diff --git a/Plugins/QuartusProjectGenerator/QuartusGenerator.h b/Plugins/QuartusProjectGenerator/QuartusGenerator.h index 6a8af22cb..1cdb397d3 100644 --- a/Plugins/QuartusProjectGenerator/QuartusGenerator.h +++ b/Plugins/QuartusProjectGenerator/QuartusGenerator.h @@ -34,7 +34,7 @@ class QuartusGenerator: public QObject /*! The constructor * - * @param [in] utility The Plugin utility, where to get libraries etc. + * @param [in] utility The Plugin utility, where to get libraries etc. * */ explicit QuartusGenerator(IPluginUtility* utility); @@ -50,24 +50,24 @@ class QuartusGenerator: public QObject /*! Read already saved pin mappings from file sets to store in the settings file later. * - * @param [in] component The component whose pin mappings to find. + * @param [in] component The component whose pin mappings to find. */ void readExistingPinMap(QSharedPointer component); /*! * Parse the files associated with the given view in the selected component. * - * @param [in] component The selected component. - * @param [in] view The view to parse file set references from. + * @param [in] component The selected component. + * @param [in] view The view to parse file set references from. */ void parseFiles(QSharedPointer component, QSharedPointer view); /*! Generate the Quartus project files (.qpf .qsf) * - * @param [in] outputPath The directory path, where the project files are generated. - * @param [in] topEntity The name of the topmost entity. - * @param [in] generatorInformation The generator information to write in the header. + * @param [in] outputPath The directory path, where the project files are generated. + * @param [in] topEntity The name of the topmost entity. + * @param [in] generatorInformation The generator information to write in the header. * */ void generateProject(QString const& outputPath, QString const& topEntity,QString const& generatorInformation); @@ -75,7 +75,7 @@ class QuartusGenerator: public QObject /*! * Replace the printed time with the given text. * - * @param [in] newTime The replacement for the printed time. + * @param [in] newTime The replacement for the printed time. */ void replaceTime(QString const& newTime); @@ -92,83 +92,83 @@ class QuartusGenerator: public QObject /*! * Get the file containing a quartus pin map. * - * @param [in] component The component where to search the file from. + * @param [in] component The component where to search the file from. * - * @return The file that contains a quartus pin map. If no quartus pin map is found, returns a null. + * @return The file that contains a quartus pin map. If no quartus pin map is found, returns a null. */ QSharedPointer getQuartusPinMap(QSharedPointer component); /*! Writes the Quartus Project File into specified directory. * - * @param [in] outPutDir Path to the directory where the .qpf file is written to + * @param [in] outPutDir Path to the directory where the .qpf file is written to */ void writeQuartusProjectFile(QString const& outputPath, QString const& topEntity, QString const& generatorInformation); /*! * Create a quartus file. * - * @param [in] outputDirectory Path to the directory where the file is written to. - * @param [in] topEntity The name of the topmost entity for the file name. - * @param [in] fileSuffix The suffix for the file name. + * @param [in] outputDirectory Path to the directory where the file is written to. + * @param [in] topEntity The name of the topmost entity for the file name. + * @param [in] fileSuffix The suffix for the file name. * - * @return Either a quartus project file or a quartus settings file, depending on the given suffix. + * @return Either a quartus project file or a quartus settings file, depending on the given suffix. */ QFile* createQuartusProjectFile(QString const& outputPath, QString const& topEntity, QString const& fileSuffix); /*! Writes the header info for the Quartus file. * - * @param [in] stream The QTextStream to write into. - * @param [in] generatorInformation The generator information to write in the header. + * @param [in] stream The QTextStream to write into. + * @param [in] generatorInformation The generator information to write in the header. */ void writeHeader(QTextStream& stream, QString const& generatorInformation); /*! Writes the Quartus Settings File into specified directory. * - * @param [in] outPutDir Path to the directory where the .qsf file is written to. - * @param [in] topEntity The name of the topmost entity for the file name. - * @param [in] generatorInformation The generator information to write in the header. + * @param [in] outPutDir Path to the directory where the .qsf file is written to. + * @param [in] topEntity The name of the topmost entity for the file name. + * @param [in] generatorInformation The generator information to write in the header. */ void writeQuartusSettingsFile(QString const& outputPath, QString const& topEntity, QString const& generatorInformation); /*! Writes all the related files into the Quartus settings file. * - * @param [in] stream The QTextStream to write into. + * @param [in] stream The QTextStream to write into. */ void writeIncludedFiles(QTextStream& stream); /*! Writes all the stored pin assignments into the Quartus settings file. * - * @param [in] stream The QTextStream to write into. + * @param [in] stream The QTextStream to write into. */ void writePinAssignments(QTextStream& stream); /*! Parse the component's file sets and add all vhdl- and verilog-files. * - * @param [in] component The component to search. + * @param [in] component The component to search. */ void parseAllFileSets(QSharedPointer component); /*! * Parse a single file. * - * @param [in] targetFile The selected file to parse. - * @param [in] basePath The path of the file. - * @param [in] componentVLNV The vlnv of the component in qstring format. + * @param [in] targetFile The selected file to parse. + * @param [in] basePath The path of the file. + * @param [in] componentVLNV The vlnv of the component in qstring format. */ void parseSingleFile(QSharedPointer targetFile, QString const& basePath, QString const& componentVLNV); /*! Parse the given file sets and add their files to source files. * - * @param [in] component The component that's files are wanted. - * @param [in] fileSetNames Names of the file sets to use. + * @param [in] component The component that's files are wanted. + * @param [in] fileSetNames Names of the file sets to use. */ void parseFileSets(QSharedPointer component, QStringList const& fileSetNames); /*! * Parse the design / design configuration and the file sets of a hierarchical view of the selected component. * - * @param [in] view The hierarchical view. - * @param [in] component The component of the hierarhical view. + * @param [in] view The hierarchical view. + * @param [in] component The component of the hierarhical view. */ void parseFilesFromHierarchicalView(QSharedPointer view, QSharedPointer component); @@ -176,16 +176,16 @@ class QuartusGenerator: public QObject * * Design is read and component instances are parsed to get their files also. * - * @param [in] design The design to parse. - * @param [in] desConf The design configuration to use + * @param [in] design The design to parse. + * @param [in] desConf The design configuration to use * */ void readDesign(QSharedPointer design, QSharedPointer desConf); /*! Parse the file sets in a given view and add their files to source files. * - * @param [in] component The component that's files are wanted. - * @param [in] view The view whose filesets to search. + * @param [in] component The component that's files are wanted. + * @param [in] view The view whose filesets to search. */ void parseFilesFromFlatView(QSharedPointer component, QSharedPointer view); diff --git a/Plugins/QuartusProjectGenerator/QuartusProjectGenerator.h b/Plugins/QuartusProjectGenerator/QuartusProjectGenerator.h index 921127d87..63124e5e1 100644 --- a/Plugins/QuartusProjectGenerator/QuartusProjectGenerator.h +++ b/Plugins/QuartusProjectGenerator/QuartusProjectGenerator.h @@ -61,49 +61,49 @@ class QUARTUSPROJECTGENERATOR_EXPORT QuartusProjectGenerator : public QObject, p /*! * Gets the name of the plugin. * - * @return The name of the plugin. + * @return The name of the plugin. */ virtual QString getName() const; /*! * Gets the version of the plugin. * - * @return The version of the plugin + * @return The version of the plugin */ virtual QString getVersion() const; /*! * Gets the description of the plugin. * - * @return The description of the plugin. + * @return The description of the plugin. */ virtual QString getDescription() const; /*! * Gets the vendor of the plugin. * - * @return The vendor of the plugin. + * @return The vendor of the plugin. */ virtual QString getVendor() const; /*! * Gets the license of the plugin. * - * @return The license of the plugin. + * @return The license of the plugin. */ virtual QString getLicense() const; /*! * Returns the holder of the license of the plugin. * - * @return The holder of the license of the plugin. + * @return The holder of the license of the plugin. */ virtual QString getLicenseHolder() const; /*! * Returns the settings widget. * - * @return The settings widget. + * @return The settings widget. */ virtual QWidget* getSettingsWidget(); @@ -115,19 +115,19 @@ class QUARTUSPROJECTGENERATOR_EXPORT QuartusProjectGenerator : public QObject, p /*! * Returns the icon for the generator. * - * @return The icon for the generator. + * @return The icon for the generator. */ virtual QIcon getIcon() const; /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -137,11 +137,11 @@ class QUARTUSPROJECTGENERATOR_EXPORT QuartusProjectGenerator : public QObject, p * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -151,7 +151,7 @@ class QUARTUSPROJECTGENERATOR_EXPORT QuartusProjectGenerator : public QObject, p /*! * Get a list of external program requirements of the plugin. * - * @return A list of external program requirements of the plugin. + * @return A list of external program requirements of the plugin. */ virtual QList getProgramRequirements(); @@ -160,14 +160,14 @@ private slots: /*! * Handles the error messages of the quartus generator. * - * @param [in] message The error message. + * @param [in] message The error message. */ void onErrorMessage(QString const& message); /*! * Handles the notification messages of the quartus generator. * - * @param [in] message The notification message. + * @param [in] message The notification message. */ void onNoticeMessage(QString const& message); @@ -176,11 +176,11 @@ private slots: /*! * Gets the view of the current design or design configuration. * - * @param [in] component The component for which this plugin is run for. - * @param [in] desConf The design configuration object of a hierarchical component. - * @param [in] design The design object of a hierarchical component. + * @param [in] component The component for which this plugin is run for. + * @param [in] desConf The design configuration object of a hierarchical component. + * @param [in] design The design object of a hierarchical component. * - * @return The view referencing to the open design. + * @return The view referencing to the open design. */ QSharedPointer getOpenView(QSharedPointer component, QSharedPointer desConf, QSharedPointer design); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeCpuEditor.h b/Plugins/RenodeGenerator/CPUDialog/RenodeCpuEditor.h index fe9da7a71..0c84236ab 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeCpuEditor.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeCpuEditor.h @@ -44,10 +44,10 @@ class RenodeCpuEditor : public CPUEditor /*! * The constructor. * - * @param [in] utility Utility for plugins. - * @param [in] configurationObject JSON object containing the editor configuration. - * @param [in] templateConfigurer Configurer for peripheral templates. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] utility Utility for plugins. + * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] templateConfigurer Configurer for peripheral templates. + * @param [in] parent Pointer to the owner of this widget. */ RenodeCpuEditor(IPluginUtility* utility, QJsonObject const& configurationObject, @@ -62,23 +62,23 @@ class RenodeCpuEditor : public CPUEditor /*! * Setup the selected CPUs. * - * @param [in] library Interface for accessing the library. - * @param [in] component Top component of the selected design. - * @param [in] activeView Active view of the design. + * @param [in] library Interface for accessing the library. + * @param [in] component Top component of the selected design. + * @param [in] activeView Active view of the design. */ virtual void setupCPUDetails(LibraryInterface* library, QSharedPointer component, QString const& activeView) override final; /*! * Get the selected CPUs. * - * @return List of the selected CPUs. + * @return List of the selected CPUs. */ virtual QVector > getSelectedCPUs() const override final; /*! * Get the name of the currently active CPU. * - * @return Name of the currently active CPU. + * @return Name of the currently active CPU. */ QString getSelectedCpuName(); @@ -91,7 +91,7 @@ public slots: /*! * Setup the selected folder path. * - * @param [in] newFolderPath The new folder path. + * @param [in] newFolderPath The new folder path. */ virtual void setupFolderPath(QString const& newFolderPath) override final; @@ -100,7 +100,7 @@ public slots: /*! * Inform of a change in CPU. * - * @param [in] newCpuName Name of the new CPU. + * @param [in] newCpuName Name of the new CPU. */ void cpuChanged(QString const& newCpuName); @@ -109,28 +109,28 @@ private slots: /*! * Handle the change in CPU selection. * - * @param [in] newCPU Name of the new CPU. + * @param [in] newCPU Name of the new CPU. */ void onHandleCpuChange(QString const& newCPU); /*! * Handle the changes in the CPU class. * - * @param [in] newClass The new class. + * @param [in] newClass The new class. */ void onHandleClassChange(QString const& newClass); /*! * Handle the change in cpu type. * - * @param [in] newType The new type. + * @param [in] newType The new type. */ void onHandleTypeChange(QString const& newType); /*! * Handle the change in time provider. * - * @param [in] newTimeProvider The new time provider. + * @param [in] newTimeProvider The new time provider. */ void onHandleTimeProviderChange(QString const& newTimeProvider); @@ -159,9 +159,9 @@ private slots: /*! * Get the CPU container for the selected CPU. * - * @param [in] cpuText Identifier of the selected CPU. + * @param [in] cpuText Identifier of the selected CPU. * - * @return CPU container for the selected CPU. + * @return CPU container for the selected CPU. */ QSharedPointer getContainerForCpu(QString const& cpuText) const; diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeCpuRoutesContainer.h b/Plugins/RenodeGenerator/CPUDialog/RenodeCpuRoutesContainer.h index eda564c54..478adbc0d 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeCpuRoutesContainer.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeCpuRoutesContainer.h @@ -26,7 +26,7 @@ class RenodeCpuRoutesContainer : public SingleCpuRoutesContainer /*! * The constructor. * - * @param [in] renodeCpu CPU for this container. + * @param [in] renodeCpu CPU for this container. */ RenodeCpuRoutesContainer(QSharedPointer renodeCpu); @@ -38,77 +38,77 @@ class RenodeCpuRoutesContainer : public SingleCpuRoutesContainer /*! * Creates a Renode CPU route from CPU route. * - * @return Renode CPU route. + * @return Renode CPU route. */ RenodeCpuRoutesContainer(SingleCpuRoutesContainer const& other); /*! * Set the peripheral data. * - * @param [in] newPeripherals List of new peripherals. + * @param [in] newPeripherals List of new peripherals. */ void setPeripherals(QVector > newPeripherals); /*! * Get the peripheral data. * - * @return List of peripheral data. + * @return List of peripheral data. */ QVector > getPeripherals() const; /*! * Set the available memory data. * - * @param [in] newMemories List of new memory data. + * @param [in] newMemories List of new memory data. */ void setMemories(QVector > newMemories); /*! * Get the memory data. * - * @return List of the memory data. + * @return List of the memory data. */ QVector > getMemories() const; /*! * Set a class name for the CPU. * - * @param [in] newClass The new class name. + * @param [in] newClass The new class name. */ void setClassName(QString const& newClass); /*! * Get the CPU class name. * - * @return The CPU class name. + * @return The CPU class name. */ QString getClassName(); /*! * Set the CPU type. * - * @param [in] newType The new CPU type. + * @param [in] newType The new CPU type. */ void setCpuType(QString const& newType); /*! * Get the CPU type. * - * @return The CPU type. + * @return The CPU type. */ QString getCpuType(); /*! * Set a new time provider. * - * @param [in] newTimeProvider The new time provider. + * @param [in] newTimeProvider The new time provider. */ void setTimeProvider(QString const& newTimeProvider); /*! * Get the CPU time provider. * - * @return The CPU time provider. + * @return The CPU time provider. */ QString getTimeProvider(); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeFileEditor.h b/Plugins/RenodeGenerator/CPUDialog/RenodeFileEditor.h index 376efe6f0..ffd37aa10 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeFileEditor.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeFileEditor.h @@ -31,8 +31,8 @@ class RenodeFileEditor : public QWidget /*! * The constructor. * - * @param [in] configurationObject JSON object containing the editor configuration. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] parent Pointer to the owner of this widget. */ RenodeFileEditor(QJsonObject const& configurationObject, QWidget* parent = 0); @@ -44,63 +44,63 @@ class RenodeFileEditor : public QWidget /*! * Check if the CPU file should be written. * - * @return True, if the CPU file should be written, false otherwise. + * @return True, if the CPU file should be written, false otherwise. */ bool writeCpu(); /*! * Check if the memory file should be written. * - * @return True, if the memory file should be written, false otherwise. + * @return True, if the memory file should be written, false otherwise. */ bool writeMemory(); /*! * Check if the peripherals file should be written. * - * @return True, if the peripherals file should be written, false otherwise. + * @return True, if the peripherals file should be written, false otherwise. */ bool writePeripherals(); /*! * Get the name of the CPU file. * - * @return Name of the CPU file. + * @return Name of the CPU file. */ QString getCpuFileName() const; /*! * Get the current text in the CPU editor. * - * @return Current text in the CPU editor. + * @return Current text in the CPU editor. */ QString getCpuEditorText() const; /*! * Get the name of the memory file. * - * @return Name of the memory file. + * @return Name of the memory file. */ QString getmemoryFileName() const; /*! * Get the current text in the memory editor. * - * @return Current text in the memory editor. + * @return Current text in the memory editor. */ QString getMemoryEditorText() const; /*! * Get the name of the peripherals file. * - * @return Name of the peripherals file. + * @return Name of the peripherals file. */ QString getPeripheralFileName() const; /*! * Get the current text in the peripherals editor. * - * @return Current text in the peripherals editor. + * @return Current text in the peripherals editor. */ QString getPeripheralEditorText() const; @@ -113,7 +113,7 @@ public slots: /*! * Change the placeholder text in the file editors to match the new CPU name. * - * @param [in] newCpuName The name of the new CPU. + * @param [in] newCpuName The name of the new CPU. */ void changeFileNames(QString const& newCpuName); @@ -122,9 +122,9 @@ public slots: /*! * Template for getting the file name from the selected editor. * - * @param [in] editor The selected file editor. + * @param [in] editor The selected file editor. * - * @return Name of the selected file. + * @return Name of the selected file. */ template QString getFileName(fileEditor* editor) const; @@ -132,7 +132,7 @@ public slots: /*! * Apply the configuration to file name editors. * - * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] configurationObject JSON object containing the editor configuration. */ void applyConfigurations(QJsonObject const& configurationObject); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeFileSelectionGroup.h b/Plugins/RenodeGenerator/CPUDialog/RenodeFileSelectionGroup.h index 23adc7e4e..d6720d2ae 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeFileSelectionGroup.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeFileSelectionGroup.h @@ -29,8 +29,8 @@ class RenodeFileSelectionGroup : public QGroupBox /*! * The constructor. * - * @param [in] configurationObject JSON object containing the editor configuration. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] parent Pointer to the owner of this widget. */ RenodeFileSelectionGroup(QJsonObject const& configurationObject, QWidget* parent = 0); @@ -42,21 +42,21 @@ class RenodeFileSelectionGroup : public QGroupBox /*! * Check if the CPU file should be written. * - * @return True, if the CPU file should be written, false otherwise. + * @return True, if the CPU file should be written, false otherwise. */ bool writeCpu(); /*! * Check if the memory file should be written. * - * @return True, if the memory file should be written, false otherwise. + * @return True, if the memory file should be written, false otherwise. */ bool writeMemory(); /*! * Check if the peripherals file should be written. * - * @return True, if the peripherals file should be written, false otherwise. + * @return True, if the peripherals file should be written, false otherwise. */ bool writePeripherals(); @@ -70,14 +70,14 @@ private slots: /*! * Handle the state change in all check boxes. * - * @param [in] newState The new state. + * @param [in] newState The new state. */ void onCheckAllStateChange(bool newState); /*! * Handle the state change in a single check box. Change the state in the select all -check box accordingly. * - * @param [in] newState The new state. + * @param [in] newState The new state. */ void onItemClicked(bool newState); @@ -86,7 +86,7 @@ private slots: /*! * Apply the configuration to file selections. * - * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] configurationObject JSON object containing the editor configuration. */ void applyConfigurations(QJsonObject const& configurationObject); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesEditor.h b/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesEditor.h index 6f5c526a9..a07bfb245 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesEditor.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesEditor.h @@ -32,7 +32,7 @@ class RenodeMemoriesEditor : public QWidget /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ RenodeMemoriesEditor(QWidget *parent = 0); @@ -44,7 +44,7 @@ class RenodeMemoriesEditor : public QWidget /*! * Setup the selected CPUs. * - * @param [in] memories List of the available memory items. + * @param [in] memories List of the available memory items. */ void setupMemories(QVector > memories); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesModel.h b/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesModel.h index 1db6d8c0a..374b97d3f 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesModel.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeMemoriesModel.h @@ -30,7 +30,7 @@ class RenodeMemoriesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ RenodeMemoriesModel(QObject *parent); @@ -42,66 +42,66 @@ class RenodeMemoriesModel : public QAbstractTableModel /*! * Setup the selected memory items. * - * @param [in] newMemories The selected memory items. + * @param [in] newMemories The selected memory items. */ void setupMemories(QVector > newMemories); /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -114,18 +114,18 @@ class RenodeMemoriesModel : public QAbstractTableModel /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the tooltip value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The tooltip data in the given index. + * @return The tooltip data in the given index. */ QVariant tooltipForIndex(QModelIndex const& index) const; diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsDelegate.h b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsDelegate.h index 8b0b2f738..a5fddff8c 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsDelegate.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsDelegate.h @@ -32,7 +32,7 @@ class RenodePeripheralsDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parentWidget The parent widget. + * @param [in] parentWidget The parent widget. */ RenodePeripheralsDelegate(QWidget* parentWidget); @@ -44,18 +44,18 @@ class RenodePeripheralsDelegate : public QStyledItemDelegate /*! * Setup the available peripheral templates. * - * @param [in] newTemplates List of the available peripheral templates. + * @param [in] newTemplates List of the available peripheral templates. */ void setupTemplates(QVector > newTemplates); /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -63,17 +63,17 @@ class RenodePeripheralsDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Renders an item in the given index. * - * @param [in] painter The painter to use for rendering. - * @param [in] option The style options for the rendering. - * @param [in] index The index to the data being rendered. + * @param [in] painter The painter to use for rendering. + * @param [in] option The style options for the rendering. + * @param [in] index The index to the data being rendered. */ virtual void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -86,7 +86,7 @@ public slots: /*! * Handle the change in file location. * - * @param [in] newFolder The new location. + * @param [in] newFolder The new location. */ void onFolderChanged(QString const& newFolder); @@ -95,12 +95,12 @@ public slots: /*! * Handler for preprocessing events that starts editing. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the delegate handles the event, otherwise false. + * @return True, if the delegate handles the event, otherwise false. */ virtual bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); @@ -110,12 +110,12 @@ public slots: /*! * Handler for editor events in file path editor. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the event is handled, otherwise false. + * @return True, if the event is handled, otherwise false. */ bool handleEditorEventForPath(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsEditor.h b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsEditor.h index a4af01fe2..7a212946f 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsEditor.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsEditor.h @@ -34,8 +34,8 @@ class RenodePeripheralsEditor : public QWidget /*! * The constructor. * - * @param [in] templateConfigurer Handles configuration of peripheral templates. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] templateConfigurer Handles configuration of peripheral templates. + * @param [in] parent Pointer to the owner of this widget. */ RenodePeripheralsEditor(PeripheralTemplateConfigurer* templateConfigurer, QWidget* parent = 0); @@ -47,14 +47,14 @@ class RenodePeripheralsEditor : public QWidget /*! * Setup the selected peripherals. * - * @param [in] peripherals The selected peripherals. + * @param [in] peripherals The selected peripherals. */ void setupPeripherals(QVector > peripherals); /*! * Setup the folder path. * - * @param [in] newFolderPath The new folder path. + * @param [in] newFolderPath The new folder path. */ void setupFolderPath(QString const& newFolderPath); @@ -74,7 +74,7 @@ private slots: /*! * Setup the peripheral templates. * - * @param [in] templates List of new peripheral templates. + * @param [in] templates List of new peripheral templates. */ void setupPeripheralTemplates(QVector > templates); diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsModel.h b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsModel.h index 81da490e9..c1b4ace73 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsModel.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodePeripheralsModel.h @@ -30,7 +30,7 @@ class RenodePeripheralsModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ RenodePeripheralsModel(QObject *parent); @@ -42,73 +42,73 @@ class RenodePeripheralsModel : public QAbstractTableModel /*! * Setup the selected peripherals. * - * @param [in] newPeripherals The selected peripherals. + * @param [in] newPeripherals The selected peripherals. */ void setupPeripherals(QVector > newPeripherals); /*! * Setup the available peripheral templates. * - * @param [in] newTemplates List of the available peripheral templates. + * @param [in] newTemplates List of the available peripheral templates. */ void setupTemplates(QVector > newTemplates); /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -121,36 +121,36 @@ class RenodePeripheralsModel : public QAbstractTableModel /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the tooltip value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The tooltip data in the given index. + * @return The tooltip data in the given index. */ QVariant tooltipForIndex(QModelIndex const& index) const; /*! * Get the background color for the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Background color of the selected index. + * @return Background color of the selected index. */ QVariant backgroundColourForIndex(QModelIndex const& index) const; /*! * Check if the class of the indexed peripheral is python peripheral. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the indexed peripheral class is python peripheral, false otherwise. + * @return True, if the indexed peripheral class is python peripheral, false otherwise. */ bool classIsPythonPeripherals(QModelIndex const& index) const; diff --git a/Plugins/RenodeGenerator/CPUDialog/RenodeUtilities.h b/Plugins/RenodeGenerator/CPUDialog/RenodeUtilities.h index a501f5b84..3d440002c 100644 --- a/Plugins/RenodeGenerator/CPUDialog/RenodeUtilities.h +++ b/Plugins/RenodeGenerator/CPUDialog/RenodeUtilities.h @@ -30,13 +30,13 @@ namespace RenodeUtilities /*! * Get CPU detail routes for Renode generator. * - * @param [in] configurationObject JSON object containing the editor configuration. - * @param [in] library Interface for accessing the library. - * @param [in] component Top component of the design. - * @param [in] viewName The currently active view. - * @param [in] templates List of available peripheral templates. + * @param [in] configurationObject JSON object containing the editor configuration. + * @param [in] library Interface for accessing the library. + * @param [in] component Top component of the design. + * @param [in] viewName The currently active view. + * @param [in] templates List of available peripheral templates. * - * @return List of CPU detail routes for Renode generator. + * @return List of CPU detail routes for Renode generator. */ QVector > getRenodeCpuRoutes( QJsonObject const& configurationObject, @@ -48,19 +48,19 @@ namespace RenodeUtilities /*! * Get the available peripheral template names. * - * @param [in] templates List of available peripheral templates. + * @param [in] templates List of available peripheral templates. * - * @return List of peripheral template names. + * @return List of peripheral template names. */ QStringList getTemplateNames(QVector > templates); /*! * Get the selected peripheral template from the selected list. * - * @param [in] templateName Name of the selected peripheral template. - * @param [in] templates List of available peripheral templates. + * @param [in] templateName Name of the selected peripheral template. + * @param [in] templates List of available peripheral templates. * - * @return The selected peripheral template. + * @return The selected peripheral template. */ QSharedPointer getTemplateFromList(QString const& templateName, QVector > templates); }; diff --git a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateConfigurer.h b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateConfigurer.h index d20a3003a..5ce79d14f 100644 --- a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateConfigurer.h +++ b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateConfigurer.h @@ -28,7 +28,7 @@ class PeripheralTemplateConfigurer /*! * Constructor. * - * @param [in] settingsModel Container for Renode generator settings. + * @param [in] settingsModel Container for Renode generator settings. */ PeripheralTemplateConfigurer(RenodeSettingsModel* settingsModel); @@ -40,14 +40,14 @@ class PeripheralTemplateConfigurer /*! * Get the list of available peripheral templates. * - * @return List of available peripheral templates. + * @return List of available peripheral templates. */ QVector > getTemplates() const; /*! * Set a new list of peripheral templates. * - * @param [in] newTemplates The new peripheral templates. + * @param [in] newTemplates The new peripheral templates. */ void setTemplates(QVector > newTemplates); diff --git a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateDelegate.h b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateDelegate.h index adda5675e..89f716aa7 100644 --- a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateDelegate.h +++ b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateDelegate.h @@ -43,12 +43,12 @@ class PeripheralTemplateDelegate : public QStyledItemDelegate /*! * Handler for preprocessing events that starts editing. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the delegate handles the event, otherwise false. + * @return True, if the delegate handles the event, otherwise false. */ virtual bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateEditor.h b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateEditor.h index 7280230c8..df01ed0ab 100644 --- a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateEditor.h +++ b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateEditor.h @@ -32,14 +32,14 @@ class PeripheralTemplateEditor : public QWidget /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ PeripheralTemplateEditor(QString const& generationFolder, QWidget *parent = 0); /*! * Setup the peripheral template. * - * @param [in] newTemplates List of new peripheral templates. + * @param [in] newTemplates List of new peripheral templates. */ void setupTemplates(QVector > newTemplars); @@ -51,7 +51,7 @@ class PeripheralTemplateEditor : public QWidget /*! * Get the current peripheral templates. * - * @return The current peripheral templates. + * @return The current peripheral templates. */ QVector > getTemplates() const; diff --git a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateModel.h b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateModel.h index 144d69b7c..180851e5a 100644 --- a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateModel.h +++ b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplateModel.h @@ -28,7 +28,7 @@ class PeripheralTemplateModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ PeripheralTemplateModel(QObject *parent); @@ -40,73 +40,73 @@ class PeripheralTemplateModel : public QAbstractTableModel /*! * Setup the peripheral templates. * - * @param [in] newTemplates The selected peripheral templates. + * @param [in] newTemplates The selected peripheral templates. */ void setupTemplates(QVector > newTemplates); /*! * Get the list of peripheral templates. * - * @return List of peripheral templates. + * @return List of peripheral templates. */ QVector > getTemplates() const; /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -124,21 +124,21 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); /*! * Remove a row from the model. * - * @param [in] row Specifies the row to remove + * @param [in] row Specifies the row to remove */ void onRemoveRow(int row); @@ -147,34 +147,34 @@ public slots: /*! * Add a new item to the selected row. * - * @param [in] newItemRow The selected row. + * @param [in] newItemRow The selected row. */ void addItem(int newItemRow); /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the tooltip value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The tooltip data in the given index. + * @return The tooltip data in the given index. */ QVariant tooltipForIndex(QModelIndex const& index) const; /*! * Get the color for the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Color of the selected index. Black for valid index, red for invalid index. + * @return Color of the selected index. Black for valid index, red for invalid index. */ QVariant blackForValidRedForInvalidIndex(QModelIndex const& index) const; diff --git a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplatesDialog.h b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplatesDialog.h index 62e580ef8..b06841ee7 100644 --- a/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplatesDialog.h +++ b/Plugins/RenodeGenerator/CPUDialog/TemplateEditor/PeripheralTemplatesDialog.h @@ -30,8 +30,8 @@ class PeripheralTemplatesDialog : public QDialog /*! * The constructor. * - * @param [in] configurationFolder Folder path for the generator. - * @param [in] parent Parent widget. + * @param [in] configurationFolder Folder path for the generator. + * @param [in] parent Parent widget. */ PeripheralTemplatesDialog(QString const& generationFolder, QWidget* parent); @@ -43,14 +43,14 @@ class PeripheralTemplatesDialog : public QDialog /*! * Setup the available peripheral templates. * - * @param [in] newTemplates List of the selected peripheral templates. + * @param [in] newTemplates List of the selected peripheral templates. */ void setupTemplates(QVector > newTemplates); /*! * Get a list of the available peripheral templates. * - * @return List of peripheral templates. + * @return List of peripheral templates. */ QVector > getTemplates() const; diff --git a/Plugins/RenodeGenerator/RenodeConfigurationManager.h b/Plugins/RenodeGenerator/RenodeConfigurationManager.h index 29b383434..fc6faec19 100644 --- a/Plugins/RenodeGenerator/RenodeConfigurationManager.h +++ b/Plugins/RenodeGenerator/RenodeConfigurationManager.h @@ -39,29 +39,29 @@ class RenodeConfigurationManager : public PluginConfigurationManager /*! * Get the configuration object of a single CPU. * - * @param [in] component The containing component. - * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The containing component. + * @param [in] utility Utilities for enabling plugin execution. * - * @return The configuration object. + * @return The configuration object. */ QJsonObject getConfigurationObject(QSharedPointer component); /*! * Create a configuration file. * - * @param [in] renodeData Container for renode generator data. - * @param [in] selectedView Name of the view to use in the generator. - * @param [in] saveToFileSet Flag for save to file set. - * @param [in] selectedFileSet Name of the target file set. - * @param [in] folderPath Path for the renode files. - * @param [in] writeCPU Flag for writing a CPU file. - * @param [in] cpuFileName Name for the CPU file. - * @param [in] writeMemory Flag for writing a memory file. - * @param [in] memoryFileName Name for the memory file. - * @param [in] writePeripherals Flag for writing a peripherals file. - * @param [in] peripheralsFileName Name for the peripherals file. - * @param [in] selectedCpu Name of the active CPU. - * @param [in] topComponent Top level component. + * @param [in] renodeData Container for renode generator data. + * @param [in] selectedView Name of the view to use in the generator. + * @param [in] saveToFileSet Flag for save to file set. + * @param [in] selectedFileSet Name of the target file set. + * @param [in] folderPath Path for the renode files. + * @param [in] writeCPU Flag for writing a CPU file. + * @param [in] cpuFileName Name for the CPU file. + * @param [in] writeMemory Flag for writing a memory file. + * @param [in] memoryFileName Name for the memory file. + * @param [in] writePeripherals Flag for writing a peripherals file. + * @param [in] peripheralsFileName Name for the peripherals file. + * @param [in] selectedCpu Name of the active CPU. + * @param [in] topComponent Top level component. */ void createConfigureFile(QSharedPointer renodeData, QString const& selectedView, @@ -82,19 +82,19 @@ class RenodeConfigurationManager : public PluginConfigurationManager /*! * Create a JSON document for storing the generator configurations. * - * @param [in] renodeCpu Container for renode generator data. - * @param [in] selectedView Name of the view to use in the generator. - * @param [in] saveToFileSetFlag Flag for save to file set. - * @param [in] selectedFileSet Name of the target file set. - * @param [in] folderPath Path for the renode files. - * @param [in] cpuFileName Name for the CPU file. - * @param [in] writeMemory Flag for writing a memory file. - * @param [in] memoryFileName Name for the memory file. - * @param [in] writePeripherals Flag for writing a peripherals file. - * @param [in] peripheralsFileName Name for the peripherals file. - * @param [in] selectedCpu Name of the active CPU. + * @param [in] renodeCpu Container for renode generator data. + * @param [in] selectedView Name of the view to use in the generator. + * @param [in] saveToFileSetFlag Flag for save to file set. + * @param [in] selectedFileSet Name of the target file set. + * @param [in] folderPath Path for the renode files. + * @param [in] cpuFileName Name for the CPU file. + * @param [in] writeMemory Flag for writing a memory file. + * @param [in] memoryFileName Name for the memory file. + * @param [in] writePeripherals Flag for writing a peripherals file. + * @param [in] peripheralsFileName Name for the peripherals file. + * @param [in] selectedCpu Name of the active CPU. * - * @return The JSON configuration document. + * @return The JSON configuration document. */ QJsonDocument createJsonDocument(QSharedPointer renodeCpu, QString const& selectedView, @@ -112,7 +112,7 @@ class RenodeConfigurationManager : public PluginConfigurationManager /*! * Remove the selected CPU container from the CPU configuration array. * - * @param [in] cpuContainer The selected CPU container. + * @param [in] cpuContainer The selected CPU container. */ void removeCpuContainerFromConfigurationArray(QSharedPointer cpuContainer); diff --git a/Plugins/RenodeGenerator/RenodeGenerator.h b/Plugins/RenodeGenerator/RenodeGenerator.h index 4b07f6846..cefb5ba2e 100644 --- a/Plugins/RenodeGenerator/RenodeGenerator.h +++ b/Plugins/RenodeGenerator/RenodeGenerator.h @@ -36,7 +36,7 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * The constructor. * - * @param [in] library Interface for accessing libraries. + * @param [in] library Interface for accessing libraries. */ explicit RenodeGenerator(LibraryInterface* library); @@ -52,14 +52,14 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Generates slave memory listing for the given component. * - * @param [in] componentPath Path to the component folder. - * @param [in] cpuContainer CPU and its connected routes. - * @param [in] createCpuFile Flag for creating a CPU file. - * @param [in] cpuFileName Name of the CPU file. - * @param [in] createMemoryFile Flag for creating a memory file. - * @param [in] memoryFileName Name of the memory file. - * @param [in] createPeripheralFile Flag for creating a peripherals file. - * @param [in] peripheralFileName Name of the peripherals file. + * @param [in] componentPath Path to the component folder. + * @param [in] cpuContainer CPU and its connected routes. + * @param [in] createCpuFile Flag for creating a CPU file. + * @param [in] cpuFileName Name of the CPU file. + * @param [in] createMemoryFile Flag for creating a memory file. + * @param [in] memoryFileName Name of the memory file. + * @param [in] createPeripheralFile Flag for creating a peripherals file. + * @param [in] peripheralFileName Name of the peripherals file. */ void generate(QString const& componentPath, QSharedPointer const& cpuContainer, @@ -73,7 +73,7 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Get the generated files. * - * @return The generated files. + * @return The generated files. */ QStringList getGeneratedFiles() const; @@ -82,15 +82,15 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Writes the CPU listing into Renode platform files. * - * @param [in] componentPath Path to the component folder. - * @param [in] cpuRoute The selected CPU route container. - * @param [in] fileNames Names of the generated Renode files. - * @param [in] createCpuFile Flag for creating a CPU file. - * @param [in] cpuFileName Name of the CPU file. - * @param [in] createMemoryFile Flag for creating a memory file. - * @param [in] memoryFileName Name of the memory file. - * @param [in] createPeripheralFile Flag for creating a peripherals file. - * @param [in] peripheralFileName Name of the peripherals file. + * @param [in] componentPath Path to the component folder. + * @param [in] cpuRoute The selected CPU route container. + * @param [in] fileNames Names of the generated Renode files. + * @param [in] createCpuFile Flag for creating a CPU file. + * @param [in] cpuFileName Name of the CPU file. + * @param [in] createMemoryFile Flag for creating a memory file. + * @param [in] memoryFileName Name of the memory file. + * @param [in] createPeripheralFile Flag for creating a peripherals file. + * @param [in] peripheralFileName Name of the peripherals file. */ void writeFiles(QString const& componentPath, QSharedPointer cpuRoute, @@ -104,29 +104,29 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Get a unique file name using the selected file name. * - * @param [in] fileNames List of used file names. - * @param [in] currentFileName The selected file name. + * @param [in] fileNames List of used file names. + * @param [in] currentFileName The selected file name. * - * @return Unique file name. + * @return Unique file name. */ QString getUniqueFileName(QStringList& fileNames, QString const& currentFileName) const; /*! * Get the number of files containing the selected name. * - * @param [in] fileNames List of the generated files. - * @param [in] fileName The selected file name. + * @param [in] fileNames List of the generated files. + * @param [in] fileName The selected file name. * - * @return Number of files containing the same name. + * @return Number of files containing the same name. */ int getFileNumberExtension(QStringList const& fileNames, QString const& fileName) const; /*! * Write the selected CPU. * - * @param [in] filePath File path for the renode files. - * @param [in] cpuContainer The CPU data container. - * @param [in] fileName Name for the CPU file. + * @param [in] filePath File path for the renode files. + * @param [in] cpuContainer The CPU data container. + * @param [in] fileName Name for the CPU file. */ void writeCPU(QString const& filePath, QSharedPointer cpuContainer, @@ -135,10 +135,10 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Write the peripherals of the selected CPU route container. * - * @param [in] filePath File path for the renode files. - * @param [in] peripheralPath Path for the renode platform files. - * @param [in] renodeCollection The selected CPU route container. - * @param [in] fileName Name for the peripherals file. + * @param [in] filePath File path for the renode files. + * @param [in] peripheralPath Path for the renode platform files. + * @param [in] renodeCollection The selected CPU route container. + * @param [in] fileName Name for the peripherals file. */ void writePeripherals(QString const& filePath, QString const& peripheralPath, @@ -148,10 +148,10 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Write a single peripheral. * - * @param [in] stream The text stream. - * @param [in] peripheral The selected peripheral item. - * @param [in] tab Current tab. - * @param [in] renodeFilePath The file path to the Renode platform files. + * @param [in] stream The text stream. + * @param [in] peripheral The selected peripheral item. + * @param [in] tab Current tab. + * @param [in] renodeFilePath The file path to the Renode platform files. */ void writePeripheral(QTextStream& stream, QSharedPointer peripheral, @@ -161,9 +161,9 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Write the memory of the selected CPU. * - * @param [in] filePath File path for the Renode platform files. - * @param [in] renodeCollection The selected CPU route container. - * @param [in] fileName Name of the memory file. + * @param [in] filePath File path for the Renode platform files. + * @param [in] renodeCollection The selected CPU route container. + * @param [in] fileName Name of the memory file. */ void writeMemories(QString const& filePath, QSharedPointer renodeCollection, @@ -172,9 +172,9 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGenerator /*! * Write a single memory item. * - * @param [in] stream The text stream. - * @param [in] memory The selected memory item. - * @param [in] tab Current tab. + * @param [in] stream The text stream. + * @param [in] memory The selected memory item. + * @param [in] tab Current tab. */ void writeMemory(QTextStream& stream, QSharedPointer memory, QString const& tab) const; diff --git a/Plugins/RenodeGenerator/RenodeGeneratorPlugin.h b/Plugins/RenodeGenerator/RenodeGeneratorPlugin.h index f5ea14d4d..daa7e7c73 100644 --- a/Plugins/RenodeGenerator/RenodeGeneratorPlugin.h +++ b/Plugins/RenodeGenerator/RenodeGeneratorPlugin.h @@ -100,12 +100,12 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGeneratorPlugin : public QObject, publi /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -115,11 +115,11 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGeneratorPlugin : public QObject, publi * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -129,12 +129,12 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGeneratorPlugin : public QObject, publi /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -151,7 +151,7 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGeneratorPlugin : public QObject, publi /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const; @@ -161,10 +161,10 @@ class RENODEGENERATORPLUGIN_EXPORT RenodeGeneratorPlugin : public QObject, publi /*! * Saves the generated file to the selected file set of the top component. * - * @param [in] utility The plugin utility interface. - * @param [in] svdFiles The generated file paths. - * @param [in] component The top level component. - * @param [in] fileSetName Name of the target file set. + * @param [in] utility The plugin utility interface. + * @param [in] svdFiles The generated file paths. + * @param [in] component The top level component. + * @param [in] fileSetName Name of the target file set. */ void saveToFileset(IPluginUtility* utility, QStringList const& renodeFiles, diff --git a/Plugins/RenodeGenerator/RenodeSettingsModel.h b/Plugins/RenodeGenerator/RenodeSettingsModel.h index 34a75c3c6..caa43d176 100644 --- a/Plugins/RenodeGenerator/RenodeSettingsModel.h +++ b/Plugins/RenodeGenerator/RenodeSettingsModel.h @@ -33,14 +33,14 @@ class RenodeSettingsModel : public PluginSettingsModel /*! * Loads plugin settings from the given settings store. Is called when Kactus2 loads the plugin. * - * @param [in] settings The settings store. + * @param [in] settings The settings store. */ virtual void loadSettings(QSettings& settings) override final; /*! * Saves plugin settings to the given settings store. Is called when Kactus2 applies changes to settings. * - * @param [in,out] settings The settings store. + * @param [in,out] settings The settings store. */ virtual void saveSettings(QSettings& settings) override final; @@ -52,14 +52,14 @@ class RenodeSettingsModel : public PluginSettingsModel /*! * Get the path to the current peripheral template configuration. * - * @return Path to the current peripheral template configuration. + * @return Path to the current peripheral template configuration. */ QString getFilePath() const; /*! * Set a new path for peripheral template configuration file. * - * @param [in] newFolderPath The new path to peripheral template configuration file. + * @param [in] newFolderPath The new path to peripheral template configuration file. */ void setFilePath(QString const& newFolderPath); diff --git a/Plugins/RenodeGenerator/RenodeSettingsWidget.h b/Plugins/RenodeGenerator/RenodeSettingsWidget.h index b60c41b95..62e2b97d4 100644 --- a/Plugins/RenodeGenerator/RenodeSettingsWidget.h +++ b/Plugins/RenodeGenerator/RenodeSettingsWidget.h @@ -29,8 +29,8 @@ class RenodeSettingsWidget : public QWidget /*! * The constructor. * - * @param [in] settingsModel Model for renode peripheral template settings. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] settingsModel Model for renode peripheral template settings. + * @param [in] parent Pointer to the owner of this widget. */ RenodeSettingsWidget(RenodeSettingsModel* settingsModel, QWidget *parent = 0); @@ -53,7 +53,7 @@ private slots: /*! * Handle the change in the peripheral template configuration path. * - * @param [in] newPath New path for peripheral template configuration file. + * @param [in] newPath New path for peripheral template configuration file. */ void onPathChanged(QString const& newPath); diff --git a/Plugins/SVDGenerator/CPUDialog/SVDCPUDelegate.h b/Plugins/SVDGenerator/CPUDialog/SVDCPUDelegate.h index 8d887aafb..5c2bb83ce 100644 --- a/Plugins/SVDGenerator/CPUDialog/SVDCPUDelegate.h +++ b/Plugins/SVDGenerator/CPUDialog/SVDCPUDelegate.h @@ -38,11 +38,11 @@ class SVDCPUDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -50,17 +50,17 @@ class SVDCPUDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Renders an item in the given index. * - * @param [in] painter The painter to use for rendering. - * @param [in] option The style options for the rendering. - * @param [in] index The index to the data being rendered. + * @param [in] painter The painter to use for rendering. + * @param [in] option The style options for the rendering. + * @param [in] index The index to the data being rendered. */ virtual void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -73,12 +73,12 @@ class SVDCPUDelegate : public QStyledItemDelegate /*! * Handler for preprocessing events that starts editing. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the delegate handles the event, otherwise false. + * @return True, if the delegate handles the event, otherwise false. */ virtual bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/Plugins/SVDGenerator/CPUDialog/SVDCPUEditor.h b/Plugins/SVDGenerator/CPUDialog/SVDCPUEditor.h index 4d66cbd55..a9ac02f74 100644 --- a/Plugins/SVDGenerator/CPUDialog/SVDCPUEditor.h +++ b/Plugins/SVDGenerator/CPUDialog/SVDCPUEditor.h @@ -36,8 +36,8 @@ class SVDCPUEditor : public CPUEditor /*! * The constructor. * - * @param [in] configurationObject Object containing the SVD configurations. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] configurationObject Object containing the SVD configurations. + * @param [in] parent Pointer to the owner of this widget. */ SVDCPUEditor(QJsonObject const& configurationObject, QWidget *parent = 0); @@ -49,16 +49,16 @@ class SVDCPUEditor : public CPUEditor /*! * Setup the selected CPUs. * - * @param [in] library Interface for accessing the library. - * @param [in] component The top component of the design. - * @param [in] activeView Active view of the design. + * @param [in] library Interface for accessing the library. + * @param [in] component The top component of the design. + * @param [in] activeView Active view of the design. */ virtual void setupCPUDetails(LibraryInterface* library, QSharedPointer component, QString const& activeView) override final; /*! * Get a list of the selected CPU routes. * - * @return List of the selected CPU routes. + * @return List of the selected CPU routes. */ virtual QVector > getSelectedCPUs() const override final; @@ -71,11 +71,11 @@ class SVDCPUEditor : public CPUEditor /*! * Create SVD CPU routes from the selected design. * - * @param [in] library Interface for accessing the library. - * @param [in] component The top component of the design. - * @param [in] activeView Active view of the design. + * @param [in] library Interface for accessing the library. + * @param [in] component The top component of the design. + * @param [in] activeView Active view of the design. * - * @return The SVD CPU routes of the selected design. + * @return The SVD CPU routes of the selected design. */ QVector > getSVDCPURoutes(LibraryInterface* library, QSharedPointer component, QString const& activeView); diff --git a/Plugins/SVDGenerator/CPUDialog/SVDCPUModel.h b/Plugins/SVDGenerator/CPUDialog/SVDCPUModel.h index ad5304a34..e31f482de 100644 --- a/Plugins/SVDGenerator/CPUDialog/SVDCPUModel.h +++ b/Plugins/SVDGenerator/CPUDialog/SVDCPUModel.h @@ -31,7 +31,7 @@ class SVDCPUModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ SVDCPUModel(QObject *parent); @@ -43,73 +43,73 @@ class SVDCPUModel : public QAbstractTableModel /*! * Setup the selected CPUs. * - * @param [in] cpuDetails The selected CPUs. + * @param [in] cpuDetails The selected CPUs. */ void setupCPUDetails(QVector > cpuDetails); /*! * Get the CPU data. * - * @return List of CPU detail routes. + * @return List of CPU detail routes. */ QVector > getCPUDetails() const; /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -122,18 +122,18 @@ class SVDCPUModel : public QAbstractTableModel /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the tooltip value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The tooltip data in the given index. + * @return The tooltip data in the given index. */ QVariant tooltipForIndex(QModelIndex const& index) const; diff --git a/Plugins/SVDGenerator/CPUDialog/SVDCpuRoutesContainer.h b/Plugins/SVDGenerator/CPUDialog/SVDCpuRoutesContainer.h index 0fb3b197d..d686decd5 100644 --- a/Plugins/SVDGenerator/CPUDialog/SVDCpuRoutesContainer.h +++ b/Plugins/SVDGenerator/CPUDialog/SVDCpuRoutesContainer.h @@ -29,7 +29,7 @@ class SVDCpuRoutesContainer : public SingleCpuRoutesContainer /*! * The constructor. * - * @param [in] cpu The CPU. + * @param [in] cpu The CPU. */ SVDCpuRoutesContainer(QSharedPointer cpu); @@ -41,98 +41,98 @@ class SVDCpuRoutesContainer : public SingleCpuRoutesContainer /*! * Creates an SVD CPU route from CPU route. * - * @return SVD CPU route. + * @return SVD CPU route. */ SVDCpuRoutesContainer(SingleCpuRoutesContainer const& other); /*! * Setup the data. * - * @param [in] configurationObject Object containing the data. + * @param [in] configurationObject Object containing the data. */ void setupConfiguration(QJsonObject const& configurationObject); /*! * Get the revision. * - * @return The revision. + * @return The revision. */ QString getRevision() const; /*! * Set the revision. * - * @param [in] newRevision The new revision. + * @param [in] newRevision The new revision. */ void setRevision(QString const& newRevision); /*! * Get the endian. * - * @return The endian. + * @return The endian. */ QString getEndian() const; /*! * Set the endian. * - * @param [in] newEndian The new endian. + * @param [in] newEndian The new endian. */ void setEndian(QString const& newEndian); /*! * Check the value of MPU presence. * - * @return True, if MPU is present, otherwise false. + * @return True, if MPU is present, otherwise false. */ bool isMPUPresent() const; /*! * Set the MPU presence. * - * @param [in] newPresence The new MPU presence. + * @param [in] newPresence The new MPU presence. */ void setMPUPresence(bool newPresence); /*! * Check the FPU presence. * - * @return True, if the FPU is present, false otherwise. + * @return True, if the FPU is present, false otherwise. */ bool isFPUPresent() const; /*! * Set the FPU presence. * - * @param [in] newPresence The new FPU presence. + * @param [in] newPresence The new FPU presence. */ void setFPUPresence(bool newPresence); /*! * Get the number of NVIC bits. * - * @return Number of NVIC bits. + * @return Number of NVIC bits. */ QString getNVICPrioBits() const; /*! * Set the number of NVIC bits. * - * @param [in] newBits The new NVIC bits. + * @param [in] newBits The new NVIC bits. */ void setNVICPrioBits(QString const& newBits); /*! * Check if the CPU has a vendor specific system tick timer. * - * @return True, if the CPU has a vendor specific system tick timer, false otherwise. + * @return True, if the CPU has a vendor specific system tick timer, false otherwise. */ bool isVendorSystickConfig() const; /*! * Set the flag for vendor specific system tick timer. * - * @param [in] newConfig The new vendor specific system tick timer. + * @param [in] newConfig The new vendor specific system tick timer. */ void setVendorSystickConfig(bool newConfig); diff --git a/Plugins/SVDGenerator/SVDConfigurationManager.h b/Plugins/SVDGenerator/SVDConfigurationManager.h index 8d592621c..5599de0cc 100644 --- a/Plugins/SVDGenerator/SVDConfigurationManager.h +++ b/Plugins/SVDGenerator/SVDConfigurationManager.h @@ -37,21 +37,21 @@ class SVDConfigurationManager : public PluginConfigurationManager /*! * Get the configuration object of a single CPU. * - * @param [in] component The containing component. + * @param [in] component The containing component. * - * @return The configuration object. + * @return The configuration object. */ QJsonObject getConfigurationObject(QSharedPointer component); /*! * Create a configuration file. * - * @param [in] svdData Container for SVD generator data. - * @param [in] topComponent Top level component. - * @param [in] selectedView Name of the view to use in the generator. - * @param [in] saveToFileSet Flag for save to file set. - * @param [in] selectedFileSet Name of the target file set. - * @param [in] folderPath Path for the renode files. + * @param [in] svdData Container for SVD generator data. + * @param [in] topComponent Top level component. + * @param [in] selectedView Name of the view to use in the generator. + * @param [in] saveToFileSet Flag for save to file set. + * @param [in] selectedFileSet Name of the target file set. + * @param [in] folderPath Path for the renode files. */ void createConfigureFile(QVector > svdData, QSharedPointer topComponent, @@ -65,13 +65,13 @@ class SVDConfigurationManager : public PluginConfigurationManager /*! * Create a JSON document for storing the generator configurations. * - * @param [in] svdData Container for SVD generator data. - * @param [in] selectedView Name of the view to use in the generator. - * @param [in] saveToFileSetFlag Flag for save to file set. - * @param [in] selectedFileSet Name of the target file set. - * @param [in] folderPath Path for the renode files. + * @param [in] svdData Container for SVD generator data. + * @param [in] selectedView Name of the view to use in the generator. + * @param [in] saveToFileSetFlag Flag for save to file set. + * @param [in] selectedFileSet Name of the target file set. + * @param [in] folderPath Path for the renode files. * - * @return The JSON configuration document. + * @return The JSON configuration document. */ QJsonDocument createJsonDocument(QVector > svdData, QString const& selectedView, diff --git a/Plugins/SVDGenerator/SVDGenerator.h b/Plugins/SVDGenerator/SVDGenerator.h index d5823a2ce..d8fa8490b 100644 --- a/Plugins/SVDGenerator/SVDGenerator.h +++ b/Plugins/SVDGenerator/SVDGenerator.h @@ -54,7 +54,7 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * The constructor. * - * @param [in] utility The plugin utility interface. + * @param [in] utility The plugin utility interface. */ explicit SVDGenerator(IPluginUtility* utility); @@ -70,9 +70,9 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Generates slave memory listing for the given component. * - * @param [in] topComponent The top component in the hierarchy to generate listing for. - * @param [in] componentPath Path to the component folder. - * @param [in] cpuRoutes CPU and its connected routes. + * @param [in] topComponent The top component in the hierarchy to generate listing for. + * @param [in] componentPath Path to the component folder. + * @param [in] cpuRoutes CPU and its connected routes. */ void generate(QSharedPointer topComponent, QString const& componentPath, @@ -81,7 +81,7 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the generated files. * - * @return The generated files. + * @return The generated files. */ QStringList getGeneratedFiles() const; @@ -91,10 +91,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Writes the CPU listing into a given file. * - * @param [in] topComponent Top component of the design. - * @param [in] componentPath Path to the component folder. - * @param [in] cpuDetails Details for the selected CPU route container. - * @param [in] fileNames Names of the generated SVD files. + * @param [in] topComponent Top component of the design. + * @param [in] componentPath Path to the component folder. + * @param [in] cpuDetails Details for the selected CPU route container. + * @param [in] fileNames Names of the generated SVD files. */ void writeFile(QSharedPointer topComponent, QString const& componentPath, @@ -104,36 +104,36 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the number of files containing the selected name. * - * @param [in] fileNames List of the generated files. - * @param [in] fileName The selected file name. + * @param [in] fileNames List of the generated files. + * @param [in] fileName The selected file name. * - * @return Number of files containing the same name. + * @return Number of files containing the same name. */ int getFileNumberExtension(QStringList const& fileNames, QString const& fileName) const; /*! * Write the device information. * - * @param [in] writer The xml stream writer. - * @param [in] topComponent Top component of the containing design. + * @param [in] writer The xml stream writer. + * @param [in] topComponent Top component of the containing design. */ void writeDevice(QXmlStreamWriter& writer, QSharedPointer topComponent); /*! * Remove ' ' from the front and back of the selected name and replace the remaining with _. * - * @param [in] name The selected name. + * @param [in] name The selected name. * - * @return The formatted name. + * @return The formatted name. */ QString formatName(QString const& name) const; /*! * Write the selected CPU. * - * @param [in] writer The xml stream writer. - * @param [in] currentCPU The selected CPU. - * @param [in] cpuContianer The CPU data container. + * @param [in] writer The xml stream writer. + * @param [in] currentCPU The selected CPU. + * @param [in] cpuContianer The CPU data container. */ void writeCPU(QXmlStreamWriter& writer, QSharedPointer currentCPU, @@ -142,25 +142,25 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write a boolean flag. * - * @param [in] writer The xml stream writer. - * @param [in] elementName Name of the selected boolean flag. - * @param [in] state The flag state. + * @param [in] writer The xml stream writer. + * @param [in] elementName Name of the selected boolean flag. + * @param [in] state The flag state. */ void writeBoolean(QXmlStreamWriter& writer, QString const& elementName, bool state); /*! * Write the address space of the selected CPU. * - * @param [in] writer The xml stream writer. - * @param [in] cpuInterface Interface containing the selected CPU. + * @param [in] writer The xml stream writer. + * @param [in] cpuInterface Interface containing the selected CPU. */ void writeAddressSpaceData(QXmlStreamWriter& writer, QSharedPointer cpuInterface); /*! * Write the peripherals of the selected CPU route container. * - * @param [in] writer The xml stream writer. - * @param [in] cpuRouteDetails The selected CPU route container. + * @param [in] writer The xml stream writer. + * @param [in] cpuRouteDetails The selected CPU route container. */ void writePeripherals(QXmlStreamWriter& writer, QVector > cpuRouteDetails); @@ -168,11 +168,11 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write memory map peripheral of the selected memory item. * - * @param [in] writer The xml stream writer. - * @param [in] component Component containing the interfaced memory map item. - * @param [in] mapItem The selected memory item. - * @param [in] mapBaseAddress Base address of the memory map. - * @param [in] mapBaseAddressInHexa Base address of the memory map in hex format. + * @param [in] writer The xml stream writer. + * @param [in] component Component containing the interfaced memory map item. + * @param [in] mapItem The selected memory item. + * @param [in] mapBaseAddress Base address of the memory map. + * @param [in] mapBaseAddressInHexa Base address of the memory map in hex format. */ void writePeripheral(QXmlStreamWriter& writer, QSharedPointer component, @@ -183,9 +183,9 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write address blocks of the selected memory map item. * - * @param [in] writer The xml stream writer. - * @param [in] mapItem The selected memory map item. - * @param [in] mapBaseAddress Base address of the memory map. + * @param [in] writer The xml stream writer. + * @param [in] mapItem The selected memory map item. + * @param [in] mapBaseAddress Base address of the memory map. */ void writeAddressBlocks(QXmlStreamWriter& writer, QSharedPointer mapItem, quint64 mapBaseAddress); @@ -193,19 +193,19 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the available address block items of the selected memory map item. * - * @param [in] mapItem The selected memory map item. + * @param [in] mapItem The selected memory map item. * - * @return Address blocks with usage other than memory of the selected memory map item. + * @return Address blocks with usage other than memory of the selected memory map item. */ QVector > getAddressBlockItems(QSharedPointer mapItem) const; /*! * Get a list of the selected sub items of the selected memory item. * - * @param [in] memoryItem The selected memory item. - * @param [in] subItemType Type of the sub item. + * @param [in] memoryItem The selected memory item. + * @param [in] subItemType Type of the sub item. * - * @return List of the selected sub items. + * @return List of the selected sub items. */ QVector> getSubMemoryItems(QSharedPointer memoryItem, QString const& subItemType) const; @@ -213,9 +213,9 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write the selected address block. * - * @param [in] writer The xml stream writer. - * @param [in] offset Offset of the address block. - * @param [in] blockItem The selected address block item. + * @param [in] writer The xml stream writer. + * @param [in] offset Offset of the address block. + * @param [in] blockItem The selected address block item. */ void writeSingleAddressBlock(QXmlStreamWriter& writer, quint64 const& offset, QSharedPointer blockItem); @@ -226,10 +226,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write the register cluster. * - * @param [in] writer The xml stream writer. - * @param [in] containingBlock The address block containing the registers. - * @param [in] blockItem The selected address block item. - * @param [in] addressOffsetInHexa Offset of the address block in hex format. + * @param [in] writer The xml stream writer. + * @param [in] containingBlock The address block containing the registers. + * @param [in] blockItem The selected address block item. + * @param [in] addressOffsetInHexa Offset of the address block in hex format. */ void writeRegisterCluster(QXmlStreamWriter& writer, QSharedPointer containingBlock, QSharedPointer blockItem, QString const& addressOffsetInHexa); @@ -237,9 +237,9 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write the selected register elements. * - * @param [in] writer The xml stream writer. - * @param [in] registerItem The selected register item. - * @param [in] realRegister The selected IP-XACT register. + * @param [in] writer The xml stream writer. + * @param [in] registerItem The selected register item. + * @param [in] realRegister The selected IP-XACT register. */ void writeRegister(QXmlStreamWriter& writer, QSharedPointer registerItem, QSharedPointer realRegister); @@ -247,18 +247,18 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write the selected reset element. * - * @param [in] writer The xml stream writer. - * @param [in] resetItem The selecter reset item. + * @param [in] writer The xml stream writer. + * @param [in] resetItem The selecter reset item. */ void writeReset(QXmlStreamWriter& writer, QSharedPointer resetItem) const; /*! * Get the field items of the selected register item in ascending offset order. * - * @param [in] registerItem The selected register item. - * @param [in] registerOffset Offset of the register. + * @param [in] registerItem The selected register item. + * @param [in] registerOffset Offset of the register. * - * @return Field items of the selected register item in ascending offset order. + * @return Field items of the selected register item in ascending offset order. */ QMap > getFieldItemsInOrder(QSharedPointer registerItem, quint64 const& registerOffset); @@ -266,18 +266,18 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the first reset item of the selected memory item. * - * @param [in] registerItem The selected memory item. + * @param [in] registerItem The selected memory item. * - * @return The first reset item of the selected memory item. + * @return The first reset item of the selected memory item. */ QSharedPointer getResetItem(QSharedPointer registerItem) const; /*! * Write the fields of the selected register. * - * @param [in] writer The xml stream writer. - * @param [in] containingRegister The selected register. - * @param [in] fieldItems Ordered field items. + * @param [in] writer The xml stream writer. + * @param [in] containingRegister The selected register. + * @param [in] fieldItems Ordered field items. */ void writeFields(QXmlStreamWriter& writer, QSharedPointer containingRegister, QMap > fieldItems); @@ -285,9 +285,9 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Write the enumerated values of the selected field. * - * @param [in] writer The xml stream writer. - * @param [in] containingField The selected field. - * @param [in] fieldItem The selected field item. + * @param [in] writer The xml stream writer. + * @param [in] containingField The selected field. + * @param [in] fieldItem The selected field item. */ void writeEnumeratedValues(QXmlStreamWriter& writer, QSharedPointer containingField, QSharedPointer fieldItem); @@ -295,10 +295,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the selected memory map. * - * @param [in] interfaceMemory Memory item of the selected memory map. - * @param [in] containingComponent Component containing the memory map. + * @param [in] interfaceMemory Memory item of the selected memory map. + * @param [in] containingComponent Component containing the memory map. * - * @return Memory map of the selected memory map item. + * @return Memory map of the selected memory map item. */ QSharedPointer getMemoryMap(QSharedPointer interfaceMemory, QSharedPointer containingComponent) const; @@ -306,11 +306,11 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the selected address block. * - * @param [in] containingComponent Component containing the address block. - * @param [in] mapItem Memory item of the containing memory map. - * @param [in] blockItem Memory item of the selected address block. + * @param [in] containingComponent Component containing the address block. + * @param [in] mapItem Memory item of the containing memory map. + * @param [in] blockItem Memory item of the selected address block. * - * @return Address block of the selected address block item. + * @return Address block of the selected address block item. */ QSharedPointer getAddressBlock(QSharedPointer containingComponent, QSharedPointer mapItem, QSharedPointer blockItem) const; @@ -318,10 +318,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the selected register. * - * @param [in] containingBlock Memory item of the containing address block. - * @param [in] registerItem Memory item of the selected register. + * @param [in] containingBlock Memory item of the containing address block. + * @param [in] registerItem Memory item of the selected register. * - * @return Register of the selected register item. + * @return Register of the selected register item. */ QSharedPointer getRegister(QSharedPointer containingBlock, QSharedPointer registerItem) const; @@ -329,10 +329,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the selected field. * - * @param [in] containingRegister Memory item of the containing register. - * @param [in] fieldItem Memory item of the selected field. + * @param [in] containingRegister Memory item of the containing register. + * @param [in] fieldItem Memory item of the selected field. * - * @return Field of the selected field item. + * @return Field of the selected field item. */ QSharedPointer getField(QSharedPointer containingRegister, QSharedPointer fieldItem) const; @@ -340,30 +340,30 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Get the start of the selected field. * - * @param [in] fieldItem The selected field item. - * @param [in] registerOffset Offset of the containing register. + * @param [in] fieldItem The selected field item. + * @param [in] registerOffset Offset of the containing register. * - * @return Start of the selected field. + * @return Start of the selected field. */ quint64 getFieldStart(QSharedPointer fieldItem, quint64 registerOffset); /*! * Get the end of the selected field. * - * @param [in] fieldItem The selected field item. - * @param [in] registerOffset Offset of the containing register. + * @param [in] fieldItem The selected field item. + * @param [in] registerOffset Offset of the containing register. * - * @return End of the selected field. + * @return End of the selected field. */ quint64 getFieldEnd(QSharedPointer fieldItem, quint64 fieldOffset); /*! * Get the selected enumerated value. * - * @param [in] containingField Memory item of the containing field. - * @param [in] enumeratedItem Memory item of the selected enumerated value. + * @param [in] containingField Memory item of the containing field. + * @param [in] enumeratedItem Memory item of the selected enumerated value. * - * @return Enumerated value of the selected enumerated value item. + * @return Enumerated value of the selected enumerated value item. */ QSharedPointer getEnumeratedValue(QSharedPointer containingField, QSharedPointer enumeratedItem) const; @@ -371,27 +371,27 @@ class SVDGENERATORPLUGIN_EXPORT SVDGenerator /*! * Change the selected value to hex format. * - * @param [in] value The selected value. + * @param [in] value The selected value. * - * @return The selected value in hex format. + * @return The selected value in hex format. */ QString valueToHexa(quint64 const& value) const; /*! * Write an optional the text element. * - * @param [in] writer The xml stream writer. - * @param [in] elementName Name of the element. - * @param [in] elementValue Value of the element. + * @param [in] writer The xml stream writer. + * @param [in] elementName Name of the element. + * @param [in] elementValue Value of the element. */ void writeOptionalElement(QXmlStreamWriter& writer, QString const& elementName, QString const& elementValue); /*! * Check for errors in the interface data of the selected file. * - * @param [in] fileName Name of the selected file. - * @param [in] comparisonInterface The interface compared to. - * @param [in] cpuRoutes List of the routes in the selected file. + * @param [in] fileName Name of the selected file. + * @param [in] comparisonInterface The interface compared to. + * @param [in] cpuRoutes List of the routes in the selected file. */ void checkForErrorsInAddressSpaceData(QString const& fileName, QSharedPointer comparisonInterface, QVector > cpuRoutes); diff --git a/Plugins/SVDGenerator/SVDGeneratorPlugin.h b/Plugins/SVDGenerator/SVDGeneratorPlugin.h index 171ff4575..126e28f31 100644 --- a/Plugins/SVDGenerator/SVDGeneratorPlugin.h +++ b/Plugins/SVDGenerator/SVDGeneratorPlugin.h @@ -94,12 +94,12 @@ class SVDGENERATORPLUGIN_EXPORT SVDGeneratorPlugin : public QObject, public IGen /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration) const; @@ -108,11 +108,11 @@ class SVDGENERATORPLUGIN_EXPORT SVDGeneratorPlugin : public QObject, public IGen * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration); @@ -120,12 +120,12 @@ class SVDGENERATORPLUGIN_EXPORT SVDGeneratorPlugin : public QObject, public IGen /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -137,7 +137,7 @@ class SVDGENERATORPLUGIN_EXPORT SVDGeneratorPlugin : public QObject, public IGen /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const; @@ -149,10 +149,10 @@ class SVDGENERATORPLUGIN_EXPORT SVDGeneratorPlugin : public QObject, public IGen /*! * Saves the generated file to the selected file set of the top component. * - * @param [in] utility The plugin utility interface. - * @param [in] svdFiles The generated file paths. - * @param [in] component The top level component. - * @param [in] fileSetName Name of the target file set. + * @param [in] utility The plugin utility interface. + * @param [in] svdFiles The generated file paths. + * @param [in] component The top level component. + * @param [in] fileSetName Name of the target file set. */ void saveToFileset(IPluginUtility* utility, QStringList const& svdFiles, QSharedPointer component, QString const& fileSetName); diff --git a/Plugins/VHDLAnalyzer/VHDLSourceAnalyzer.h b/Plugins/VHDLAnalyzer/VHDLSourceAnalyzer.h index e93e26e52..d89db0ff9 100644 --- a/Plugins/VHDLAnalyzer/VHDLSourceAnalyzer.h +++ b/Plugins/VHDLAnalyzer/VHDLSourceAnalyzer.h @@ -88,9 +88,9 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Calculates a language-dependent hash for the given file. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. * - * @return The hash value for the file. + * @return The hash value for the file. * * @remarks Comments and whitespace are ignored and do not affect the hash value. */ @@ -99,8 +99,8 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Begins the analysis for the given component. * - * @param [in] component The component. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any preparations needed for the file dependency analysis should be made here. */ @@ -109,8 +109,8 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Ends the analysis for the given component. * - * @param [in] component The component. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any cleanups needed should be made here. */ @@ -119,11 +119,11 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Retrieves all file dependencies the given file has. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. - * @param [in] filename The name of the file to which the analysis is run. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. + * @param [in] filename The name of the file to which the analysis is run. * - * @return The list of found dependencies. + * @return The list of found dependencies. */ virtual QList getFileDependencies(Component const* component, QString const& componentPath, QString const& filename); @@ -136,9 +136,9 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Reads source file data from given file. * - * @param [in] filename The file that is read. + * @param [in] filename The file that is read. * - * @return The meaningful source data of the file, with comments and empty lines removed. + * @return The meaningful source data of the file, with comments and empty lines removed. */ QString getSourceData(QString const& filename); @@ -146,33 +146,33 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin * * Scans all the files in the component to find VHDL entities and packages. * - * @param [in] component The component from which files are scanned. - * @param [in] componentPath The path of of the component in the file system. + * @param [in] component The component from which files are scanned. + * @param [in] componentPath The path of of the component in the file system. */ void scanDefinitions(Component const* component, QString const& componentPath); /*! * Scans entity declarations in the given source string. * - * @param [in] source The source string. - * @param [in] filename The name of the correspondent file. + * @param [in] source The source string. + * @param [in] filename The name of the correspondent file. */ void scanEntities(QString const& source, QString const& filename); /*! * Scans package declarations in the given source string. * - * @param [in] source The source string. - * @param [in] filename The name of the correspondent file. + * @param [in] source The source string. + * @param [in] filename The name of the correspondent file. */ void scanPackages(QString const& source, QString const& filename); /*! * Scans entity references in the source string. * - * @param [in] source The source string. - * @param [in] filename The name of the corresponding file. - * @param [out] dependencies The list of dependencies. + * @param [in] source The source string. + * @param [in] filename The name of the corresponding file. + * @param [out] dependencies The list of dependencies. */ void scanEntityReferences(QString const& source, QString const& filename, QList& dependencies); @@ -181,9 +181,9 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Scans package references in the source string. * - * @param [in] source The source string. - * @param [in] filename The name of the corresponding file. - * @param [out] dependencies The list of dependencies. + * @param [in] source The source string. + * @param [in] filename The name of the corresponding file. + * @param [out] dependencies The list of dependencies. */ void scanPackageReferences(QString const& source, QString const& filename, QList& dependencies); @@ -191,9 +191,9 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Adds a new entity dependency to the list of dependencies. * - * @param [in] componentName The name of the instantiated component. - * @param [in] filename The name of the file containing the instantiation. - * @param [out] dependencies The list of dependencies. + * @param [in] componentName The name of the instantiated component. + * @param [in] filename The name of the file containing the instantiation. + * @param [out] dependencies The list of dependencies. */ void addEntityDependency(QString const& componentName, QString const& filename, QList &dependencies); @@ -201,17 +201,17 @@ class VHDLSourceAnalyzer : public QObject, public ISourceAnalyzerPlugin /*! * Adds a new package dependency to the list of dependencies. * - * @param [in] componentName The name of the package. - * @param [in] filename The name of the file containing the dependency. - * @param [out] dependencies The list of dependencies. + * @param [in] componentName The name of the package. + * @param [in] filename The name of the file containing the dependency. + * @param [out] dependencies The list of dependencies. */ void addPackageDependency(QString const& packageName, QString const& filename, QList &dependencies); /*! * Adds a new dependency to the list of dependencies, if it is unique i.e. not in the list already. * - * @param [in] dependency The dependency to add. - * @param [out] dependencies The list of dependencies. + * @param [in] dependency The dependency to add. + * @param [out] dependencies The list of dependencies. */ void addUniqueDependency(FileDependencyDesc const& dependency, QList& dependencies); diff --git a/Plugins/VHDLGenerator/VHDLGeneratorPlugin.h b/Plugins/VHDLGenerator/VHDLGeneratorPlugin.h index eb67c2a74..8e91a4e5d 100644 --- a/Plugins/VHDLGenerator/VHDLGeneratorPlugin.h +++ b/Plugins/VHDLGenerator/VHDLGeneratorPlugin.h @@ -88,12 +88,12 @@ class VHDLGENERATOR_EXPORT VHDLGeneratorPlugin : public QObject, public IGenerat /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -103,11 +103,11 @@ class VHDLGENERATOR_EXPORT VHDLGeneratorPlugin : public QObject, public IGenerat * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -120,19 +120,19 @@ class VHDLGENERATOR_EXPORT VHDLGeneratorPlugin : public QObject, public IGenerat /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const override; /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, QSharedPointer design, QSharedPointer designConfiguration, @@ -157,19 +157,19 @@ private slots: /*! * Finds the name of the component entity. * - * @param [in] component The component to search. - * @param [in] viewName The selected view to search. + * @param [in] component The component to search. + * @param [in] viewName The selected view to search. * - * @return The name of the VHDL entity for the component. + * @return The name of the VHDL entity for the component. */ QString findEntityName(QSharedPointer component, QString const& viewName) const; /*! * Runs the VHDL generation for the given component. * - * @param [in] component The component to generate VHDL from. - * @param [in] filePath The file path to save the VHDL file. - * @param [in] viewSettings The view settings for the generation. + * @param [in] component The component to generate VHDL from. + * @param [in] filePath The file path to save the VHDL file. + * @param [in] viewSettings The view settings for the generation. */ void generate(QSharedPointer component, QString const& filePath, QSharedPointer viewSettings); diff --git a/Plugins/VHDLGenerator/VhdlTypedObject.h b/Plugins/VHDLGenerator/VhdlTypedObject.h index b2a95fe80..861d6c06d 100644 --- a/Plugins/VHDLGenerator/VhdlTypedObject.h +++ b/Plugins/VHDLGenerator/VhdlTypedObject.h @@ -25,11 +25,11 @@ class VhdlTypedObject : public VhdlObject /*! * The constructor. * - * @param [in] parent The owner of this vhdl object. - * @param [in] name Name of this vhdl object. - * @param [in] type Type of this vhdl object. - * @param [in] defaultValue The default value for the object. - * @param [in] description The Description for this vhdl object. + * @param [in] parent The owner of this vhdl object. + * @param [in] name Name of this vhdl object. + * @param [in] type Type of this vhdl object. + * @param [in] defaultValue The default value for the object. + * @param [in] description The Description for this vhdl object. */ VhdlTypedObject(const QString& name = QString(), const QString& type = QString(), @@ -64,7 +64,7 @@ class VhdlTypedObject : public VhdlObject /*! * Set the type for the vhdl object. * - * @param [in] type The type for the object. + * @param [in] type The type for the object. */ virtual void setType(const QString& type); @@ -78,7 +78,7 @@ class VhdlTypedObject : public VhdlObject /*! * Set the default value for the object. * - * @param [in] defaultValue The default value to be set for the object. + * @param [in] defaultValue The default value to be set for the object. */ virtual void setDefaultValue(const QString& defaultValue); diff --git a/Plugins/VHDLGenerator/vhdlcomponentdeclaration.h b/Plugins/VHDLGenerator/vhdlcomponentdeclaration.h index 4c6a32f76..d6bcfd147 100644 --- a/Plugins/VHDLGenerator/vhdlcomponentdeclaration.h +++ b/Plugins/VHDLGenerator/vhdlcomponentdeclaration.h @@ -40,8 +40,8 @@ class VhdlComponentDeclaration : public VhdlObject /*! * The constructor. * - * @param [in] component The component model for this vhdl component. - * @param [in] parser Parser for expressions within the declaration. + * @param [in] component The component model for this vhdl component. + * @param [in] parser Parser for expressions within the declaration. */ VhdlComponentDeclaration(QSharedPointer component, QSharedPointer parser); @@ -52,58 +52,58 @@ class VhdlComponentDeclaration : public VhdlObject /*! * Write the component declaration to the text stream. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ virtual void write(QTextStream& stream) const override final; /*! * Write the generic declarations of the component to the text stream. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeGenerics(QTextStream& stream) const; /*! * Write the port declarations of the component to the text stream. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writePorts(QTextStream& stream) const; /*! * Get the type name of the vhdl component declaration. * - * @return QString contains the type name. + * @return QString contains the type name. */ QString typeName() const; /*! * Get the description of the vhdl component declaration. * - * @return QString contains the description for the component declaration. + * @return QString contains the description for the component declaration. */ virtual QString description() const override final; /*! * Get pointer to the IP-Xact model of the component declaration. * - * @return QSharedPointer Pointer to the IP-Xact model of component. + * @return QSharedPointer Pointer to the IP-Xact model of component. */ QSharedPointer componentModel() const; /*! * Add an instantiation of this component. * - * @param instance Pointer to the instance. + * @param instance Pointer to the instance. */ void addInstantiation(QSharedPointer instance); /*! * Check if the component has generic with given name. * - * @param [in] genericName The name of the generic to search for. + * @param [in] genericName The name of the generic to search for. * - * @return bool True if the generic is found. + * @return bool True if the generic is found. */ bool hasGeneric(const QString& genericName) const; @@ -118,16 +118,16 @@ class VhdlComponentDeclaration : public VhdlObject /*! * Get the type of specified port. * - * @param [in] portName The name of the port. + * @param [in] portName The name of the port. * - * @return QString The type of the specified port. + * @return QString The type of the specified port. */ QString portType(const QString& portName) const; /*! * Check if the type of the port is scalar. * - * @param [in] portName Specifies the port to check. + * @param [in] portName Specifies the port to check. * * return bool True if port is scalar. */ @@ -136,34 +136,34 @@ class VhdlComponentDeclaration : public VhdlObject /*! * Set the name of the entity for the component. * - * @param [in] entityName The name for the entity of this component. + * @param [in] entityName The name for the entity of this component. */ void setEntityName(const QString& entityName); /*! * Get the direction of the specified port on this component. * - * @param [in] portName The name of the port that's direction is requested. + * @param [in] portName The name of the port that's direction is requested. * - * @return General::Direction Specifies the direction of the port. + * @return General::Direction Specifies the direction of the port. */ DirectionTypes::Direction portDirection(const QString& portName) const; /*! * Get the physical left bound of the port. * - * @param [in] portName The name of the port that's bound is wanted. + * @param [in] portName The name of the port that's bound is wanted. * - * @return The left bound. + * @return The left bound. */ QString getPortPhysLeftBound(const QString& portName) const; /*! * Get the physical right bound of the port. * - * @param [in] portName The name of the port that's bound is wanted. + * @param [in] portName The name of the port that's bound is wanted. * - * @return The right bound. + * @return The right bound. */ QString getPortPhysRightBound(const QString& portName) const; @@ -178,9 +178,9 @@ class VhdlComponentDeclaration : public VhdlObject /*! * Get the name of the bus interface containing the selected port. * - * @param [in] portName The name of the selected port. + * @param [in] portName The name of the selected port. * - * @return The name of the contianing bus interface, or "none" if no interface is found. + * @return The name of the contianing bus interface, or "none" if no interface is found. */ QString getContainingBusInterfaceName(QString const& portName) const; diff --git a/Plugins/VHDLGenerator/vhdlcomponentinstance.h b/Plugins/VHDLGenerator/vhdlcomponentinstance.h index 6ca96d817..2fdd2d9e1 100644 --- a/Plugins/VHDLGenerator/vhdlcomponentinstance.h +++ b/Plugins/VHDLGenerator/vhdlcomponentinstance.h @@ -56,54 +56,54 @@ class VhdlComponentInstance : public QObject, public VhdlObject /*! * Write the instance to the text stream. * - * @param [in] stream The text stream to write the instance into. + * @param [in] stream The text stream to write the instance into. */ virtual void write(QTextStream& stream) const override final; /*! * Get the name of the component instance. * - * @return QString contains the name of the instance. + * @return QString contains the name of the instance. */ QString name() const; /*! * Get the type name of the instance. * - * @return QString contains the type name. + * @return QString contains the type name. */ QString typeName() const; /*! * Add a new port map for the instance. * - * @param [in] endpoint The end point that specifies the port and signal bounds. - * @param [in] signalName The name of the signal/top port to map the port to. + * @param [in] endpoint The end point that specifies the port and signal bounds. + * @param [in] signalName The name of the signal/top port to map the port to. */ void addPortMap(const VhdlConnectionEndPoint& endpoint, const QString& signalName); /*! * Add a new port map for the instance. * - * @param [in] left The left side of the port map connection. - * @param [in] right The right side fo the port map connection. + * @param [in] left The left side of the port map connection. + * @param [in] right The right side fo the port map connection. */ void addPortMap(VhdlPortMap const& left, VhdlPortMap const& right); /*! * Add a new generic map to the instance. * - * @param [in] genericName The name of the generic on this instance. - * @param [in] genericValue The value to map the generic to. + * @param [in] genericName The name of the generic on this instance. + * @param [in] genericValue The value to map the generic to. */ void addGenericMap(const QString& genericName, const QString& genericValue); /*! * Check if the specified port is connected within this instance. * - * @param [in] portName The name of the port to check to connection for. + * @param [in] portName The name of the port to check to connection for. * - * @return bool True if connection is found. + * @return bool True if connection is found. */ bool hasConnection(const QString& portName); @@ -117,75 +117,75 @@ class VhdlComponentInstance : public QObject, public VhdlObject /*! * Get the bus interface with given name. * - * @param [in] interfaceName The name of the bus interface on the IP-Xact component model. + * @param [in] interfaceName The name of the bus interface on the IP-Xact component model. * - * @return BusInterface* Pointer to the bus interface. + * @return BusInterface* Pointer to the bus interface. */ QSharedPointer interface(const QString& interfaceName) const; /*! * Get the vlnv of the instance's IP-Xact model. * - * @return VLNV Identifies the IP-Xact model of the instance's type. + * @return VLNV Identifies the IP-Xact model of the instance's type. */ VLNV vlnv() const; /*! * Get pointer to the IP-Xact model of the component type. * - * @return QSharedPointer Pointer to the IP-Xact model. + * @return QSharedPointer Pointer to the IP-Xact model. */ QSharedPointer componentModel() const; /*! * Get the type of the specified port. * - * @param [in] portName The name of the port on the component. + * @param [in] portName The name of the port on the component. * - * @return QString The type of the port. + * @return QString The type of the port. */ QString portType(const QString& portName) const; /*! * Check if the instance has a specified port. * - * @param [in] portName The name of the port to check. + * @param [in] portName The name of the port to check. * - * @return bool True if the port is found. + * @return bool True if the port is found. */ bool hasPort(const QString& portName) const; /*! * Check if the type of the port is scalar. * - * @param [in] portName Specifies the port to check. + * @param [in] portName Specifies the port to check. * - * @return bool True if port is scalar. + * @return bool True if port is scalar. */ bool isScalarPort(const QString& portName) const; /*! * Get the direction of the specified port on this instance. * - * @param [in] portName The name of the port that's direction is requested. + * @param [in] portName The name of the port that's direction is requested. * - * @return General::Direction Specifies the direction of the port. + * @return General::Direction Specifies the direction of the port. */ DirectionTypes::Direction portDirection(const QString& portName) const; /*! * Get the physical left bound of the port. * - * @param [in] portName The name of the port that's bound is wanted. + * @param [in] portName The name of the port that's bound is wanted. * - * @return int The left bound. + * @return int The left bound. */ QString getPortPhysLeftBound(const QString& portName) const; /*! * Get the physical right bound of the port. * - * @param [in] portName The name of the port that's bound is wanted. + * @param [in] portName The name of the port that's bound is wanted. * * return int The right bound. */ @@ -210,8 +210,8 @@ class VhdlComponentInstance : public QObject, public VhdlObject /*! * Add port mapping. * - * @param [in] instancePort Selected VHDL port map object. - * @param [in] signalMapping The VHDL mapped signal. + * @param [in] instancePort Selected VHDL port map object. + * @param [in] signalMapping The VHDL mapped signal. */ void addMapping(const VhdlPortMap& instancePort, const VhdlPortMap& signalMapping ); diff --git a/Plugins/VHDLGenerator/vhdlgenerator2.h b/Plugins/VHDLGenerator/vhdlgenerator2.h index 2181ba528..600743d69 100644 --- a/Plugins/VHDLGenerator/vhdlgenerator2.h +++ b/Plugins/VHDLGenerator/vhdlgenerator2.h @@ -54,8 +54,8 @@ class VhdlGenerator2 : public QObject /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of this generator. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of this generator. */ VhdlGenerator2(QSharedPointer parser, LibraryInterface* handler, QObject* parent); @@ -66,17 +66,17 @@ class VhdlGenerator2 : public QObject /*! * Get pointer to the instance that manages the library. * - * @return LibraryInterface* Pointer to the instance that manages the library. + * @return LibraryInterface* Pointer to the instance that manages the library. */ LibraryInterface* handler() const; /*! * Parse the data needed to create the top-level vhdl entity. * - * @param [in] topLevelComponent Pointer to the component that's entity is created. - * @param [in] viewName The name of the view on the top component to generate the vhdl to. + * @param [in] topLevelComponent Pointer to the component that's entity is created. + * @param [in] viewName The name of the view on the top component to generate the vhdl to. * - * @return bool True if the parsing was successful and the vhdl can be generated. + * @return bool True if the parsing was successful and the vhdl can be generated. */ bool parse(QSharedPointer topLevelComponent, const QString& viewName); @@ -85,7 +85,7 @@ class VhdlGenerator2 : public QObject * * NOTE: Before calling this function the parse() function MUST be called so there is something to generate. * - * @param [in] outputFileName The absolute file path of the vhdl file to be created. + * @param [in] outputFileName The absolute file path of the vhdl file to be created. * If file exists it is overwritten. */ void generate(const QString& outputFileName); @@ -96,18 +96,18 @@ class VhdlGenerator2 : public QObject * NOTE: Before calling this function the parse() function must be called and usually the generateVhdl() also. * If generateVhdl() is not called then the architecture name must be set other way. * - * @param [in] vhdlFileName Absolute file path to the vhdl file to add to the metadata. This is + * @param [in] vhdlFileName Absolute file path to the vhdl file to add to the metadata. This is * usually the same file that was set as output file when calling * generateVhdl(). * - * @return bool True if the view was added successfully. + * @return bool True if the view was added successfully. */ bool addRTLView(QString const& fileSetName, const QString& vhdlFileName ); /*! * Check if the generator is able to generate and architecture for top entity. * - * @return True if component contains a design and is able to create an architecture for the entity. + * @return True if component contains a design and is able to create an architecture for the entity. */ bool containsArchitecture() const; @@ -145,10 +145,10 @@ class VhdlGenerator2 : public QObject /*! * The constructor * - * @param [in] instance Pointer to the instance to connect. - * @param [in] portName The name of the port on the instance. - * @param [in] left The left bound of the port. - * @param [in] right The right bound of the port. + * @param [in] instance Pointer to the instance to connect. + * @param [in] portName The name of the port on the instance. + * @param [in] left The left bound of the port. + * @param [in] right The right bound of the port. */ PortConnection(QSharedPointer instance, const QString& portName, int left = -1, int right = -1); @@ -166,14 +166,14 @@ class VhdlGenerator2 : public QObject /*! * Parse the design and configuration used. * - * @return True if the design and configuration were parsed successfully. + * @return True if the design and configuration were parsed successfully. */ bool parseDesignAndConfiguration(); /*! * Parse the generics for the top entity to create. * - * @param [in] viewName Name of the selected view. + * @param [in] viewName Name of the selected view. */ void parseTopGenerics( QString const& viewName ); @@ -207,12 +207,12 @@ class VhdlGenerator2 : public QObject /*! * Connect the two interfaces together with signals. * - * @param [in] connectionName The name of the connection between the interfaces. - * @param [in] description The description of the interconnection. - * @param [in] instance1 Pointer to the instance 1. - * @param [in] interface1 Pointer to the bus interface of instance 1. - * @param [in] instance2 Pointer to the instance 2. - * @param [in] interface2 Pointer to the bus interface of instance 2. + * @param [in] connectionName The name of the connection between the interfaces. + * @param [in] description The description of the interconnection. + * @param [in] instance1 Pointer to the instance 1. + * @param [in] interface1 Pointer to the bus interface of instance 1. + * @param [in] instance2 Pointer to the instance 2. + * @param [in] interface2 Pointer to the bus interface of instance 2. */ void connectInterfaces(const QString& connectionName, const QString& description, QSharedPointer instance1, QSharedPointer interface1, @@ -221,9 +221,9 @@ class VhdlGenerator2 : public QObject /*! * Connect the specified ports together. * - * @param [in] connectionName The name of the connection. - * @param [in] description Description for the connection. - * @param [in] ports Contains the ports to connect. + * @param [in] connectionName The name of the connection. + * @param [in] description Description for the connection. + * @param [in] ports Contains the ports to connect. */ void connectPorts(const QString& connectionName, const QString& description, const QList& ports); @@ -231,10 +231,10 @@ class VhdlGenerator2 : public QObject /*! * Connect the specified top port to specified instance ports. * - * @param [in] topPort The name of the port on top component. - * @param [in] leftBound The left bound of the port on top component. - * @param [in] rightBound The right bound of the port on top component. - * @param [in] ports List of ports to connect to the top port + * @param [in] topPort The name of the port on top component. + * @param [in] leftBound The left bound of the port on top component. + * @param [in] rightBound The right bound of the port on top component. + * @param [in] ports List of ports to connect to the top port */ void connectHierPort(const QString& topPortName, QString leftBound, QString rightBound, const QList& ports); @@ -242,17 +242,17 @@ class VhdlGenerator2 : public QObject /*! * Connect the given endpoint with the signal. * - * @param [in] endpoint The end point that specified the port to connect. - * @param [in] signal The signal the port is connected to. + * @param [in] endpoint The end point that specified the port to connect. + * @param [in] signal The signal the port is connected to. */ void connectEndPoint(const VhdlConnectionEndPoint& endpoint, const QSharedPointer signal); /*! * Connect the hierarchical interface to the instance interface. * - * @param [in] instance Pointer to the instance that's interface is connected. - * @param [in] instanceInterface Pointer to the interface of the instance. - * @param [in] topInterface Pointer to the interface of the top component. + * @param [in] instance Pointer to the instance that's interface is connected. + * @param [in] instanceInterface Pointer to the interface of the instance. + * @param [in] topInterface Pointer to the interface of the top component. */ void connectHierInterface( QSharedPointer instance, QSharedPointer instanceInterface, QSharedPointer topInterface ); @@ -267,76 +267,76 @@ class VhdlGenerator2 : public QObject /*! * Write the header of a vhdl file to be created. * - * @param [in] vhdlStream The text stream to write into. - * @param [in] fileName The name of the file that is being written. + * @param [in] vhdlStream The text stream to write into. + * @param [in] fileName The name of the file that is being written. */ void writeVhdlHeader( QTextStream& vhdlStream, const QString& fileName ); /*! * Write the generics of the top entity. * - * @param [in] vhdlStream The text stream to write into. + * @param [in] vhdlStream The text stream to write into. */ void writeGenerics( QTextStream& vhdlStream ); /*! * Write the ports of the top entity. * - * @param [in] vhdlStream The text stream to write into. + * @param [in] vhdlStream The text stream to write into. */ void writePorts( QTextStream& vhdlStream ); /*! * Write the declarations of the signals. * - * @param [in] vhdlStream The text stream to write into. + * @param [in] vhdlStream The text stream to write into. */ void writeSignalDeclarations( QTextStream& vhdlStream ); /*! * Write the declarations of components. * - * @param [in] vhdlStream The text stream to write into. + * @param [in] vhdlStream The text stream to write into. */ void writeComponentDeclarations( QTextStream& vhdlStream ); /*! * Write the instances of components. * - * @param [in] vhdlStream The text stream to write into. + * @param [in] vhdlStream The text stream to write into. */ void writeComponentInstances( QTextStream& vhdlStream ); /*! * Read an old vhdl file and read the user modifiable parts from it. * - * @param [in] previousFile The file to read. + * @param [in] previousFile The file to read. */ void readUserModifiablePart(QFile& previousFile); /*! * Write the user modified declarations read from the previous file. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeUserModifiedDeclarations(QTextStream& stream); /*! * Write the user modified assignments read from the previous file. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeUserModifiedAssignments(QTextStream& stream); /*! * Calculate the port alignment. * - * @param [in] portMap1 First port map. - * @param [in] phys1LeftBound Physical left bound of the first port. - * @param [in] phys1RightBound Physical right bound of the first port. - * @param [in] portMap2 The second port map. - * @param [in] phys2LeftBound Physical left bound of the second port. - * @param [in] phys2RightBound Physical right bound of the second port. + * @param [in] portMap1 First port map. + * @param [in] phys1LeftBound Physical left bound of the first port. + * @param [in] phys1RightBound Physical right bound of the first port. + * @param [in] portMap2 The second port map. + * @param [in] phys2LeftBound Physical left bound of the second port. + * @param [in] phys2RightBound Physical right bound of the second port. */ General::PortAlignment calculatePortAlignment(const PortMap* portMap1, QString const& phys1LeftBound, QString const& phys1RightBound, QSharedPointer firstParser, const PortMap* portMap2, @@ -345,12 +345,12 @@ class VhdlGenerator2 : public QObject /*! * Get the alignment of the physical port mapping. * - * @param [in] portmap The containing port map. - * @param [in] portLeftBound The left bound of the selected port. - * @param [in] portRightBound The right bound of the selected port. - * @param [in] parser Expression parser for the containing component. + * @param [in] portmap The containing port map. + * @param [in] portLeftBound The left bound of the selected port. + * @param [in] portRightBound The right bound of the selected port. + * @param [in] parser Expression parser for the containing component. * - * @return The alignment of the physical port mapping. + * @return The alignment of the physical port mapping. */ QSharedPointer getPhysicalAlignment(const PortMap* portmap, QString const& portLeftBound, QString const& portRightBound, QSharedPointer parser) const; @@ -358,21 +358,21 @@ class VhdlGenerator2 : public QObject /*! * Get the logical minimum or maximum port mapping value. * - * @param [in] portMap Port map containing the logical port. - * @param [in] parser Expression parser for the containing component. - * @param [in] isMaximum Flag value for determining whether the maximum of minimum value is wanted. + * @param [in] portMap Port map containing the logical port. + * @param [in] parser Expression parser for the containing component. + * @param [in] isMaximum Flag value for determining whether the maximum of minimum value is wanted. * - * @return A logical bound of the logical port mapping. + * @return A logical bound of the logical port mapping. */ int getLogicalValue(const PortMap* portMap, QSharedPointer parser, bool isMaximum) const; /*! * Get the name of the containing bus interface. * - * @param [in] containingComponent The component containing the port and the bus interface. - * @param [in] portName The name of the selected port. + * @param [in] containingComponent The component containing the port and the bus interface. + * @param [in] portName The name of the selected port. * - * @return The name of the containing bus interface, or "none" if one is not found. + * @return The name of the containing bus interface, or "none" if one is not found. */ QString getContainingBusInterfaceName(QSharedPointer containingComponent, QString const& portName) const; diff --git a/Plugins/VHDLPackageImport/VHDLPackageImport.h b/Plugins/VHDLPackageImport/VHDLPackageImport.h index 38c47ed34..e70e07f2d 100644 --- a/Plugins/VHDLPackageImport/VHDLPackageImport.h +++ b/Plugins/VHDLPackageImport/VHDLPackageImport.h @@ -86,29 +86,29 @@ class VHDLPACKAGEIMPORT_EXPORT VHDLPackageImport : public QObject, public Import /*! * Returns the supported import file types. * - * @return The file types the import plugin supports. + * @return The file types the import plugin supports. */ virtual QStringList getSupportedFileTypes() const; /*! * Gets any compatibility warnings for the plugin. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const; /*! * Parses the given input and creates parameters from Verilog defines. * - * @param [in] input The input text to parse. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QSharedPointer targetComponent); /*! * Sets the given highlighter to be used by the plugin. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); @@ -121,26 +121,26 @@ class VHDLPACKAGEIMPORT_EXPORT VHDLPackageImport : public QObject, public Import /*! * Checks if the given input has a valid package declaration. * - * @param [in] input The input to search for package declaration. + * @param [in] input The input to search for package declaration. * - * @return True, if a valid module was found, otherwise false. + * @return True, if a valid module was found, otherwise false. */ bool hasPackageDeclaration(QString const& input); /*! * Finds constant declarations from the inspected string with provided rule. * - * @param [in] declarationRule The rule for finding a constant. - * @param [in] inspect The input text containing the declarations. + * @param [in] declarationRule The rule for finding a constant. + * @param [in] inspect The input text containing the declarations. * - * @return The resulting list of declarations. + * @return The resulting list of declarations. */ QStringList findDeclarations(QRegularExpression const& declarationRule, QString const& inspect); /*! * Highlights the given definition. * - * @param [in] definition The defintion to highlight. + * @param [in] definition The defintion to highlight. */ void highlightDefinition(QString const& definition); @@ -149,18 +149,18 @@ class VHDLPACKAGEIMPORT_EXPORT VHDLPackageImport : public QObject, public Import * Creates a parameter from the given definition and adds it to the component. * Existing parameter with the same name will be updated and no new parameter is added. * - * @param [in] definition The definition to create the parameter from. - * @param [in] targetComponent The component to add the parameter to. + * @param [in] definition The definition to create the parameter from. + * @param [in] targetComponent The component to add the parameter to. */ void createModelParameterFromDefinition(QString const& definition, QSharedPointer targetComponent); /*! * Finds a parameter in the given component by the given name. * - * @param [in] targetComponent The component the search in. - * @param [in] name The name of the parameter to find. + * @param [in] targetComponent The component the search in. + * @param [in] name The name of the parameter to find. * - * @return The parameter with the given name or null if no parameter matches the name. + * @return The parameter with the given name or null if no parameter matches the name. */ QSharedPointer findModelParameterByName(QSharedPointer targetComponent, QString const& name) const; diff --git a/Plugins/VHDLimport/VHDLGenericParser.h b/Plugins/VHDLimport/VHDLGenericParser.h index bb92ead49..cc349ee1a 100644 --- a/Plugins/VHDLimport/VHDLGenericParser.h +++ b/Plugins/VHDLimport/VHDLGenericParser.h @@ -40,9 +40,9 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Runs the generic parser for the given input and adds the module parameters to the given component. * - * @param [in] input The input text to parse. - * @param [in/out] targetComponent The component to add the parameters to. - * @param [in] targetComponentInstantiation The component instantiation to add the module parameters to. + * @param [in] input The input text to parse. + * @param [in/out] targetComponent The component to add the parameters to. + * @param [in] targetComponentInstantiation The component instantiation to add the module parameters to. */ void import(QString const& input, QSharedPointer targetComponent, QSharedPointer targetComponentInstantiation); @@ -50,7 +50,7 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Sets the given highlighter to be used by the generic parser. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter) override final; @@ -63,37 +63,37 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Finds all generic declarations from input. * - * @param [in] input The input to search for generic declarations. + * @param [in] input The input to search for generic declarations. * - * @return Found generic declarations. + * @return Found generic declarations. */ QStringList findGenericDeclarations(QString const& input) const; /*! * Finds the section defining the generics of an entity. * - * @param [in] input The input to search for generic section. + * @param [in] input The input to search for generic section. * - * @return The sections containing all generics in entity. + * @return The sections containing all generics in entity. */ QString findGenericsSection(QString const& input) const; /*! * Removes all comment lines from a given input. * - * @param [in] input The input to remove comments from. + * @param [in] input The input to remove comments from. * - * @return The input without comment lines. + * @return The input without comment lines. */ QString removeCommentLines(QString section) const; /*! * Finds all generic declarations from a generics section without comment lines. * - * @param [in] sectionWithoutCommentLines The section of the VHDL containing the generics in entity + * @param [in] sectionWithoutCommentLines The section of the VHDL containing the generics in entity * without comment lines. * - * @return The VHDL generic declarations. + * @return The VHDL generic declarations. */ QStringList genericDeclarationsIn(QString const& sectionWithoutCommentLines) const; @@ -101,8 +101,8 @@ class VHDLGenericParser : public QObject, public HighlightSource * Creates a module parameter from a given VHDL declaration and adds it to the target component instantiation. * An equivalent parameter will be added to the component. * - * @param [in] declaration The declaration from which to create a model parameter. - * @param [in/out] targetComponentInstantiation The component instantiation to which add the module parameter. + * @param [in] declaration The declaration from which to create a model parameter. + * @param [in/out] targetComponentInstantiation The component instantiation to which add the module parameter. */ void createModelParameterFromDeclaration(QString const& declaration, QSharedPointer targetComponentInstantiation) const; @@ -110,10 +110,10 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Finds the given module parameter. * - * @param [in] name The name of the module parameter to find. - * @param [in] targetComponentInstantiation The instantiation to search in. + * @param [in] name The name of the module parameter to find. + * @param [in] targetComponentInstantiation The instantiation to search in. * - * @return The found module parameter. + * @return The found module parameter. */ QSharedPointer findModuleParameter(QString const& name, QSharedPointer targetComponentInstantiation) const; @@ -121,8 +121,8 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Replaces all name references in the module parameters to parameter id references. * - * @param [in] targetComponent The component containing the parameters. - * @param [in] targetComponentInstantiation The component instantiation containing the module parameters. + * @param [in] targetComponent The component containing the parameters. + * @param [in] targetComponentInstantiation The component instantiation containing the module parameters. */ void replaceNamesReferencesWithIds(QSharedPointer targetComponent, QSharedPointer targetComponentInstantiation) const; @@ -130,18 +130,18 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Finds the given parameter. * - * @param [in] name The name of the parameter to find. - * @param [in] component The component to search in. + * @param [in] name The name of the parameter to find. + * @param [in] component The component to search in. * - * @return The found parameter. + * @return The found parameter. */ QSharedPointer findParameter(QString const& name, QSharedPointer component) const; /*! * Replaces all name references in the given parameter to parameter id references. * - * @param [in] parameter The parameter whose references to replace. - * @param [in] component The component containing the referenced parameters. + * @param [in] parameter The parameter whose references to replace. + * @param [in] component The component containing the referenced parameters. */ void replaceNameReferencesWithParameterIds(QSharedPointer parameter, QSharedPointer targetComponent) const; @@ -149,11 +149,11 @@ class VHDLGenericParser : public QObject, public HighlightSource /*! * Replaces the given name in the given id in the referenced parameter. * - * @param [in] expression The expression to replace names in. - * @param [in] namePattern The pattern for the given name. - * @param [in] referenced The referenced parameter. + * @param [in] expression The expression to replace names in. + * @param [in] namePattern The pattern for the given name. + * @param [in] referenced The referenced parameter. * - * @return The expression where name references have been replaced with ids. + * @return The expression where name references have been replaced with ids. */ QString replaceNameWithId(QString const& expression, QRegularExpression& namePattern, QSharedPointer referenced) const; diff --git a/Plugins/VHDLimport/VHDLPortParser.h b/Plugins/VHDLimport/VHDLPortParser.h index 4225581f2..dd34edc99 100644 --- a/Plugins/VHDLimport/VHDLPortParser.h +++ b/Plugins/VHDLimport/VHDLPortParser.h @@ -38,7 +38,7 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ explicit VHDLPortParser(QObject* parent = 0); @@ -52,9 +52,9 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * Runs the port parsing for the given input and adds the parsed ports to the given component. * - * @param [in] input The input text to parse. - * @param [in/out] targetComponent The component to add all the imported ports to. - * @param [in] targetComponentInstantiation The component instantiation for the import. + * @param [in] input The input text to parse. + * @param [in/out] targetComponent The component to add all the imported ports to. + * @param [in] targetComponentInstantiation The component instantiation for the import. */ virtual void import(QString const& input, QSharedPointer targetComponent, QSharedPointer targetComponentInstantiation); @@ -62,7 +62,7 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * Sets the given highlighter to be used by the port parser. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); @@ -71,45 +71,45 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * Finds all port declarations from input. * - * @param [in] input The input to search for port declarations. + * @param [in] input The input to search for port declarations. * - * @return Found port declarations. + * @return Found port declarations. */ QStringList findPortDeclarations(QString const& input) const; /*! * Finds the section defining the ports of an entity. * - * @param [in] input The input to search for port section. + * @param [in] input The input to search for port section. * - * @return The sections containing all ports in entity. + * @return The sections containing all ports in entity. */ QString findPortsSection(QString const& input) const; /*! * Removes all comment lines from a given input. * - * @param [in] input The input to remove comments from. + * @param [in] input The input to remove comments from. * - * @return The input without comment lines. + * @return The input without comment lines. */ QString removeCommentLines(QString input) const; /*! * Finds all port declarations from a ports section without comment lines. * - * @param [in] portSectionWithoutCommentLines The section of the VHDL containing the ports in entity + * @param [in] portSectionWithoutCommentLines The section of the VHDL containing the ports in entity * without comment lines. * - * @return The VHDL port declarations. + * @return The VHDL port declarations. */ QStringList portDeclarationsIn(QString const& portSectionWithoutCommentLines) const; /*! * Creates a port from a given VHDL declaration and adds it to the target component. * - * @param [in] declaration The declaration from which to create a port. - * @param [in/out] targetComponent The component to which add the port. + * @param [in] declaration The declaration from which to create a port. + * @param [in/out] targetComponent The component to which add the port. */ void createPortFromDeclaration(QString const& declaration, QSharedPointer targetComponent) const; @@ -117,65 +117,65 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * Parses the port names from a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. + * @param [in] declaration The VHDL port declaration to parse. * - * @return The port names in the declaration. + * @return The port names in the declaration. */ QStringList parsePortNames(QString const& declaration) const; /*! * Parses the port direction from a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. + * @param [in] declaration The VHDL port declaration to parse. * - * @return The port direction in the declaration. + * @return The port direction in the declaration. */ DirectionTypes::Direction parsePortDirection(QString const& declaration) const; /*! * Parses the port type from a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. + * @param [in] declaration The VHDL port declaration to parse. * - * @return The port type in the declaration. + * @return The port type in the declaration. */ QString parsePortType(QString const& declaration) const; /*! * Parses the port description from a comment tailing a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. + * @param [in] declaration The VHDL port declaration to parse. * - * @return The port description. + * @return The port description. */ QString parseDescription(QString const& declaration) const; /*! * Parses the port default value from a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. + * @param [in] declaration The VHDL port declaration to parse. * - * @return The port default value in the declaration. + * @return The port default value in the declaration. */ QString parseDefaultValue(QString const& input, QSharedPointer targetComponent) const; /*! * Replaces all name references in the given expression to parameter id references. * - * @param [in] expression The expression whose references to replace. - * @param [in] targetComponent The component containing the referenced parameters. + * @param [in] expression The expression whose references to replace. + * @param [in] targetComponent The component containing the referenced parameters. * - * @return The expression with replaced references. + * @return The expression with replaced references. */ QString replaceNameReferencesWithIds(QString const& expression, QSharedPointer targetComponent) const; /*! * Parses the port bounds from a VHDL port declaration. * - * @param [in] declaration The VHDL port declaration to parse. - * @param [in] targetComponent The component to which add the port. + * @param [in] declaration The VHDL port declaration to parse. + * @param [in] targetComponent The component to which add the port. * - * @return The port bounds in the given declaration. + * @return The port bounds in the given declaration. */ QPair parsePortBounds(QString const& declaration, QSharedPointer targetComponent) const; @@ -185,9 +185,9 @@ class VHDLPortParser : public QObject, public HighlightSource /*! * Creates a default type definition for the given type. * - * @param [in] type The type whose type definition to create. + * @param [in] type The type whose type definition to create. * - * @return The default type defition for the type, if any. + * @return The default type defition for the type, if any. */ QString createDefaultTypeDefinition(QString const& type) const; diff --git a/Plugins/VHDLimport/VHDLimport.h b/Plugins/VHDLimport/VHDLimport.h index 6c22cc554..96d74bc4f 100644 --- a/Plugins/VHDLimport/VHDLimport.h +++ b/Plugins/VHDLimport/VHDLimport.h @@ -106,23 +106,23 @@ class VHDLIMPORT_EXPORT VHDLimport : public QObject, public ImportPlugin, public /*! * Returns the supported import file types. * - * @return The file types the import parser supports. + * @return The file types the import parser supports. */ virtual QStringList getSupportedFileTypes() const; /*! * Gets any compatibility warnings for the plugin. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const; /*! * Parses a vhdl input, sets up an rtl view and creates generics and ports. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration Declaration of the selected entity. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration Declaration of the selected entity. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent) override final; @@ -130,32 +130,32 @@ class VHDLIMPORT_EXPORT VHDLimport : public QObject, public ImportPlugin, public /*! * Sets the given highlighter to be used by the import. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); /*! * Sets the given visualizer to be used by the import. * - * @param [in] visualizer The visualizer to use. + * @param [in] visualizer The visualizer to use. */ virtual void setModelParameterVisualizer(ModelParameterVisualizer* visualizer); /*! * Get component declarations from the selected input file. * - * @param [in] input The selected input file. + * @param [in] input The selected input file. * - * @return List of component declarations found in the selected input. + * @return List of component declarations found in the selected input. */ virtual QStringList getFileComponents(QString const& input) const override final; /*! * Get the name of the selected component declaration. * - * @param [in] componentDeclaration The selected component declaration. + * @param [in] componentDeclaration The selected component declaration. * - * @return Name of the selected component declaration. + * @return Name of the selected component declaration. */ virtual QString getComponentName(QString const& componentDeclaration) const override final; @@ -171,24 +171,24 @@ class VHDLIMPORT_EXPORT VHDLimport : public QObject, public ImportPlugin, public /*! * Checks if given vhdl file has a valid entity declaration. * - * @param [in] fileString The vhdl file as string. + * @param [in] fileString The vhdl file as string. * - * @return True if the file has a valid entity, otherwise false. + * @return True if the file has a valid entity, otherwise false. */ bool hasValidEntity(QString const& fileContent) const; /*! * Highlights the entity section in the input. * - * @param [in] fileContent The input file content to highlight entity in. + * @param [in] fileContent The input file content to highlight entity in. */ void highlightEntity(QString const& fileContent) const; /*! * Parses the model name and architecture name from the input and sets it in the rtl view. * - * @param [in] input The input text to parse the model name from. - * @param [in/out] targetInstantiation The instantiation to set the names in. + * @param [in] input The input text to parse the model name from. + * @param [in/out] targetInstantiation The instantiation to set the names in. */ void parseModelNameAndArchitecture(QString const& input, QString const& componentDeclaration, QSharedPointer targetInstantiation) const; @@ -196,14 +196,14 @@ class VHDLIMPORT_EXPORT VHDLimport : public QObject, public ImportPlugin, public /*! * Highlights the architecture from which the model name was created. * - * @param [in] architectureExp Regular expression for capturing architecture. + * @param [in] architectureExp Regular expression for capturing architecture. */ void highlightArchitecture(QRegularExpressionMatch const& architectureExp) const; /*! * Highlights the configuration from which the model name was created. * - * @param [in] configurationExp Regular expression for capturing configuration. + * @param [in] configurationExp Regular expression for capturing configuration. */ void highlightConfiguration(QRegularExpressionMatch const& configurationExp) const; @@ -215,7 +215,7 @@ class VHDLIMPORT_EXPORT VHDLimport : public QObject, public ImportPlugin, public /*! * Finds a flat (rtl) view from the target component or creates one, if none are found. * - * @return Flat view to set up with model name and environmental identifiers. + * @return Flat view to set up with model name and environmental identifiers. */ QSharedPointer findOrCreateFlatView() const; diff --git a/Plugins/VerilogGenerator/CommentWriter/CommentWriter.h b/Plugins/VerilogGenerator/CommentWriter/CommentWriter.h index 09f25a9b3..e489f1f42 100644 --- a/Plugins/VerilogGenerator/CommentWriter/CommentWriter.h +++ b/Plugins/VerilogGenerator/CommentWriter/CommentWriter.h @@ -36,21 +36,21 @@ class VERILOGGENERATORPLUGIN_EXPORT CommentWriter : public Writer /*! * Writes the comment to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const; /*! * Sets the maximum number of characters per line. * - * @param [in] maxLength The maximum number of characters to set. + * @param [in] maxLength The maximum number of characters to set. */ void setLineLength(int maxLength); /*! * Sets the indent for each line. * - * @param [in] size The number of spaces used for indent. + * @param [in] size The number of spaces used for indent. */ void setIndent(int size); @@ -63,7 +63,7 @@ class VERILOGGENERATORPLUGIN_EXPORT CommentWriter : public Writer /*! * Checks if the writer should write nothing. * - * @return True, if the writer has nothing to write, otherwise false. + * @return True, if the writer has nothing to write, otherwise false. */ bool nothingToWrite() const; diff --git a/Plugins/VerilogGenerator/ComponentInstanceVerilogWriter/ComponentInstanceVerilogWriter.h b/Plugins/VerilogGenerator/ComponentInstanceVerilogWriter/ComponentInstanceVerilogWriter.h index 6ec03fa46..f4c824180 100644 --- a/Plugins/VerilogGenerator/ComponentInstanceVerilogWriter/ComponentInstanceVerilogWriter.h +++ b/Plugins/VerilogGenerator/ComponentInstanceVerilogWriter/ComponentInstanceVerilogWriter.h @@ -37,9 +37,9 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * The constructor. * - * @param [in] instance The component instance to write to Verilog - * @param [in] sorter Sorter for the ports in the component. - * @param [in] useInterfaces True, if interfaces are used where applicable. False means always ports. + * @param [in] instance The component instance to write to Verilog + * @param [in] sorter Sorter for the ports in the component. + * @param [in] useInterfaces True, if interfaces are used where applicable. False means always ports. */ ComponentInstanceVerilogWriter(QSharedPointer instance, QSharedPointer sorter, bool useInterfaces); @@ -50,25 +50,25 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * Writes the Verilog instance into a text stream. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ virtual void write(QTextStream& outputStream) const; /*! * Adds a port connection assignment for the instance. * - * @param [in] instancePortName The name of the port in the instance to assign. - * @param [in] assignedConnection The name of the connection to assign. + * @param [in] instancePortName The name of the port in the instance to assign. + * @param [in] assignedConnection The name of the connection to assign. */ void assignPortForFullWidth(QString const& instancePortName, QString const& assignedConnection); /*! * Adds a port connection assignment for the instance for a range of bits. * - * @param [in] instancePortName The name of the port in the instance to assign. - * @param [in] assignedConnection The name of the connection to assign. - * @param [in] leftBound The left bound of the connection to assign. - * @param [in] rightBound The right bound of the connection to assign. + * @param [in] instancePortName The name of the port in the instance to assign. + * @param [in] assignedConnection The name of the connection to assign. + * @param [in] leftBound The left bound of the connection to assign. + * @param [in] rightBound The right bound of the connection to assign. */ void assignPortForRange(QString const& instancePortName, QString const& assignedConnection, QPair wireBounds); @@ -76,8 +76,8 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * Assigns a port tie off value for the instance writer. * - * @param [in] portName The name of the port containing the tie off value. - * @param [in] tieOffValue The tie off value. + * @param [in] portName The name of the port containing the tie off value. + * @param [in] tieOffValue The tie off value. */ void assignPortTieOff(QString const& portName, QString const& tieOffValue); @@ -90,76 +90,76 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * Gets the component instance name with or without indentation as required. * - * @return The formatted instance name. + * @return The formatted instance name. */ QString formattedInstanceName() const; /*! * Gets the indentation to use. * - * @return The indentation to use. + * @return The indentation to use. */ QString indentation() const; /*! * Gets the instance-specific parameter assignments. * - * @return The Verilog description of the instance parameters and their values. + * @return The Verilog description of the instance parameters and their values. */ QString parameterAssignments() const; /*! * Gets the instance ports and their connections. * - * @return The Verilog description of the instance ports and their connections. + * @return The Verilog description of the instance ports and their connections. */ QString portConnections() const; /*! * Creates an interface separator for port connections. * - * @param [in] interfaceName The name of the interface for the current port. - * @param [in] previousInteface The name of the interface for the previous port. + * @param [in] interfaceName The name of the interface for the current port. + * @param [in] previousInteface The name of the interface for the previous port. * - * @return Separator for port interface. + * @return Separator for port interface. */ QString createInterfaceSeparator(QString const& interfaceName, QString const& previousInteface) const; /*! * Gets the connection assignment for a port of a module instance. * - * @param [in] mPort The meta port whose connection assignment to get. + * @param [in] mPort The meta port whose connection assignment to get. * - * @return The Verilog description of the instance port connection assignment. + * @return The Verilog description of the instance port connection assignment. */ QString assignmentForInstancePort(QSharedPointer mPort) const; /*! * Get the default value assignment for a port. * - * @param [in] mPort The selected port. + * @param [in] mPort The selected port. * - * @return The default value assignment of the selected port. + * @return The default value assignment of the selected port. */ QString getDefaultValueAssignment(QSharedPointer mPort) const; /*! * Get the connection assignment for an INOUT port. * - * @param [in] mPort The selected INOUT port. + * @param [in] mPort The selected INOUT port. * - * @return Verilog description of the port assignment. + * @return Verilog description of the port assignment. */ QString getInOutAssignment(QSharedPointer mPort) const; /*! * Get the hierarchical port connected to the selected port. * - * @param [in] metaPort The selected port. - * @param [in] metaAssignment Assignment for the selected port. - * @param [in] assignmentWire Wire of the connection. + * @param [in] metaPort The selected port. + * @param [in] metaAssignment Assignment for the selected port. + * @param [in] assignmentWire Wire of the connection. * - * @return The hierarchical port connected to the selected port and its port assignment. + * @return The hierarchical port connected to the selected port and its port assignment. */ QPair, QSharedPointer > getConnectedHierarchicalPort( QSharedPointer metaPort, @@ -169,10 +169,10 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * Get the port assignment for the selected port. * - * @param [in] hierarchicalPort The selected port. - * @param [in] assignedWire Wire of the connection. + * @param [in] hierarchicalPort The selected port. + * @param [in] assignedWire Wire of the connection. * - * @return Port assignment of the selected port. + * @return Port assignment of the selected port. */ QSharedPointer getHierarchicalPortAssignmentConnectedToWire( QSharedPointer hierarchicalPort, @@ -194,10 +194,10 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentInstanceVerilogWriter : public Writ /*! * Get the data required for writing the default value of the selected port. * - * @param [in] portDefaultValue The default value. - * @param [in] port The selected port. + * @param [in] portDefaultValue The default value. + * @param [in] port The selected port. * - * @return Data required for writing the default value. + * @return Data required for writing the default value. */ DefaultValueData getDefaultValueBits(QString const& portDefaultValue, QSharedPointer port) const; diff --git a/Plugins/VerilogGenerator/ComponentVerilogWriter/ComponentVerilogWriter.h b/Plugins/VerilogGenerator/ComponentVerilogWriter/ComponentVerilogWriter.h index 281114792..99699b101 100644 --- a/Plugins/VerilogGenerator/ComponentVerilogWriter/ComponentVerilogWriter.h +++ b/Plugins/VerilogGenerator/ComponentVerilogWriter/ComponentVerilogWriter.h @@ -42,8 +42,8 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentVerilogWriter : public WriterGroup /*! * The constructor. * - * @param [in] component The component to write to Verilog. - * @param [in] useInterfaces True, if interfaces are utilized separately from physical ports, else false. + * @param [in] component The component to write to Verilog. + * @param [in] useInterfaces True, if interfaces are utilized separately from physical ports, else false. */ ComponentVerilogWriter(QSharedPointer component, bool useInterfaces); @@ -52,7 +52,7 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentVerilogWriter : public WriterGroup /*! Writes the Verilog module into a text stream. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& outputStream) const; @@ -74,55 +74,55 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentVerilogWriter : public WriterGroup /*! * Checks if the writer should write nothing. * - * @return True, if the writer has nothing to write, otherwise false. + * @return True, if the writer has nothing to write, otherwise false. */ bool nothingToWrite() const; /*! * Writes the module declaration. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeModuleDeclaration( QTextStream& outputStream ) const; /*! * Writes the module parameter declaration. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeParameterDeclarations(QTextStream& outputStream) const; /*! * Writes a single parameter declaration. * - * @param [in] outputStream The output to write to. - * @param [in] parameter The parameter to write. - * @param [in] isLast Indicates if the parameter is the last to write. + * @param [in] outputStream The output to write to. + * @param [in] parameter The parameter to write. + * @param [in] isLast Indicates if the parameter is the last to write. */ void writeParameter(QTextStream& outputStream, QSharedPointer parameter, bool isLast) const; /*! * Writes the module port declaration. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writePortDeclarations(QTextStream& outputStream) const; /*! * Writes a single port declaration. * - * @param [in] outputStream The output to write to. - * @param [in] port The port to write. - * @param [in] isLast Indicates if the port is the last to write. + * @param [in] outputStream The output to write to. + * @param [in] port The port to write. + * @param [in] isLast Indicates if the port is the last to write. */ void writePort(QTextStream& outputStream, QSharedPointer port, bool isLast) const; /*! * Writes a bus interface introduction. * - * @param [in] interfaceName The name of the bus interface to introduce. - * @param [in] previousInterfaceName The name of the previously introduced bus interface. - * @param [in] outputStream The output to write to. + * @param [in] interfaceName The name of the bus interface to introduce. + * @param [in] previousInterfaceName The name of the previously introduced bus interface. + * @param [in] outputStream The output to write to. */ void writeInterfaceIntroduction(QString const& interfaceName, QString const& interfaceDescription, QString& previousInterfaceName, QTextStream& outputStream ) const; @@ -130,35 +130,35 @@ class VERILOGGENERATORPLUGIN_EXPORT ComponentVerilogWriter : public WriterGroup /*! * Writes the inserted wires and component instances of the top-level component. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeInternalWiresAndComponentInstances(QTextStream& outputStream) const; /*! * Writes the defined conditions of the remap states. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeRemapSates(QTextStream& outputStream) const; /*! * Writes the module port declaration. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeRegisters(QTextStream& outputStream) const; /*! * Writes the ending clause for the module. * - * @param [in] outputStream The output to write to. + * @param [in] outputStream The output to write to. */ void writeModuleEnd(QTextStream& outputStream) const; /*! * Gets the indentation to use. * - * @return The indentation to use. + * @return The indentation to use. */ QString indentation(int depth = 1) const; diff --git a/Plugins/VerilogGenerator/ModelParameterVerilogWriter/ModelParameterVerilogWriter.h b/Plugins/VerilogGenerator/ModelParameterVerilogWriter/ModelParameterVerilogWriter.h index 0febe835e..38bbfd17f 100644 --- a/Plugins/VerilogGenerator/ModelParameterVerilogWriter/ModelParameterVerilogWriter.h +++ b/Plugins/VerilogGenerator/ModelParameterVerilogWriter/ModelParameterVerilogWriter.h @@ -32,7 +32,7 @@ class VERILOGGENERATORPLUGIN_EXPORT ModuleParameterVerilogWriter : public Writer /*! * The constructor. * - * @param [in] ModuleParameter The model parameter represented by this object. + * @param [in] ModuleParameter The model parameter represented by this object. */ ModuleParameterVerilogWriter(QSharedPointer parameter); @@ -41,7 +41,7 @@ class VERILOGGENERATORPLUGIN_EXPORT ModuleParameterVerilogWriter : public Writer /*! Write the contents of the model parameter into text stream. * - * @param [in] output The text stream to write the model parameter into. + * @param [in] output The text stream to write the model parameter into. */ virtual void write(QTextStream& output) const; @@ -56,28 +56,28 @@ class VERILOGGENERATORPLUGIN_EXPORT ModuleParameterVerilogWriter : public Writer /*! * Checks if the writer should write nothing. * - * @return True, if the writer has nothing to write, otherwise false. + * @return True, if the writer has nothing to write, otherwise false. */ bool nothingToWrite() const; /*! * Creates a Verilog parameter declaration from the model parameter. * - * @return A Verilog parameter declaration. + * @return A Verilog parameter declaration. */ QString createDeclaration() const; /*! * Returns the array bounds for the model parameter. * - * @return The array bounds. + * @return The array bounds. */ QString arrayBounds() const; /*! * Returns the formatted model parameter value. * - * @return The formatted model parameter value. + * @return The formatted model parameter value. */ QString formattedValue() const; diff --git a/Plugins/VerilogGenerator/TextBodyWriter/TextBodyWriter.h b/Plugins/VerilogGenerator/TextBodyWriter/TextBodyWriter.h index 012fb0c7b..9424028c7 100644 --- a/Plugins/VerilogGenerator/TextBodyWriter/TextBodyWriter.h +++ b/Plugins/VerilogGenerator/TextBodyWriter/TextBodyWriter.h @@ -30,7 +30,7 @@ class VERILOGGENERATORPLUGIN_EXPORT TextBodyWriter : public Writer /*! * Writes the comment to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const; diff --git a/Plugins/VerilogGenerator/VerilogAssignmentWriter/VerilogAssignmentWriter.h b/Plugins/VerilogGenerator/VerilogAssignmentWriter/VerilogAssignmentWriter.h index 0a0ec5a7e..a34e95ca5 100644 --- a/Plugins/VerilogGenerator/VerilogAssignmentWriter/VerilogAssignmentWriter.h +++ b/Plugins/VerilogGenerator/VerilogAssignmentWriter/VerilogAssignmentWriter.h @@ -46,7 +46,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogAssignmentWriter : public Writer /*! * Writes the assignments to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const override; @@ -55,21 +55,21 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogAssignmentWriter : public Writer /*! * Creates an assignment for a port. * - * @return The Verilog description of the port connection assignment. + * @return The Verilog description of the port connection assignment. */ QString assignmentForPort() const; /*! * Creates the logical side of the port assignment. * - * @return The logical side for the port connection. + * @return The logical side for the port connection. */ QString createLogicalAssignment(bool assignToPort) const; /*! * Creates the physical side of the port assignment. * - * @return The physical side for the port connection. + * @return The physical side for the port connection. */ QString createPhysicalAssignment() const; diff --git a/Plugins/VerilogGenerator/VerilogGeneratorPlugin.h b/Plugins/VerilogGenerator/VerilogGeneratorPlugin.h index 4908f63ad..4dfa5104a 100644 --- a/Plugins/VerilogGenerator/VerilogGeneratorPlugin.h +++ b/Plugins/VerilogGenerator/VerilogGeneratorPlugin.h @@ -95,12 +95,12 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogGeneratorPlugin : public QObject, pub /*! * Checks whether the generator may run for the given component or design. * - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. * - * @return True, if the generator may run the given component. Otherwise false. + * @return True, if the generator may run the given component. Otherwise false. */ virtual bool checkGeneratorSupport(QSharedPointer component, QSharedPointer design, @@ -110,11 +110,11 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogGeneratorPlugin : public QObject, pub * Runs the generation, creating new files and/or modifying the IP-XACT metadata. The function has * also access to the parent window widget, so that it can show dialogs for the user to aid the generation. * - * @param [in] utility The plugin utility interface. - * @param [in] component The component for which to check support. If design is not null, component + * @param [in] utility The plugin utility interface. + * @param [in] component The component for which to check support. If design is not null, component * will refer to design or designConfiguration. - * @param [in] design The design, if the generator is ran for a design. - * @param [in] designConfiguration The design configuration for design, if it is not null. + * @param [in] design The design, if the generator is ran for a design. + * @param [in] designConfiguration The design configuration for design, if it is not null. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, @@ -124,19 +124,19 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogGeneratorPlugin : public QObject, pub /*! * Gets the output format generated by the plugin. * - * @return The output file format generated by the plugin. + * @return The output file format generated by the plugin. */ virtual QString getOutputFormat() const override final; /*! * Runs the generation. * - * @param [in] utility Utilities for enabling plugin execution. - * @param [in] component The component to run the generation for. - * @param [in] design The design to run the generation for. - * @param [in] designConfiguration The design configuration to run the generation for. - * @param [in] viewName The component view name to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] utility Utilities for enabling plugin execution. + * @param [in] component The component to run the generation for. + * @param [in] design The design to run the generation for. + * @param [in] designConfiguration The design configuration to run the generation for. + * @param [in] viewName The component view name to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ virtual void runGenerator(IPluginUtility* utility, QSharedPointer component, diff --git a/Plugins/VerilogGenerator/VerilogHeaderWriter/VerilogHeaderWriter.h b/Plugins/VerilogGenerator/VerilogHeaderWriter/VerilogHeaderWriter.h index ec7f88c8f..25a39de71 100644 --- a/Plugins/VerilogGenerator/VerilogHeaderWriter/VerilogHeaderWriter.h +++ b/Plugins/VerilogGenerator/VerilogHeaderWriter/VerilogHeaderWriter.h @@ -30,12 +30,12 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogHeaderWriter /*! * The constructor. * - * @param [in] vlnv The VLNV of the top level component. - * @param [in] xmlPath The path to the top level component XML file. - * @param [in] author The creator of the file. - * @param [in] description The description of the top level component. - * @param [in] kactusVersion The version of the current Kactus2 build. - * @param [in] generatorVersion The current version of the generator. + * @param [in] vlnv The VLNV of the top level component. + * @param [in] xmlPath The path to the top level component XML file. + * @param [in] author The creator of the file. + * @param [in] description The description of the top level component. + * @param [in] kactusVersion The version of the current Kactus2 build. + * @param [in] generatorVersion The current version of the generator. */ VerilogHeaderWriter(VLNV const& vlnv, QString const& xmlPath, QString const& author, QString const& description, QString const& kactusVersion, QString const& generatorVersion); @@ -46,8 +46,8 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogHeaderWriter /*! * Writes a header to the given output. * - * @param [in] outputStream The output to write to. - * @param [in] generationTime Time of the generation. + * @param [in] outputStream The output to write to. + * @param [in] generationTime Time of the generation. */ void write(QTextStream& outputStream, QString const& fileName, QDateTime const& generationTime) const; diff --git a/Plugins/VerilogGenerator/VerilogInterconnectionWriter/VerilogInterconnectionWriter.h b/Plugins/VerilogGenerator/VerilogInterconnectionWriter/VerilogInterconnectionWriter.h index 32382e2a8..89fde5854 100644 --- a/Plugins/VerilogGenerator/VerilogInterconnectionWriter/VerilogInterconnectionWriter.h +++ b/Plugins/VerilogGenerator/VerilogInterconnectionWriter/VerilogInterconnectionWriter.h @@ -32,7 +32,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogInterconnectionWriter : public Writer /*! * Writes the interconnection to given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const; @@ -45,21 +45,21 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogInterconnectionWriter : public Writer /*! * Gets the indentation to use. * - * @return The indentation to use. + * @return The indentation to use. */ QString indentation() const; /*! * Gets the instance-specific parameter assignments. * - * @return The Verilog description of the instance parameters and their values. + * @return The Verilog description of the instance parameters and their values. */ QString parameterAssignments() const; /*! * Gets the formatted size for the wire. * - * @return The formatted size. + * @return The formatted size. */ QString formattedSize() const; diff --git a/Plugins/VerilogGenerator/VerilogPortWriter/VerilogPortWriter.h b/Plugins/VerilogGenerator/VerilogPortWriter/VerilogPortWriter.h index c0dc915d5..745de7555 100644 --- a/Plugins/VerilogGenerator/VerilogPortWriter/VerilogPortWriter.h +++ b/Plugins/VerilogGenerator/VerilogPortWriter/VerilogPortWriter.h @@ -28,7 +28,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogPortWriter : public Writer /*! * The constructor. * - * @param [in] port The port to write to Verilog. + * @param [in] port The port to write to Verilog. */ VerilogPortWriter(QSharedPointer port); @@ -37,7 +37,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogPortWriter : public Writer /*! Writes the Verilog port declaration into a text stream. * - * @param [in] output The text stream to write the port into. + * @param [in] output The text stream to write the port into. */ void write(QTextStream& outputStream) const; @@ -52,21 +52,21 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogPortWriter : public Writer /*! * Checks if the writer should write nothing. * - * @return True, if the writer has nothing to write, otherwise false. + * @return True, if the writer has nothing to write, otherwise false. */ bool nothingToWrite() const; /*! * Creates a Verilog port declaration from the port model. * - * @return A Verilog port declaration. + * @return A Verilog port declaration. */ QString createDeclaration() const; /*! * Creates a string representation of the port direction. * - * @return The port direction. + * @return The port direction. */ QString direction() const; diff --git a/Plugins/VerilogGenerator/VerilogPortWriter/VerilogTopDefaultWriter.h b/Plugins/VerilogGenerator/VerilogPortWriter/VerilogTopDefaultWriter.h index 89e047d8c..573419d20 100644 --- a/Plugins/VerilogGenerator/VerilogPortWriter/VerilogTopDefaultWriter.h +++ b/Plugins/VerilogGenerator/VerilogPortWriter/VerilogTopDefaultWriter.h @@ -29,7 +29,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogTopDefaultWriter : public Writer /*! * The constructor. * - * @param [in] mPort The port, which default value assignment will be written, if applicable. + * @param [in] mPort The port, which default value assignment will be written, if applicable. */ VerilogTopDefaultWriter(QSharedPointer mPort); @@ -41,7 +41,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogTopDefaultWriter : public Writer /*! * Writes the assignments to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const; diff --git a/Plugins/VerilogGenerator/VerilogSourceHighlight.h b/Plugins/VerilogGenerator/VerilogSourceHighlight.h index c27d1e276..f6ebc5c4e 100644 --- a/Plugins/VerilogGenerator/VerilogSourceHighlight.h +++ b/Plugins/VerilogGenerator/VerilogSourceHighlight.h @@ -38,21 +38,21 @@ class VerilogSourceHighlight : public SourceHighlightStyle /*! * Get the language specific keywords. * - * @return The language keywords. + * @return The language keywords. */ virtual QStringList keywords() const; /*! * Get the language specific preprocessor directives. * - * @return The preprocessor directives. + * @return The preprocessor directives. */ virtual QStringList preprocessorDirectives() const; /*! * Apply other language specific rules to highlighting. * - * @param [in] highlighter The highlighter to apply the rules to. + * @param [in] highlighter The highlighter to apply the rules to. */ virtual void applyLanguageSpecificRules(LanguageHighlighter* highlighter) const; diff --git a/Plugins/VerilogGenerator/VerilogWireWriter/VerilogWireWriter.h b/Plugins/VerilogGenerator/VerilogWireWriter/VerilogWireWriter.h index f253be37b..8593818d4 100644 --- a/Plugins/VerilogGenerator/VerilogWireWriter/VerilogWireWriter.h +++ b/Plugins/VerilogGenerator/VerilogWireWriter/VerilogWireWriter.h @@ -32,7 +32,7 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogWireWriter : public Writer /*! * Writes the wire to given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const; @@ -45,14 +45,14 @@ class VERILOGGENERATORPLUGIN_EXPORT VerilogWireWriter : public Writer /*! * Creates a Verilog wire declaration. * - * @return The Verilog wire declaration for this wire. + * @return The Verilog wire declaration for this wire. */ QString createDeclaration() const; /*! * Gets the formatted size for the wire. * - * @return The formatted size. + * @return The formatted size. */ QString formattedSize(QPair const& bounds) const; diff --git a/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogDocument.h b/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogDocument.h index d60066652..902eea728 100644 --- a/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogDocument.h +++ b/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogDocument.h @@ -72,27 +72,27 @@ struct VerilogDocument : public GenerationOutput /*! * Writes the content. * - * @param [in] outputDirectory The possible output directory. + * @param [in] outputDirectory The possible output directory. */ virtual void write(QString const& outputDirectory) override; /*! * Finds position for body text highlight in document, if any exists. * - * @param [out] begin The position where the highlight begins, if successful. - * @param [out] end The position where the highlight ends, if successful. + * @param [out] begin The position where the highlight begins, if successful. + * @param [out] end The position where the highlight ends, if successful. */ virtual void getBodyHighlight(int& begin, int& end) const override; /*! * Finds the module implementation in Verilog code. * - * @param [in] code The code that will be inspected. - * @param [out] implementation The found module implementation, if successful. - * @param [out] postModule Anything that exists after the module declaration. - * @param [out] error If fails, this will contain an error message. + * @param [in] code The code that will be inspected. + * @param [out] implementation The found module implementation, if successful. + * @param [out] postModule Anything that exists after the module declaration. + * @param [out] error If fails, this will contain an error message. * - * @return True, if a single implementation could be found, else false. + * @return True, if a single implementation could be found, else false. */ bool selectImplementation(QString const& code, QString& implementation, QString& postModule, QString& error); diff --git a/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogWriterFactory.h b/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogWriterFactory.h index 3ca628e7c..a552d0b21 100644 --- a/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogWriterFactory.h +++ b/Plugins/VerilogGenerator/VerilogWriterFactory/VerilogWriterFactory.h @@ -29,11 +29,11 @@ class VerilogWriterFactory : public IWriterFactory /*! * The constructor. * - * @param [in] library The component library. - * @param [in] messages For message output. - * @param [in] settings Points to the settings to be used within the generation. - * @param [in] kactusVersion The version of the current Kactus build. - * @param [in] generatorVersion The current version of the generator. + * @param [in] library The component library. + * @param [in] messages For message output. + * @param [in] settings Points to the settings to be used within the generation. + * @param [in] kactusVersion The version of the current Kactus build. + * @param [in] generatorVersion The current version of the generator. */ VerilogWriterFactory(LibraryInterface* library, MessageMediator* messages, GenerationSettings* settings, @@ -45,10 +45,10 @@ class VerilogWriterFactory : public IWriterFactory /*! * Creates writers for the given formatted HDL component. * - * @param [in] outputPath The path to the output file. - * @param [in] component The component which is needs writing. + * @param [in] outputPath The path to the output file. + * @param [in] component The component which is needs writing. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QSharedPointer prepareComponent(QString const& outputPath, QSharedPointer component) override final; @@ -56,9 +56,9 @@ class VerilogWriterFactory : public IWriterFactory /*! * Creates writers for the given meta designs. * - * @param [in] designs The designs that will yield documents. + * @param [in] designs The designs that will yield documents. * - * @return The objects that bundles the writers. Will be null, if could not be created. + * @return The objects that bundles the writers. Will be null, if could not be created. */ virtual QList > prepareDesign(QList >& designs) override final; @@ -87,26 +87,26 @@ class VerilogWriterFactory : public IWriterFactory /*! * Checks if given file exists, and tries to parse its existing implementation. * - * @param [in] document The document, which will get writers for writing design. - * @param [in] outputPath The path of the potentially the existing file. + * @param [in] document The document, which will get writers for writing design. + * @param [in] outputPath The path of the potentially the existing file. * - * @return False, if the file exists, but could not be opened or parsed properly. Else true. + * @return False, if the file exists, but could not be opened or parsed properly. Else true. */ bool readImplementation(QSharedPointer document, QString const& outputPath); /*! * Initializes writers for component. * - * @param [in] document The document, which will get writers for writing component. - * @param [in] component The component, which data will be written. + * @param [in] document The document, which will get writers for writing component. + * @param [in] component The component, which data will be written. */ void initializeComponentWriters(QSharedPointer document, QSharedPointer component); /*! * Initializes writers for the given design. * - * @param [in] document The document, which will get writers for writing design. - * @param [in] design The design, which data will be written. + * @param [in] document The document, which will get writers for writing design. + * @param [in] design The design, which data will be written. */ void initializeDesignWriters(QSharedPointer document, QSharedPointer design); @@ -118,9 +118,9 @@ class VerilogWriterFactory : public IWriterFactory /*! * Creates a writer for writing a preceding header for a component instance. * - * @param [in] instanceName The name of the component instance to create the writer for. + * @param [in] instanceName The name of the component instance to create the writer for. * - * @return A writer for the header. + * @return A writer for the header. */ QSharedPointer createHeaderWriterForInstance(QSharedPointer instance) const; diff --git a/Plugins/VerilogGenerator/common/Writer.h b/Plugins/VerilogGenerator/common/Writer.h index 0ee266200..22c707fdf 100644 --- a/Plugins/VerilogGenerator/common/Writer.h +++ b/Plugins/VerilogGenerator/common/Writer.h @@ -27,7 +27,7 @@ class Writer /*! * Writes the content to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& output) const = 0; diff --git a/Plugins/VerilogGenerator/common/WriterGroup.h b/Plugins/VerilogGenerator/common/WriterGroup.h index 7a0de7263..6928f2457 100644 --- a/Plugins/VerilogGenerator/common/WriterGroup.h +++ b/Plugins/VerilogGenerator/common/WriterGroup.h @@ -36,14 +36,14 @@ class VERILOGGENERATORPLUGIN_EXPORT WriterGroup : public Writer /*! * Writes the content to the given output. * - * @param [in] output The output to write to. + * @param [in] output The output to write to. */ virtual void write(QTextStream& outputStream) const; /*! * Adds a new writer to the group. * - * @param [in] writer The writer to add. + * @param [in] writer The writer to add. */ void add(QSharedPointer writer); diff --git a/Plugins/VerilogImport/VerilogImporter.h b/Plugins/VerilogImport/VerilogImporter.h index d23e7f214..56b3aee38 100644 --- a/Plugins/VerilogImport/VerilogImporter.h +++ b/Plugins/VerilogImport/VerilogImporter.h @@ -95,41 +95,41 @@ class VERILOGIMPORT_EXPORT VerilogImporter: public QObject, public ImportPlugin, /*! * Returns the supported import file types. * - * @return The file types the import parser supports. + * @return The file types the import parser supports. */ virtual QStringList getSupportedFileTypes() const override final; /*! * Gets any compatibility warnings for the plugin. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const override final; /*! * Get component declarations from the selected input file. * - * @param [in] input The selected input file. + * @param [in] input The selected input file. * - * @return List of component declarations found in the selected input. + * @return List of component declarations found in the selected input. */ virtual QStringList getFileComponents(QString const& input) const override final; /*! * Get the name of the selected component declaration. * - * @param [in] componentDeclaration The selected component declaration. + * @param [in] componentDeclaration The selected component declaration. * - * @return Name of the selected component declaration. + * @return Name of the selected component declaration. */ virtual QString getComponentName(QString const& componentDeclaration) const override final; /*! * Parses a verilog input, sets up an rtl view and creates model parameters and ports. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration Declaration of the selected component. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration Declaration of the selected component. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent) override final; @@ -137,14 +137,14 @@ class VERILOGIMPORT_EXPORT VerilogImporter: public QObject, public ImportPlugin, /*! * Sets the given visualizer to be used by the import. * - * @param [in] visualizer The visualizer to use. + * @param [in] visualizer The visualizer to use. */ virtual void setHighlighter(Highlighter* highlighter) override final; /*! * Sets the parser to use for expressions. * - * @param [in] parser The parser to use. + * @param [in] parser The parser to use. */ virtual void setExpressionParser(QSharedPointer parser) override final; @@ -158,25 +158,25 @@ class VERILOGIMPORT_EXPORT VerilogImporter: public QObject, public ImportPlugin, /*! * Checks if the given input has a valid module declaration. * - * @param [in] input The input to search for module declaration. + * @param [in] input The input to search for module declaration. * - * @return True, if a valid module was found, otherwise false. + * @return True, if a valid module was found, otherwise false. */ bool hasModuleDeclaration(QString const& input); /*! * Highlights the module section in the input. * - * @param [in] input The input file content to highlight entity in. - * @param [in] moduleDeclaration Selected module declaration from the file. + * @param [in] input The input file content to highlight entity in. + * @param [in] moduleDeclaration Selected module declaration from the file. */ void highlightModule(QString const& input, QString const& moduleDeclaration); /*! * Parses the model name from the input and sets it in the rtl view. * - * @param [in] moduleDeclaration The selected module declaration. - * @param [in/out] targetComponentInstantiation The component instance to set the name in. + * @param [in] moduleDeclaration The selected module declaration. + * @param [in/out] targetComponentInstantiation The component instance to set the name in. */ void importModelName(QString const& moduleDeclaration, QSharedPointer targetComponentInstantiation); @@ -184,7 +184,7 @@ class VERILOGIMPORT_EXPORT VerilogImporter: public QObject, public ImportPlugin, /*! * Finds a flat (rtl) view from the target component or creates one, if none are found. * - * @return Flat view to set up with model name and environmental identifiers. + * @return Flat view to set up with model name and environmental identifiers. */ QSharedPointer findOrCreateFlatView(QSharedPointer targetComponent) const; diff --git a/Plugins/VerilogImport/VerilogInstanceParser.h b/Plugins/VerilogImport/VerilogInstanceParser.h index 919e99c81..7cca68727 100644 --- a/Plugins/VerilogImport/VerilogInstanceParser.h +++ b/Plugins/VerilogImport/VerilogInstanceParser.h @@ -44,9 +44,9 @@ class VerilogInstanceParser : public HighlightSource /*! * Runs the port parsing for the given input and adds the parsed ports to the given component. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration The selected component declaration. - * @param [in] targetComponent The component to add all the imported parameters to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration The selected component declaration. + * @param [in] targetComponent The component to add all the imported parameters to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent); @@ -54,7 +54,7 @@ class VerilogInstanceParser : public HighlightSource /*! * Sets the given highlighter to be used by the generic parser. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); @@ -63,20 +63,20 @@ class VerilogInstanceParser : public HighlightSource /*! * Find matches for the component instances in the selected verilog file. * - * @param [in] input The selected verilog file. - * @param [in] componentDeclaration The selected component declaration. + * @param [in] input The selected verilog file. + * @param [in] componentDeclaration The selected component declaration. * - * @return List of component instance matches. + * @return List of component instance matches. */ QVector findInstances(QString const& input, QString const& componentDeclaration); /*! * Highlight the selected component instance. * - * @param [in] input The selected verilog file. - * @param [in] moduleDeclaration The selected component declaration. - * @param [in] instanceMatch The selected component instance match. - * @param [in] multilineCommentIterator Regular expression Match iterator for multi line comments. + * @param [in] input The selected verilog file. + * @param [in] moduleDeclaration The selected component declaration. + * @param [in] instanceMatch The selected component instance match. + * @param [in] multilineCommentIterator Regular expression Match iterator for multi line comments. */ void highlightInstance(QString const& input, QString const& moduleDeclaration, QRegularExpressionMatch const& instanceMatch, @@ -85,10 +85,10 @@ class VerilogInstanceParser : public HighlightSource /*! * Check if a regular expression match is located within comments. * - * @param [in] expressionMatch The selected regular expression match. - * @param [in] commentMatchIterator Regular expression Match iterator for multi line comments. + * @param [in] expressionMatch The selected regular expression match. + * @param [in] commentMatchIterator Regular expression Match iterator for multi line comments. * - * @return True, if the match is located within comments, false otherwise. + * @return True, if the match is located within comments, false otherwise. */ bool matchIsWithinComments(QRegularExpressionMatch const& expressionMatch, QRegularExpressionMatchIterator commentMatchIterator) const; @@ -96,20 +96,20 @@ class VerilogInstanceParser : public HighlightSource /*! * Get a list of separated sub items and their values from the selected sub item declarations. * - * @param [in] subItemDeclarations The selected sub item declarations. + * @param [in] subItemDeclarations The selected sub item declarations. * - * @return List of sub item name value pairs. + * @return List of sub item name value pairs. */ QVector > getSeparatedSubItems(QString& subItemDeclarations) const; /*! * Create a vendor extension group for the contained sub items. * - * @param [in] groupName Name of the sub items. - * @param [in] itemType Type of the sub items. - * @param [in] subItems List of sub item name value pairs. + * @param [in] groupName Name of the sub items. + * @param [in] itemType Type of the sub items. + * @param [in] subItems List of sub item name value pairs. * - * @return The created sub item vendor extension group. + * @return The created sub item vendor extension group. */ QSharedPointer createSubItemGroup(QString const& groupName, QString const& itemType, QVector > const& subItems) const; diff --git a/Plugins/VerilogImport/VerilogParameterParser.h b/Plugins/VerilogImport/VerilogParameterParser.h index 68799186b..bbd52da47 100644 --- a/Plugins/VerilogImport/VerilogParameterParser.h +++ b/Plugins/VerilogImport/VerilogParameterParser.h @@ -44,9 +44,9 @@ class VerilogParameterParser : public HighlightSource /*! * Runs the port parsing for the given input and adds the parsed ports to the given component. * - * @param [in] componentDeclaration The selected component declaration from the input text. - * @param [in] targetComponent The component to add all the imported parameters to. - * @param [in] targetComponentInstantiation The instantiation to add all the imported parameters to. + * @param [in] componentDeclaration The selected component declaration from the input text. + * @param [in] targetComponent The component to add all the imported parameters to. + * @param [in] targetComponentInstantiation The instantiation to add all the imported parameters to. */ virtual void import(QString const& componentDeclaration, QSharedPointer targetComponent, QSharedPointer targetComponentInstantiation); @@ -54,25 +54,25 @@ class VerilogParameterParser : public HighlightSource /*! * Sets the given highlighter to be used by the generic parser. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); /*! * Finds parameter declarations in the given input. * - * @param [in] input The input text to parse. + * @param [in] input The input text to parse. * - * @return The resulting list of parameter declarations. + * @return The resulting list of parameter declarations. */ QStringList findDeclarations(QString const& input); /*! * Parses parameters out of declaration. * - * @param [in] input The input text containing a declaration of parameters. + * @param [in] input The input text containing a declaration of parameters. * - * @return The parsed model parameters. + * @return The parsed model parameters. */ QList > parseParameters(QString const &input); @@ -81,90 +81,90 @@ class VerilogParameterParser : public HighlightSource /*! * Find the section in the input containing the parameter declarations. * - * @param [in] input The input text to search. + * @param [in] input The input text to search. * - * @return The section of the text containing parameter declarations. + * @return The section of the text containing parameter declarations. */ QString findParameterSection(QString const &input); /*! * Finds parameter declarations from the given string. * - * @param [in] componentDeclaration The component declaration containing the parameters. - * @param [in] parameterArea The input text containing the declarations. + * @param [in] componentDeclaration The component declaration containing the parameters. + * @param [in] parameterArea The input text containing the declarations. * - * @return The resulting list of declarations. + * @return The resulting list of declarations. */ QStringList findParameterDeclarations(QString const& componentDeclaration, QString const& parameterArea); /*! * Create an IP-XACT type for the parameter according to the given data type. * - * @param [in] dataType The selected data type. + * @param [in] dataType The selected data type. * - * @return The type matching the data type, or none if data type does not match any IP-XACT type. + * @return The type matching the data type, or none if data type does not match any IP-XACT type. */ QString createTypeFromDataType(QString const& dataType); /*! * Tries to parse the type of the declared parameters. * - * @param [in] input The input text containing a declaration of parameters. + * @param [in] input The input text containing a declaration of parameters. * - * @return The parsed type. + * @return The parsed type. */ QString parseType(QString const& input); /*! * Parses the left value of bit width of the parameter. * - * @param [in] declaration The parameter declaration to parse. + * @param [in] declaration The parameter declaration to parse. * - * @return The left value of the parameters bit width vector. + * @return The left value of the parameters bit width vector. */ QString parseBitWidthLeft(QString const& declaration); /*! * Parses the right value of bit width of the parameter. * - * @param [in] declaration The parameter declaration to parse. + * @param [in] declaration The parameter declaration to parse. * - * @return The right value of the parameters bit width vector. + * @return The right value of the parameters bit width vector. */ QString parseBitWidthRight(QString const& declaration); /*! * Parses the left bound for the parameter array. * - * @param [in] declaration The parameter declaration to parse. + * @param [in] declaration The parameter declaration to parse. * - * @return The left array bound. + * @return The left array bound. */ QString parseArrayLeft(QString const& declaration); /*! * Parses the right bound for the parameter array. * - * @param [in] declaration The parameter declaration to parse. + * @param [in] declaration The parameter declaration to parse. * - * @return The right array bound. + * @return The right array bound. */ QString parseArrayRight(QString const& declaration); /*! * Tries to parse the descriptions of the declared parameters. * - * @param [in] input The input text containing a declaration of parameters. + * @param [in] input The input text containing a declaration of parameters. * - * @return The parsed description. + * @return The parsed description. */ QString parseDescription(QString const& input); /*! * Copies the model parameter ids from the component to the parsed model parameters. * - * @param [in] parsedParameters The parsed model parameters. - * @param [in] targetComponent The component to import to. + * @param [in] parsedParameters The parsed model parameters. + * @param [in] targetComponent The component to import to. */ void copyIdsFromOldModelParameters(QList > parsedParameters, QSharedPointer targetComponentInstantiation); @@ -172,7 +172,7 @@ class VerilogParameterParser : public HighlightSource /*! * Replaces the referenced model parameter names with their ids in model parameter values. * - * @param [in] targetComponent The component whose model parameter values to replace. + * @param [in] targetComponent The component whose model parameter values to replace. */ void replaceNamesReferencesWithIds(QList > parsedParameters, QSharedPointer targetComponent, @@ -181,8 +181,8 @@ class VerilogParameterParser : public HighlightSource /*! * Replaces macro uses in parameter with corresponding id references. * - * @param [in] parameter The parameter whose macro uses to replace. - * @param [in] targetComponent The containing component. + * @param [in] parameter The parameter whose macro uses to replace. + * @param [in] targetComponent The containing component. */ void replaceNameReferencesWithParameterIds(QSharedPointer parameter, QSharedPointer targetComponent) const; @@ -191,11 +191,11 @@ class VerilogParameterParser : public HighlightSource * Replaces a name reference in an expression with id. * Increases reference count of the referenced parameter accordingly. * - * @param [in] expression The expression to replace the references in. - * @param [in] namePattern The pattern for name reference search. - * @param [in] referenced The parameter that matches the name pattern. + * @param [in] expression The expression to replace the references in. + * @param [in] namePattern The pattern for name reference search. + * @param [in] referenced The parameter that matches the name pattern. * - * @return The expression where names have been replaced with the id of the referenced parameter. + * @return The expression where names have been replaced with the id of the referenced parameter. */ QString replaceNameWithId(QString const& expression, QRegularExpression& namePattern, QSharedPointer referenced) const; diff --git a/Plugins/VerilogImport/VerilogPortParser.h b/Plugins/VerilogImport/VerilogPortParser.h index f99695061..81a9d2fe2 100644 --- a/Plugins/VerilogImport/VerilogPortParser.h +++ b/Plugins/VerilogImport/VerilogPortParser.h @@ -39,8 +39,8 @@ class VerilogPortParser: public HighlightSource /*! * Runs the port parsing for the given input and adds the parsed ports to the given component. * - * @param [in] input The input text to parse. - * @param [in] targetComponent The component to add all the imported ports to. + * @param [in] input The input text to parse. + * @param [in] targetComponent The component to add all the imported ports to. */ virtual void import(QString const& input, QSharedPointer targetComponent, QSharedPointer targetComponentInstantiation); @@ -48,14 +48,14 @@ class VerilogPortParser: public HighlightSource /*! * Sets the given highlighter to be used by the port parser. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter) override final; /*! * Sets the parser to use for expressions. * - * @param [in] parser The parser to use. + * @param [in] parser The parser to use. */ void setExpressionParser(QSharedPointer parser); @@ -68,81 +68,81 @@ class VerilogPortParser: public HighlightSource /*! * Finds all port declarations from input. * - * @param [in] input The input to search for port declarations. + * @param [in] input The input to search for port declarations. * - * @return Found port declarations. + * @return Found port declarations. */ QStringList findPortDeclarations(QString const& input) const; /*! * Finds the section defining the ports of an module. * - * @param [in] input The input to search for port section. + * @param [in] input The input to search for port section. * - * @return The sections containing all ports in module. + * @return The sections containing all ports in module. */ QString findPortsSection(QString const& input) const; /*! * Checks if the given input has ports declared in Verilog-1995 style. * - * @param [in] input The input to check. + * @param [in] input The input to check. * - * @return True, if Verilog-1995 style ports are found, otherwise false. + * @return True, if Verilog-1995 style ports are found, otherwise false. */ bool hasVerilog1995Ports(QString const& input) const; /*! * Finds the end of module declaration in given input. * - * @param [in] input The input to search for module declaration end. + * @param [in] input The input to search for module declaration end. * - * @return The character index in the input for the end of module declaration. + * @return The character index in the input for the end of module declaration. */ int findStartOfPortList(QString const& input) const; /*! * Finds the section in the input containing all Verilog-1995 style ports. * - * @param [in] input The input to search for. + * @param [in] input The input to search for. * - * @return The section of the input containing all Verilog-1995 style ports. + * @return The section of the input containing all Verilog-1995 style ports. */ QString findVerilog1995PortsSectionInModule(QString const& input) const; /*! * Finds the section in the input containing all Verilog-2001 style ports. * - * @param [in] input The input to search for. + * @param [in] input The input to search for. * - * @return The section of the input containing all Verilog-2001 style ports. + * @return The section of the input containing all Verilog-2001 style ports. */ QString findVerilog2001PortsSection(QString const& input) const; /*! * Removes all ignored lines e.g. comments from a given input. * - * @param [in] input The input to remove lines from. + * @param [in] input The input to remove lines from. * - * @return The input without ignored lines. + * @return The input without ignored lines. */ QString removeIgnoredLines(QString const& portSection) const ; /*! * Finds all port declarations from a ports section without comment lines. * - * @param [in] portSectionWithoutCommentLines The section of the Verilog containing the ports in module + * @param [in] portSectionWithoutCommentLines The section of the Verilog containing the ports in module * without comment lines. * - * @return The Verilog port declarations. + * @return The Verilog port declarations. */ QStringList portDeclarationsIn(QString const& portSection) const; /*! * Creates a port from a given Verilog declaration and adds it to the target component. * - * @param [in] declaration The declaration from which to create a port. - * @param [in] targetComponent The component to which add the port. + * @param [in] declaration The declaration from which to create a port. + * @param [in] targetComponent The component to which add the port. */ void createPortFromDeclaration(QString const& portDeclaration, QSharedPointer targetComponent, @@ -151,27 +151,27 @@ class VerilogPortParser: public HighlightSource /*! * Highlights the given port declaration. * - * @param [in] portDeclaration The port declaration to highlight. - * @param [in] componentDeclaration Component declaration containing the selected port. + * @param [in] portDeclaration The port declaration to highlight. + * @param [in] componentDeclaration Component declaration containing the selected port. */ void highlight(QString const& portDeclaration, QString const& componentDeclaration); /*! * Parses the port direction from a Verilog port declaration. * - * @param [in] declaration The Verilog port declaration to parse. + * @param [in] declaration The Verilog port declaration to parse. * - * @return The port direction in the declaration. + * @return The port direction in the declaration. */ DirectionTypes::Direction parseDirection(QString const& portDeclaration) const; /*! * Parses the port array bounds from a Verilog port declaration. * - * @param [in] portDeclaration The Verilog port declaration to parse. - * @param [in] ownerComponent The owner component of the port. + * @param [in] portDeclaration The Verilog port declaration to parse. + * @param [in] ownerComponent The owner component of the port. * - * @return The port left and right array bound value in the declaration. + * @return The port left and right array bound value in the declaration. */ QPair parseArrayBounds(QString const& portDeclaration, QSharedPointer targetComponent) const; @@ -180,10 +180,10 @@ class VerilogPortParser: public HighlightSource * Parses the left and right bounds of a bounds that is of format [left:right]. * Any name references will be replaced with id references. * - * @param [in] bounds The expression to parse. - * @param [in] targetComponent The owner component of the port. + * @param [in] bounds The expression to parse. + * @param [in] targetComponent The owner component of the port. * - * @return The left and right bound value in the bounds. + * @return The left and right bound value in the bounds. */ QPair parseLeftAndRight(QString const& bounds, QSharedPointer targetComponent) const; @@ -191,10 +191,10 @@ class VerilogPortParser: public HighlightSource /*! * Parses the port vector bounds from a Verilog port declaration. * - * @param [in] portDeclaration The Verilog port declaration to parse. - * @param [in] ownerComponent The owner component of the port. + * @param [in] portDeclaration The Verilog port declaration to parse. + * @param [in] ownerComponent The owner component of the port. * - * @return The port left and right vector bound value in the declaration. + * @return The port left and right vector bound value in the declaration. */ QPair parseVectorBounds(QString const& portDeclaration, QSharedPointer targetComponent) const; @@ -202,10 +202,10 @@ class VerilogPortParser: public HighlightSource /*! * Replaces any parameter names with their ids in an expression. * - * @param [in] expression The expression to replace the names in. - * @param [in] targetComponent The containing component of the parameters. + * @param [in] expression The expression to replace the names in. + * @param [in] targetComponent The containing component of the parameters. * - * @return The expression where the names have been replaced with corresponding ids. + * @return The expression where the names have been replaced with corresponding ids. */ QString replaceNameReferencesWithIds(QString const& expression, QSharedPointer targetComponent) const; @@ -213,18 +213,18 @@ class VerilogPortParser: public HighlightSource /*! * Parses the port names from a Verilog port declaration. * - * @param [in] declaration The Verilog port declaration to parse. + * @param [in] declaration The Verilog port declaration to parse. * - * @return The port names in the declaration. + * @return The port names in the declaration. */ QStringList parsePortNames(QString const& portDeclaration) const; /*! * Parses the port description from a comment tailing a Verilog port declaration. * - * @param [in] declaration The Verilog port declaration to parse. + * @param [in] declaration The Verilog port declaration to parse. * - * @return The port description. + * @return The port description. */ QString parseDescription(QString const& portDeclaration) const; diff --git a/Plugins/VerilogImport/VerilogSyntax.h b/Plugins/VerilogImport/VerilogSyntax.h index 8ef6f5881..4e5713bc1 100644 --- a/Plugins/VerilogImport/VerilogSyntax.h +++ b/Plugins/VerilogImport/VerilogSyntax.h @@ -94,30 +94,30 @@ namespace VerilogSyntax /*! * Culls multi line comments and stray single line comments out of the input text. * - * @param [in] inspect The input text to parse. + * @param [in] inspect The input text to parse. * - * @return The input without comments. + * @return The input without comments. */ QString cullStrayComments(QString const& input); /*! * Finds the position and length of the first Verilog module declaration in the input. * - * @param [in] input The input text to parse. + * @param [in] input The input text to parse. * - * @return The position and length of the module declaration. + * @return The position and length of the module declaration. */ QPair findModuleDeclaration(QString const& input); /*! * Finds the module implementation in Verilog code. * - * @param [in] code The code that will be inspected. - * @param [out] implementation The module implementation. - * @param [out] postModule Anything that exists after the module. - * @param [out] error If fails, this will contain an error message. + * @param [in] code The code that will be inspected. + * @param [out] implementation The module implementation. + * @param [out] postModule Anything that exists after the module. + * @param [out] error If fails, this will contain an error message. * - * @return True, if a single implementation could be found, else false. + * @return True, if a single implementation could be found, else false. */ bool selectImplementation(QString const& fileContent, QString& implementation, QString& postModule, QString& error); @@ -125,12 +125,12 @@ namespace VerilogSyntax /*! * Finds position of the module implementation in Verilog code. * - * @param [in] code The code that will be inspected. - * @param [out] implementationStart The position where the implementation begins, if successful. - * @param [out] implementationEnd The position where the implementation ends, if successful. - * @param [out] error If fails, this will contain an error message. + * @param [in] code The code that will be inspected. + * @param [out] implementationStart The position where the implementation begins, if successful. + * @param [out] implementationEnd The position where the implementation ends, if successful. + * @param [out] error If fails, this will contain an error message. * - * @return True, if a single implementation could be found, else false. + * @return True, if a single implementation could be found, else false. */ bool findImplementation(QString const& code, int& implementationStart, int& implementationEnd, QString& error); } diff --git a/Plugins/VerilogIncludeImport/VerilogIncludeImport.h b/Plugins/VerilogIncludeImport/VerilogIncludeImport.h index 0d1f556f0..5d1eccf34 100644 --- a/Plugins/VerilogIncludeImport/VerilogIncludeImport.h +++ b/Plugins/VerilogIncludeImport/VerilogIncludeImport.h @@ -92,41 +92,41 @@ class VERILOGINCLUDEIMPORT_EXPORT VerilogIncludeImport : public QObject, public /*! * Returns the supported import file types. * - * @return The file types the import plugin supports. + * @return The file types the import plugin supports. */ virtual QStringList getSupportedFileTypes() const; /*! * Gets any compatibility warnings for the plugin. * - * @return The warning text. + * @return The warning text. */ virtual QString getCompatibilityWarnings() const; /*! * Get component declarations from the selected input file. * - * @param [in] input The selected input file. + * @param [in] input The selected input file. * - * @return List of component declarations found in the selected input. + * @return List of component declarations found in the selected input. */ virtual QStringList getFileComponents(QString const& input) const override final; /*! * Get the name of the selected component declaration. * - * @param [in] componentDeclaration The selected component declaration. + * @param [in] componentDeclaration The selected component declaration. * - * @return Name of the selected component declaration. + * @return Name of the selected component declaration. */ virtual QString getComponentName(QString const& componentDeclaration) const override final; /*! * Parses the given input and creates parameters from Verilog defines. * - * @param [in] input The input text to parse. - * @param [in] componentDeclaration Declaration of the selected component. - * @param [in] targetComponent The component to apply all imported changes to. + * @param [in] input The input text to parse. + * @param [in] componentDeclaration Declaration of the selected component. + * @param [in] targetComponent The component to apply all imported changes to. */ virtual void import(QString const& input, QString const& componentDeclaration, QSharedPointer targetComponent) override final; @@ -134,7 +134,7 @@ class VERILOGINCLUDEIMPORT_EXPORT VerilogIncludeImport : public QObject, public /*! * Sets the given highlighter to be used by the plugin. * - * @param [in] highlighter The highlighter to use. + * @param [in] highlighter The highlighter to use. */ virtual void setHighlighter(Highlighter* highlighter); @@ -147,7 +147,7 @@ class VERILOGINCLUDEIMPORT_EXPORT VerilogIncludeImport : public QObject, public /*! * Highlights the given definition. * - * @param [in] definition The definition to highlight. + * @param [in] definition The definition to highlight. */ void highlightDefinition(QString const& definition); @@ -155,18 +155,18 @@ class VERILOGINCLUDEIMPORT_EXPORT VerilogIncludeImport : public QObject, public * Creates a parameter from the given definition and adds it to the component. * Existing parameter with the same name will be updated and no new parameter is added. * - * @param [in] definition The definition to create the parameter from. - * @param [in] targetComponent The component to add the parameter to. + * @param [in] definition The definition to create the parameter from. + * @param [in] targetComponent The component to add the parameter to. */ void createParameterFromDefinition(QString const& definition, QSharedPointer targetComponent); /*! * Finds a parameter in the given component by the given name. * - * @param [in] targetComponent The component the search in. - * @param [in] name The name of the model parameter to find. + * @param [in] targetComponent The component the search in. + * @param [in] name The name of the model parameter to find. * - * @return The parameter with the given name or null if no parameter matches the name. + * @return The parameter with the given name or null if no parameter matches the name. */ QSharedPointer findParameterByName(QSharedPointer targetComponent, QString const& name) const; @@ -174,17 +174,17 @@ class VERILOGINCLUDEIMPORT_EXPORT VerilogIncludeImport : public QObject, public /*! * Parse the included verilog parameters. * - * @param [in] input The input text to parse. - * @param [in] targetComponent The component to add the parameter to. + * @param [in] input The input text to parse. + * @param [in] targetComponent The component to add the parameter to. */ void parseParameters(QString const& input, QSharedPointer targetComponent); /*! * Get the areas from the input text that do not contain verilog modules. * - * @param [in] input The selected input. + * @param [in] input The selected input. * - * @return List of non module text areas. + * @return List of non module text areas. */ QStringList getNonModuleAreas(QString const& input) const; diff --git a/Plugins/VerilogSourceAnalyzer/VerilogSourceAnalyzer.h b/Plugins/VerilogSourceAnalyzer/VerilogSourceAnalyzer.h index 6cf297970..51b0c8482 100644 --- a/Plugins/VerilogSourceAnalyzer/VerilogSourceAnalyzer.h +++ b/Plugins/VerilogSourceAnalyzer/VerilogSourceAnalyzer.h @@ -96,9 +96,9 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Calculates a language-dependent hash for the given file. * - * @param [in] filename The name of the file. + * @param [in] filename The name of the file. * - * @return The hash value for the file. + * @return The hash value for the file. * * @remarks Comments and whitespace are ignored and do not affect the hash value. */ @@ -107,8 +107,8 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Begins the analysis for the given component. * - * @param [in] component The component. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any preparations needed for the file dependency analysis should be made here. */ @@ -117,8 +117,8 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Ends the analysis for the given component. * - * @param [in] component The component. - * @param [in] componentPath The path to the directory where the component is located. + * @param [in] component The component. + * @param [in] componentPath The path to the directory where the component is located. * * @remarks Any cleanups needed should be made here. */ @@ -127,11 +127,11 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Retrieves all file dependencies the given file has. * - * @param [in] component The component to which the dependency scan is being run. - * @param [in] componentPath The path to the directory where the component is located. - * @param [in] filename The name of the file to which the analysis is run. + * @param [in] component The component to which the dependency scan is being run. + * @param [in] componentPath The path to the directory where the component is located. + * @param [in] filename The name of the file to which the analysis is run. * - * @return The list of found dependencies. + * @return The list of found dependencies. */ virtual QList getFileDependencies(Component const* component, QString const& componentPath, QString const& filename); @@ -141,59 +141,59 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Reads the given file and removes comments and extra whitespace in it. * - * @param [in] filePath The file to read. + * @param [in] filePath The file to read. * - * @return The file content without comments and extra whitespace. + * @return The file content without comments and extra whitespace. */ QString readFileContentAndRemoveComments(QString const& filePath) const; /*! * Finds the absolute path for a given file. * - * @param [in] filename The file whose absolute path to find. - * @param [in] componentPath The path to the containing component xml file. + * @param [in] filename The file whose absolute path to find. + * @param [in] componentPath The path to the containing component xml file. * - * @return Absolute path to filename. + * @return Absolute path to filename. */ QString findAbsolutePathFor(QString const& filename, QString const& componentPath) const; /*! * Finds the items (modules, include files) already available in the file sets. * - * @param [in] component The component whose file sets to search. - * @param [in] componentPath The path to the component xml file. + * @param [in] component The component whose file sets to search. + * @param [in] componentPath The path to the component xml file. * - * @return Found items in filesets where key is the item identifier and value the path to the file. + * @return Found items in filesets where key is the item identifier and value the path to the file. */ QMap findItemsInFilesets(Component const* component, QString const& componentPath); /*! * Finds the items (modules, include files) already available in the file content. * - * @param [in] content The file content. - * @param [in] filePath The path to the given file. + * @param [in] content The file content. + * @param [in] filePath The path to the given file. * - * @return Found items in file content where key is the item identifier and value the path to the file. + * @return Found items in file content where key is the item identifier and value the path to the file. */ QMap findItemsInFileContent(QString const& content, QString const& filePath); /*! * Check if the given file is of supported file type. * - * @param [in] file The file to check. + * @param [in] file The file to check. * - * @return True, if the file is of supported type, otherwise false. + * @return True, if the file is of supported type, otherwise false. */ bool isOfSupportedFileType(QSharedPointer file); /*! * Finds the dependencies of a file from include directives. * - * @param [in] fileContent The file content to analyze. - * @param [in] sourceFileInfo The source file (being analyzed) information. - * @param [in] itemsInFilesets The available items in file sets. + * @param [in] fileContent The file content to analyze. + * @param [in] sourceFileInfo The source file (being analyzed) information. + * @param [in] itemsInFilesets The available items in file sets. * - * @return The file dependencies for includes. + * @return The file dependencies for includes. */ QList findIncludeDependencies(QString const& fileContent, QFileInfo const& sourceFileInfo, @@ -202,21 +202,21 @@ class VERILOGSOURCEANALYZER_EXPORT VerilogSourceAnalyzer : public QObject, publi /*! * Finds the dependencies of a file with given pattern. * - * @param [in] fileContent The file content to analyze. - * @param [in] matchPattern The pattern for matching dependent items. + * @param [in] fileContent The file content to analyze. + * @param [in] matchPattern The pattern for matching dependent items. * - * @return The identifiers for items found with the given pattern. + * @return The identifiers for items found with the given pattern. */ QStringList findDependencies(QString const& fileContent, QRegularExpression const& matchPattern) const; /*! * Finds the dependencies of a file from module instantiations. * - * @param [in] fileContent The file content to analyze. - * @param [in] sourceFileInfo The source file (being analyzed) information. - * @param [in] itemsInFilesets The available items in file sets. + * @param [in] fileContent The file content to analyze. + * @param [in] sourceFileInfo The source file (being analyzed) information. + * @param [in] itemsInFilesets The available items in file sets. * - * @return The file dependencies for instantiations. + * @return The file dependencies for instantiations. */ QList findInstantiationDependencies(QString const& fileContent, QFileInfo const& sourceFileInfo, diff --git a/Plugins/common/CPUDialog/CPUEditor.h b/Plugins/common/CPUDialog/CPUEditor.h index 3b3ef9ad3..7322bb4fc 100644 --- a/Plugins/common/CPUDialog/CPUEditor.h +++ b/Plugins/common/CPUDialog/CPUEditor.h @@ -34,7 +34,7 @@ class CPUEditor : public QWidget /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ CPUEditor(QWidget *parent = 0); @@ -46,16 +46,16 @@ class CPUEditor : public QWidget /*! * Setup the selected CPUs. * - * @param [in] library Interface for accessing the library. - * @param [in] component Top component of the selected design. - * @param [in] activeView Active view of the design. + * @param [in] library Interface for accessing the library. + * @param [in] component Top component of the selected design. + * @param [in] activeView Active view of the design. */ virtual void setupCPUDetails(LibraryInterface* library, QSharedPointer component, QString const& activeView) = 0; /*! * Get the selected CPUs. * - * @return List of the selected CPUs. + * @return List of the selected CPUs. */ virtual QVector > getSelectedCPUs() const = 0; @@ -68,7 +68,7 @@ public slots: /*! * Setup the folder path. * - * @param [in] newFolderPath The new folder path. + * @param [in] newFolderPath The new folder path. */ virtual void setupFolderPath(QString const& newFolderPath); @@ -77,7 +77,7 @@ public slots: /*! * Inform of a change in the destination folder path. * - * @param [in] newPath The new folder path. + * @param [in] newPath The new folder path. */ void changeInSelectedPath(QString const& newPath); diff --git a/Plugins/common/CPUDialog/CPUSelectionDialog.h b/Plugins/common/CPUDialog/CPUSelectionDialog.h index fd4ff6a61..881f28bc3 100644 --- a/Plugins/common/CPUDialog/CPUSelectionDialog.h +++ b/Plugins/common/CPUDialog/CPUSelectionDialog.h @@ -46,19 +46,19 @@ class CPUSelectionDialog : public QDialog /*! * The constructor. * - * @param [in] topComponent Top component of the selected design. - * @param [in] library Interface for accessing the library. - * @param [in] viewsNames Names of the available views. - * @param [in] fileSetNames Names of the available file sets. - * @param [in] cpuEditor Editor for CPU details. - * @param [in] dialogType The type text for dialog. - * @param [in] extraEditor An extra editor. - * @param [in] parent Parent widget. - * @param [in] minimumWidth The minimum width of the dialog. - * @param [in] configurationFolder Folder path for the generator. - * @param [in] saveToFileSet Flag for save to file set. - * @param [in] configurationFileSet Name of the target file set. - * @param [in] configurationView Name of the view to use in the generator. + * @param [in] topComponent Top component of the selected design. + * @param [in] library Interface for accessing the library. + * @param [in] viewsNames Names of the available views. + * @param [in] fileSetNames Names of the available file sets. + * @param [in] cpuEditor Editor for CPU details. + * @param [in] dialogType The type text for dialog. + * @param [in] extraEditor An extra editor. + * @param [in] parent Parent widget. + * @param [in] minimumWidth The minimum width of the dialog. + * @param [in] configurationFolder Folder path for the generator. + * @param [in] saveToFileSet Flag for save to file set. + * @param [in] configurationFileSet Name of the target file set. + * @param [in] configurationView Name of the view to use in the generator. */ CPUSelectionDialog(QSharedPointer topComponent, LibraryInterface* library, @@ -82,35 +82,35 @@ class CPUSelectionDialog : public QDialog /*! * Get the list of the selected CPUs. * - * @return List of the CPU data and their connected paths. + * @return List of the CPU data and their connected paths. */ QVector > getSelectedCPUs(); /*! * Check if the files should be saved to a file set. * - * @return True, if the files should be saved to a file set, false otherwise. + * @return True, if the files should be saved to a file set, false otherwise. */ bool saveToFileSet() const; /*! * Get the name of the file set to save the files to. * - * @return Name of the target file set. + * @return Name of the target file set. */ QString getTargetFileSet() const; /*! * Get the target folder for the SVD files. * - * @return Path to the target folder of the selected SVD files. + * @return Path to the target folder of the selected SVD files. */ QString getTargetFolder() const; /*! * Get the active view. * - * @return Name of the active view. + * @return Name of the active view. */ QString getView() const; @@ -131,7 +131,7 @@ private slots: /*! * Signal informing of a change in the destination path. * - * @param [in] newFolderLocation The new destination. + * @param [in] newFolderLocation The new destination. */ void changeInSelectedPath(QString const& newFolderLocation); @@ -144,10 +144,10 @@ private slots: /*! * Setup the dialog. * - * @param [in] configurationFolder Folder path for the generated files. - * @param [in] saveToFileSet Flag for saving to a file set. - * @param [in] configurationFileSet Name of the selected file set. - * @param [in] configurationView The currently active view. + * @param [in] configurationFolder Folder path for the generated files. + * @param [in] saveToFileSet Flag for saving to a file set. + * @param [in] configurationFileSet Name of the selected file set. + * @param [in] configurationView The currently active view. */ void setupConfiguration(QString const& configurationFolder, bool saveToFileSet, QString const& configurationFileSet, QString const& configurationView); diff --git a/Plugins/common/CSourceWriter.h b/Plugins/common/CSourceWriter.h index efacea82c..bd7570726 100644 --- a/Plugins/common/CSourceWriter.h +++ b/Plugins/common/CSourceWriter.h @@ -24,8 +24,8 @@ class CSourceWriter /*! * Constructor. * - * @param [in] filename The name of the destination file. - * @param [in] indentString The indentation string. + * @param [in] filename The name of the destination file. + * @param [in] indentString The indentation string. */ explicit CSourceWriter(QString const& filename, QString const& indentString); @@ -37,7 +37,7 @@ class CSourceWriter /*! * Opens the file for writing. * - * @return False if errors. Otherwise true. + * @return False if errors. Otherwise true. */ bool open(); @@ -59,7 +59,7 @@ class CSourceWriter /*! * Writes a line to the source file. Newline is automatically written after the line. * - * @param [in] line The line to write. + * @param [in] line The line to write. */ void writeLine(QString const& line); @@ -71,8 +71,8 @@ class CSourceWriter /*! * Writes a #include to the source file. * - * @param [in] headerName The name of the header file. - * @param [in] local If true, the header is included with "" instead of <>. + * @param [in] headerName The name of the header file. + * @param [in] local If true, the header is included with "" instead of <>. */ void writeInclude(QString const& headerName, bool local = false); @@ -94,14 +94,14 @@ class CSourceWriter /*! * Ends a structure type definition. * - * @param [in] name The name of the struct. + * @param [in] name The name of the struct. */ void endStruct(QString const& name); /*! * Writes a header block comment. * - * @param [in] desc The descriptive text. + * @param [in] desc The descriptive text. */ void writeHeaderComment(QString const& desc); diff --git a/Plugins/common/ConfigurationManager.h b/Plugins/common/ConfigurationManager.h index 09e05b038..7428cabf0 100644 --- a/Plugins/common/ConfigurationManager.h +++ b/Plugins/common/ConfigurationManager.h @@ -33,7 +33,7 @@ class ConfigurationManager /*! * The constructor. * - * @param [in] library Interface for accessing the library. + * @param [in] library Interface for accessing the library. */ ConfigurationManager(LibraryInterface* library); @@ -45,10 +45,10 @@ class ConfigurationManager /*! * Get the configuration document. * - * @param [in] component The containing component. - * @param [in] fileTypeName Type of the configuration file. + * @param [in] component The containing component. + * @param [in] fileTypeName Type of the configuration file. * - * @return The configuration document. + * @return The configuration document. */ QJsonDocument getConfigurationDocument(QSharedPointer component, QString const& fileTypeName); @@ -57,34 +57,34 @@ class ConfigurationManager /*! * Get the path to the selected configuration file. * - * @param [in] component The top component. - * @param [in] fileExtension File extension for the selected file. + * @param [in] component The top component. + * @param [in] fileExtension File extension for the selected file. * - * @return The path to the selected configuration file. + * @return The path to the selected configuration file. */ QString getPathToConfigurationFile(QSharedPointer component, QString const& fileExtension); /*! * Get an existing configuration file, or create a new one if one is not found. * - * @param [in] containingComponent Component containing the selected configuration file. - * @param [in] fileTypeName Type name for the configuration file. + * @param [in] containingComponent Component containing the selected configuration file. + * @param [in] fileTypeName Type name for the configuration file. * - * @return The selected configuration file. + * @return The selected configuration file. */ QSharedPointer getOrCreateConfigurationFile(QSharedPointer containingComponent, QString const& fileTypeName); /*! * Get the interface for accessing the library. * - * @return Interface for accessing the library. + * @return Interface for accessing the library. */ LibraryInterface* getLibrary() const; /*! * Write the selected component to the file system. * - * @param [in] component The selected component. + * @param [in] component The selected component. */ void writeModelToFile(QSharedPointer component); @@ -93,35 +93,35 @@ class ConfigurationManager /*! * Print the selected error. * - * @param [in] errorMessage The selected error message. + * @param [in] errorMessage The selected error message. */ virtual void printError(QString const& errorMessage) const = 0; /*! * Get an existing configuration file set, or create a new one if one is not found. * - * @param [in] containingComponent Component containing the configuration file set. + * @param [in] containingComponent Component containing the configuration file set. * - * @return The configuration file set. + * @return The configuration file set. */ QSharedPointer getOrCreateConfigurationFileSet(QSharedPointer containingComponent); /*! * Get the file set for configurations. * - * @param [in] topComponent Top level component. + * @param [in] topComponent Top level component. * - * @return File set for configurations. + * @return File set for configurations. */ QSharedPointer getConfigurationFileSet(QSharedPointer targetComponent); /*! * Get the configuration file for the selected file type.. * - * @param [in] configurationFileSet File set for configurations. - * @param [in] fileType The selected file type. + * @param [in] configurationFileSet File set for configurations. + * @param [in] fileType The selected file type. * - * @return Configuration file for the selected file type. + * @return Configuration file for the selected file type. */ QSharedPointer getConfigurationFile(QSharedPointer configurationFileSet, QString const& fileType); diff --git a/Plugins/common/ConnectivityGraphUtilities.h b/Plugins/common/ConnectivityGraphUtilities.h index bc9a662ed..1fd622c82 100644 --- a/Plugins/common/ConnectivityGraphUtilities.h +++ b/Plugins/common/ConnectivityGraphUtilities.h @@ -35,10 +35,10 @@ namespace ConnectivityGraphUtilities /*! * Get the component contained within the connectivity component. * - * @param [in] library Interface for accessing the library. - * @param [in] masterComponent The connectivity component. + * @param [in] library Interface for accessing the library. + * @param [in] masterComponent The connectivity component. * - * @return Component contained within the connectivity component. + * @return Component contained within the connectivity component. */ QSharedPointer getInterfacedComponent(LibraryInterface* library, QSharedPointer masterComponent); @@ -46,11 +46,11 @@ namespace ConnectivityGraphUtilities /*! * Get the CPUs of the selected component. * - * @param [in] library The library interface containing the selected component. - * @param [in] component The selected component. - * @param [in] viewName Name of the selected view. + * @param [in] library The library interface containing the selected component. + * @param [in] component The selected component. + * @param [in] viewName Name of the selected view. * - * @return List of the component CPU routes. + * @return List of the component CPU routes. */ QVector > getDefaultCPUs(LibraryInterface* library, QSharedPointer component, QString const& viewName); }; diff --git a/Plugins/common/CpuRoutesContainer.h b/Plugins/common/CpuRoutesContainer.h index 1ae010fc2..2b42048d0 100644 --- a/Plugins/common/CpuRoutesContainer.h +++ b/Plugins/common/CpuRoutesContainer.h @@ -59,63 +59,63 @@ class CpuRoutesContainer /*! * Get the name. * - * @return Name of the CPU. + * @return Name of the CPU. */ QString getFileName() const; /*! * Set a new name. * - * @param [in] newName The new name for the CPU. + * @param [in] newName The new name for the CPU. */ void setFileName(QString const& newName); /*! * Get the ID. * - * @return ID of the CPU. + * @return ID of the CPU. */ QString getFileID() const; /*! * Set a new ID. * - * @param [in] newID The new ID. + * @param [in] newID The new ID. */ void setFileID(QString const& newID); /*! * Flag for creating a file from this CPU. * - * @return True, if a file should be created, false otherwise. + * @return True, if a file should be created, false otherwise. */ bool shouldCreateFile() const; /*! * Set the flag fro creating a file from this CPU. * - * @param [in] newFlag The new flag. + * @param [in] newFlag The new flag. */ void setCreateFileFlag(bool newFlag); /*! * Get a list of the interface routes connected to this CPU. * - * @return List of interface routes connected to this CPU. + * @return List of interface routes connected to this CPU. */ QVector > getRoutes() const; /*! * Set new interface routes. * - * @param [in] newRoutes The selected interface routes. + * @param [in] newRoutes The selected interface routes. */ virtual void setRoutes(QVector > newRoutes); /*! * Add a new CPU route. * - * @param [in] newRoute The selected interface route. + * @param [in] newRoute The selected interface route. */ virtual void addRoute(QSharedPointer newRoute); diff --git a/Plugins/common/HDLParser/HDLCommandLineParser.h b/Plugins/common/HDLParser/HDLCommandLineParser.h index 3de858c9c..5fe3edc68 100644 --- a/Plugins/common/HDLParser/HDLCommandLineParser.h +++ b/Plugins/common/HDLParser/HDLCommandLineParser.h @@ -26,9 +26,9 @@ class HDLCommandLineParser : public QCommandLineParser /*! * The constructor. * - * @param [in] command The command used to run the generator for the parser. + * @param [in] command The command used to run the generator for the parser. * - * @return . + * @return . */ HDLCommandLineParser(QString const& command); @@ -49,9 +49,9 @@ class HDLCommandLineParser : public QCommandLineParser /*! * Parse the given arguments. * - * @param [in] arguments The arguments to parse. + * @param [in] arguments The arguments to parse. * - * @return Collection of parse results. + * @return Collection of parse results. */ ParseResults parseArguments(QStringList const& arguments); diff --git a/Plugins/common/HDLParser/MetaComponent.h b/Plugins/common/HDLParser/MetaComponent.h index 26e97f9ca..a79f1508d 100755 --- a/Plugins/common/HDLParser/MetaComponent.h +++ b/Plugins/common/HDLParser/MetaComponent.h @@ -31,9 +31,9 @@ class MetaComponent /*! * The constructor. * - * @param [in] messages For message output. - * @param [in] component The instantiated component. - * @param [in] activeView The active view for the component. + * @param [in] messages For message output. + * @param [in] component The instantiated component. + * @param [in] activeView The active view for the component. */ MetaComponent(MessageMediator* messages, QSharedPointer component, QSharedPointer activeView); @@ -102,7 +102,7 @@ class MetaComponent /*! * Sorts list of parameters based on their interdependencies. * - * @param [out] parameters The list containing the parameters that will be sorted. + * @param [out] parameters The list containing the parameters that will be sorted. */ static void sortParameters(QSharedPointer > > parameters); diff --git a/Plugins/common/HDLParser/MetaDesign.h b/Plugins/common/HDLParser/MetaDesign.h index e09d00fe7..6dce0f646 100644 --- a/Plugins/common/HDLParser/MetaDesign.h +++ b/Plugins/common/HDLParser/MetaDesign.h @@ -30,11 +30,11 @@ class MetaDesign /*! * The constructor. * - * @param [in] library The library which is expected to contain the parsed documents. - * @param [in] messages For message output. - * @param [in] design The design to parse. - * @param [in] designConf The design configuration to parse. - * @param [in] topInstance The parsed meta instance of the top component. + * @param [in] library The library which is expected to contain the parsed documents. + * @param [in] messages For message output. + * @param [in] design The design to parse. + * @param [in] designConf The design configuration to parse. + * @param [in] topInstance The parsed meta instance of the top component. */ MetaDesign(LibraryInterface* library, MessageMediator* messages, @@ -53,9 +53,9 @@ class MetaDesign /*! * Parses a hierarchy of designs and return the list of them. * - * @param [in] library The library which is expected to contain the parsed documents. - * @param [in] input The starting point for hierarchy parsing. - * @param [in] topComponentView The active view of the component in input. + * @param [in] library The library which is expected to contain the parsed documents. + * @param [in] input The starting point for hierarchy parsing. + * @param [in] topComponentView The active view of the component in input. */ static QList > parseHierarchy(LibraryInterface* library, GenerationTuple input, @@ -101,9 +101,9 @@ class MetaDesign /*! * Parses parameters within a list. * - * @param [inout] subList The list which parameters are parsed. - * @param [in] input The list of parameters which may affect the parsing result. May be null. - * @param [in] topComponentView The list of overrides for the parsed parameters. May be null. + * @param [inout] subList The list which parameters are parsed. + * @param [in] input The list of parameters which may affect the parsing result. May be null. + * @param [in] topComponentView The list of overrides for the parsed parameters. May be null. */ static void parseParameters( QSharedPointer > > subList, @@ -123,9 +123,9 @@ class MetaDesign /*! * Assigns ports of mInterface with the wires of mInterconnect. * - * @param [in] mInterface The interface which will have the ports. - * @param [in] mIterconnect The interconnect which will have the wires. - * @param [in] isHierarchical True, if mInterface is in topInstance, else false. + * @param [in] mInterface The interface which will have the ports. + * @param [in] mIterconnect The interconnect which will have the wires. + * @param [in] isHierarchical True, if mInterface is in topInstance, else false. */ void wireInterfacePorts(QSharedPointer mInterface, QSharedPointer mIterconnect, bool isHierarchical); @@ -133,12 +133,12 @@ class MetaDesign /*! * Associate the selected meta port with wire. * - * @param [in] metaInterconnect Meta interconnection containing the wire. - * @param [in] portAbstraction Connected logical port. - * @param [in] assignment Meta assignment for the port. - * @param [in] connectedWires List of already connected meta wire. - * @param [in] isHierarchical Flag for hierarchical ports. - * @param [in] metaPort The selected meta port. + * @param [in] metaInterconnect Meta interconnection containing the wire. + * @param [in] portAbstraction Connected logical port. + * @param [in] assignment Meta assignment for the port. + * @param [in] connectedWires List of already connected meta wire. + * @param [in] isHierarchical Flag for hierarchical ports. + * @param [in] metaPort The selected meta port. */ void associateWithWire(QSharedPointer metaInterconnect, QSharedPointer portAbstraction, QSharedPointer assignment, @@ -147,12 +147,12 @@ class MetaDesign /*! * Associate the selected meta port with transactional. * - * @param [in] metaInterconnect Meta interconnection containing the wire. - * @param [in] portAbstraction Connected logical port. - * @param [in] assignment Meta assignment for the port. - * @param [in] connectedTransactionals List of already connected meta transactionals. - * @param [in] isHierarchical Flag for hierarchical ports. - * @param [in] metaPort The selected meta port. + * @param [in] metaInterconnect Meta interconnection containing the wire. + * @param [in] portAbstraction Connected logical port. + * @param [in] assignment Meta assignment for the port. + * @param [in] connectedTransactionals List of already connected meta transactionals. + * @param [in] isHierarchical Flag for hierarchical ports. + * @param [in] metaPort The selected meta port. */ void associateWithTransactional(QSharedPointer metaInterconnect, QSharedPointer portAbstraction, QSharedPointer assignment, @@ -167,12 +167,12 @@ class MetaDesign /*! * Parses a port assignment for an ad-hoc port. * - * @param [in] mPort The port which get an assignment. - * @param [in] connection The interconnect which is associated with IP-XACT port corresponding mPrt. - * @param [in] mWire Wire which will be referred by the assignment. - * @param [in] isHierarchical True, if this connection is hierarchical. - * @param [in] wireName Name of mWire. - * @param [in] matchingPartSelect The part select that affects the bounds of the assignment. + * @param [in] mPort The port which get an assignment. + * @param [in] connection The interconnect which is associated with IP-XACT port corresponding mPrt. + * @param [in] mWire Wire which will be referred by the assignment. + * @param [in] isHierarchical True, if this connection is hierarchical. + * @param [in] wireName Name of mWire. + * @param [in] matchingPartSelect The part select that affects the bounds of the assignment. */ void parseAdHocAssignmentForPort(QSharedPointer mPort, QSharedPointer connection, @@ -184,10 +184,10 @@ class MetaDesign /*! * Finds hierarchical ports within an ad-hoc interconnection. * - * @param [in] connection The interconnect which ports are beign searched. - * @param [out] foundPorts Every port found for the interconnection. - * @param [out] foundHierPorts Every hierarchical port found for the interconnection. - * @param [out] matchingPartSelects The part select that affects the bounds of the assignment. + * @param [in] connection The interconnect which ports are beign searched. + * @param [out] foundPorts Every port found for the interconnection. + * @param [out] foundHierPorts Every hierarchical port found for the interconnection. + * @param [out] matchingPartSelects The part select that affects the bounds of the assignment. */ void findHierarchicalPortsInAdHoc(QSharedPointer connection, QList > &foundPorts, @@ -197,9 +197,9 @@ class MetaDesign /*! * Finds ports within an ad-hoc interconnection. * - * @param [in] connection The interconnect which ports are beign searched. - * @param [out] foundPorts Every port found for the interconnection. - * @param [out] matchingPartSelects The part select that affects the bounds of the assignment. + * @param [in] connection The interconnect which ports are beign searched. + * @param [out] foundPorts Every port found for the interconnection. + * @param [out] matchingPartSelects The part select that affects the bounds of the assignment. */ void findPortsInAdHoc(QSharedPointer connection, QList > &foundPorts, @@ -222,7 +222,7 @@ class MetaDesign * Tries to find hierarchy from mInstance for the active view and then create a sub design. * If sub design is created, it shall be appended to the list of the sub designs. * - * @param [in] mInstance The instance, which component is expected to have needed instantiations. + * @param [in] mInstance The instance, which component is expected to have needed instantiations. * Consequently, will be the top instance of the created meta design. */ void findHierarchy(QSharedPointer mInstance); @@ -230,9 +230,9 @@ class MetaDesign /*! * Finds a design from a design instantiation. * - * @param [in] dis Where from the design is searched. + * @param [in] dis Where from the design is searched. * - * @return The found design, or null. + * @return The found design, or null. */ QSharedPointer findDesignFromInstantiation(QSharedPointer designInstantiation, QSharedPointer configurationInstantiation); @@ -240,9 +240,9 @@ class MetaDesign /*! * Finds a design and design configuration from a design instantiation. * - * @param [in] configurationInstantiation Where from the design configuration is searched. + * @param [in] configurationInstantiation Where from the design configuration is searched. * - * @return The found design configuration, or null. + * @return The found design configuration, or null. */ QSharedPointer findDesignConfigurationFromInsantiation( QSharedPointer configurationInstantiation); @@ -252,8 +252,8 @@ class MetaDesign * Compares new bounds to existing bounds of the wire and then assigns the largest combination of two * If even one of the existing bounds is missing, candidates will replace them both. * - * @param [in] wire The wire which bounds are possibly enlarged. - * @param [in] boundCand The candidate for new bounds. + * @param [in] wire The wire which bounds are possibly enlarged. + * @param [in] boundCand The candidate for new bounds. */ void assignLargerBounds(QSharedPointer wire, QPair const& boundCand); diff --git a/Plugins/common/HDLParser/MetaInstance.h b/Plugins/common/HDLParser/MetaInstance.h index ae7f1a8d5..63e41919d 100644 --- a/Plugins/common/HDLParser/MetaInstance.h +++ b/Plugins/common/HDLParser/MetaInstance.h @@ -31,11 +31,11 @@ class MetaInstance : public MetaComponent /*! * The constructor. * - * @param [in] componentInstance The instance under inspection. - * @param [in] library The library which is expected to contain the parsed documents. - * @param [in] messages For message output. - * @param [in] component The instantiated component. - * @param [in] activeView The active view for the component. May be null. + * @param [in] componentInstance The instance under inspection. + * @param [in] library The library which is expected to contain the parsed documents. + * @param [in] messages For message output. + * @param [in] component The instantiated component. + * @param [in] activeView The active view for the component. May be null. */ MetaInstance( QSharedPointer componentInstance, @@ -82,24 +82,24 @@ class MetaInstance : public MetaComponent /*! * Culls and parses the ports of the component. * - * @param [in] parser Used to parse expressions. + * @param [in] parser Used to parse expressions. */ void parsePorts(IPXactSystemVerilogParser const& parser); /*! * Creates assignments for port maps. * - * @param [in] parser Used to parse expressions. + * @param [in] parser Used to parse expressions. */ void parsePortAssignments(IPXactSystemVerilogParser const& parser); /*! * Finds the mapped logical port bounds for a port map. * - * @param [in] parser Used for parsing the bounds. - * @param [in] portMap The port map for the which to find the logical bounds. + * @param [in] parser Used for parsing the bounds. + * @param [in] portMap The port map for the which to find the logical bounds. * - * @return The logical port bounds for the port map in an instance. + * @return The logical port bounds for the port map in an instance. */ QPair logicalPortBoundsInMapping(IPXactSystemVerilogParser const& parser, QSharedPointer portMap) const; @@ -107,10 +107,10 @@ class MetaInstance : public MetaComponent /*! * Finds the mapped physical port bounds for a port map. * - * @param [in] parser Used for parsing the bounds. - * @param [in] portMap The port map for the which to find the physical bounds. + * @param [in] parser Used for parsing the bounds. + * @param [in] portMap The port map for the which to find the physical bounds. * - * @return The physical port bounds for the port map in an instance. + * @return The physical port bounds for the port map in an instance. */ QPair physicalPortBoundsInMapping(IPXactSystemVerilogParser const& parser, QSharedPointer portMap) const; diff --git a/Plugins/common/LanguageHighlighter.h b/Plugins/common/LanguageHighlighter.h index 7ff0f5398..a3d96b83a 100644 --- a/Plugins/common/LanguageHighlighter.h +++ b/Plugins/common/LanguageHighlighter.h @@ -52,16 +52,16 @@ class LanguageHighlighter : public QSyntaxHighlighter /*! * Gets the name for the given style type. * - * @param [in] type The type whose name to find. + * @param [in] type The type whose name to find. * - * @return The name for the type. + * @return The name for the type. */ static QString getStyleName(StyleType type); /*! * Constructor. * - * @param [in] parent The parent text document. + * @param [in] parent The parent text document. */ explicit LanguageHighlighter(QTextDocument* parent); @@ -73,8 +73,8 @@ class LanguageHighlighter : public QSyntaxHighlighter /*! * Sets the highlight style as a global style for all MCAPI highlighters. * - * @param [in] type The style to set. - * @param [in] styleDesc The style description. + * @param [in] type The style to set. + * @param [in] styleDesc The style description. * * @remarks The styles must be taken into use by calling applyStyles(). */ @@ -83,16 +83,16 @@ class LanguageHighlighter : public QSyntaxHighlighter /*! * Add a highlighting rule. * - * @param [in] pattern Pattern to highlight. - * @param [in] style Style to apply to pattern. + * @param [in] pattern Pattern to highlight. + * @param [in] style Style to apply to pattern. */ void addRule(QRegularExpression const& pattern, LanguageHighlighter::StyleType style); /*! * Add highlighting rule for multiline comments. Formatting style for the comment is set with addRule(). * - * @param [in] startPattern Pattern for start of multiline comment. - * @param [in] endPattern Pattern for end of multiline comment. + * @param [in] startPattern Pattern for start of multiline comment. + * @param [in] endPattern Pattern for end of multiline comment. */ void addMultilineCommentRule(QRegularExpression const& startPattern, QRegularExpression const& endPattern); diff --git a/Plugins/common/PluginConfigurationManager.h b/Plugins/common/PluginConfigurationManager.h index 7015b574c..7b5e2392a 100644 --- a/Plugins/common/PluginConfigurationManager.h +++ b/Plugins/common/PluginConfigurationManager.h @@ -39,7 +39,7 @@ class PluginConfigurationManager : public ConfigurationManager /*! * Print the selected error. * - * @param [in] errorMessage The selected error message. + * @param [in] errorMessage The selected error message. */ virtual void printError(QString const& errorMessage) const override final; diff --git a/Plugins/common/PortSorter/InterfaceDirectionNameSorter.h b/Plugins/common/PortSorter/InterfaceDirectionNameSorter.h index b6f3089ca..f016647a6 100644 --- a/Plugins/common/PortSorter/InterfaceDirectionNameSorter.h +++ b/Plugins/common/PortSorter/InterfaceDirectionNameSorter.h @@ -34,18 +34,18 @@ class InterfaceDirectionNameSorter : public PortSorter /*! * Gets the sorted port names of a component. * - * @param [in] component The component whose port names to find. + * @param [in] component The component whose port names to find. * - * @return The sorted port names of a given component. + * @return The sorted port names of a given component. */ virtual QStringList sortedPortNames(QSharedPointer component) const; /*! * Gets the sorted ports of a component. * - * @param [in] component The component whose ports to find. + * @param [in] component The component whose ports to find. * - * @return The sorted ports of a given component. + * @return The sorted ports of a given component. */ virtual QList > sortedPorts(QSharedPointer component) const; diff --git a/Plugins/common/PortSorter/PortSorter.h b/Plugins/common/PortSorter/PortSorter.h index 4ee122d9a..8c0365aa5 100644 --- a/Plugins/common/PortSorter/PortSorter.h +++ b/Plugins/common/PortSorter/PortSorter.h @@ -31,18 +31,18 @@ class PortSorter /*! * Gets the sorted port names of a component. * - * @param [in] component The component whose port names to find. + * @param [in] component The component whose port names to find. * - * @return The sorted port names of a given component. + * @return The sorted port names of a given component. */ virtual QStringList sortedPortNames(QSharedPointer component) const = 0; /*! * Gets the sorted ports of a component. * - * @param [in] component The component whose ports to find. + * @param [in] component The component whose ports to find. * - * @return The sorted ports of a given component. + * @return The sorted ports of a given component. */ virtual QList > sortedPorts(QSharedPointer component) const = 0; }; diff --git a/Plugins/common/SingleCpuRoutesContainer.h b/Plugins/common/SingleCpuRoutesContainer.h index 8b17c350d..e835ecf0b 100644 --- a/Plugins/common/SingleCpuRoutesContainer.h +++ b/Plugins/common/SingleCpuRoutesContainer.h @@ -25,7 +25,7 @@ class SingleCpuRoutesContainer : public CpuRoutesContainer /*! * The constructor. * - * @param [in] CPU The CPU. + * @param [in] CPU The CPU. */ SingleCpuRoutesContainer(QSharedPointer cpu); @@ -42,14 +42,14 @@ class SingleCpuRoutesContainer : public CpuRoutesContainer /*! * Get the containing CPU. * - * @return The containing CPU. + * @return The containing CPU. */ QSharedPointer getCpu() const; /*! * Set the containing CPU. * - * @param [in] newCpu The new CPU. + * @param [in] newCpu The new CPU. */ void setCpu(QSharedPointer newCpu); diff --git a/Plugins/common/SourceHighlightStyle.h b/Plugins/common/SourceHighlightStyle.h index 64428ce66..45746be26 100644 --- a/Plugins/common/SourceHighlightStyle.h +++ b/Plugins/common/SourceHighlightStyle.h @@ -34,7 +34,7 @@ class SourceHighlightStyle /*! * Apply the language style rules on the given highlighter. * - * @param [in] highlighter The highlighter to apply the highlight style rules to. + * @param [in] highlighter The highlighter to apply the highlight style rules to. */ void apply(LanguageHighlighter* highlighter) const; @@ -43,21 +43,21 @@ class SourceHighlightStyle /*! * Get the language specific keywords. * - * @return The language keywords. + * @return The language keywords. */ virtual QStringList keywords() const = 0; /*! * Get the language specific preprocessor directives. * - * @return The preprocessor directives. + * @return The preprocessor directives. */ virtual QStringList preprocessorDirectives() const = 0; /*! * Apply other language specific rules to highlighting. * - * @param [in] highlighter The highlighter to apply the rules to. + * @param [in] highlighter The highlighter to apply the rules to. */ virtual void applyLanguageSpecificRules(LanguageHighlighter* highlighter) const; diff --git a/PythonAPI/PythonAPI.h b/PythonAPI/PythonAPI.h index 325c00167..31278279c 100644 --- a/PythonAPI/PythonAPI.h +++ b/PythonAPI/PythonAPI.h @@ -79,7 +79,7 @@ class PythonAPI /*! * Get Kactus2 version. * - * @return The current Kactus2 version. + * @return The current Kactus2 version. */ std::string getVersion() const; @@ -88,84 +88,84 @@ class PythonAPI /*! * Get the interface for accessing the component ports. * - * @return Interface for accessing the component ports. + * @return Interface for accessing the component ports. */ PortsInterface* getPortsInterface() const; /*! * Get the interface for accessing the component parameters. * - * @return Interface for accessing the component parameters. + * @return Interface for accessing the component parameters. */ ParametersInterface* getComponentParameterInterface() const; /*! * Get the interface for accessing component memory maps. * - * @return Interface for accessing component memory maps. + * @return Interface for accessing component memory maps. */ MemoryMapInterface* getMapInterface(); /*! * Get the interface for accessing file sets. * - * @return Interface for accessing file sets. + * @return Interface for accessing file sets. */ FileSetInterface* getFileSetInterface(); /*! * Get the interface for accessing bus interfaces. * - * @return Interface for accessing bus interfaces. + * @return Interface for accessing bus interfaces. */ BusInterfaceInterface* getBusInterface(); /*! * Gets the paths where IP-XACT files are stored. * - * @return The paths where IP-XACT files are stored. + * @return The paths where IP-XACT files are stored. */ void setupLibrary(std::string const& settingsFileString); /*! * Set the paths where IP-XACT files are stored. * - * @param [in] paths The locations that are currently available to store the files. + * @param [in] paths The locations that are currently available to store the files. */ void setLibraryPaths(std::vector paths) const; /*! * Get the default library path for IP-XACT files. * - * @return The default path for IP-XACT files. + * @return The default path for IP-XACT files. */ std::string getDefaultLibraryPath() const; /*! * Set the default library path for IP-XACT files. * - * @param [in] path The default path to set for IP-XACT files. + * @param [in] path The default path to set for IP-XACT files. */ void setDefaultLibraryPath(std::string const& path) const; /*! * Import a source file (RTL) into the library as a component. * - * @param [in] filePath The path to the file to import. - * @param [in] targetVLNV The VLNV to use for the imported component. - * @param [in] overwrite Overwrite the component in the library, if it already exists. + * @param [in] filePath The path to the file to import. + * @param [in] targetVLNV The VLNV to use for the imported component. + * @param [in] overwrite Overwrite the component in the library, if it already exists. * - * @return The number of imported IP-XACT components. + * @return The number of imported IP-XACT components. */ int importFile(std::string const& path, std::string const& vlnv, bool overwrite = false) const; /*! * Run a file generation for a component. * - * @param [in] format The requested output format. - * @param [in] vlnv The component VLNV to run the generation for. - * @param [in] viewName The component view to run the generation for. - * @param [in] outputDirectory The output directory for the generation results. + * @param [in] format The requested output format. + * @param [in] vlnv The component VLNV to run the generation for. + * @param [in] viewName The component view to run the generation for. + * @param [in] outputDirectory The output directory for the generation results. */ void generate(std::string const& format, std::string const& vlnv, std::string const& viewName, std::string const& outputDirectory) const; @@ -173,16 +173,16 @@ class PythonAPI /*! * Get the number of files in the library. * - * @return The number of files in the library. + * @return The number of files in the library. */ int getFileCount() const; /*! * List all the VLNVs in the library. * - * @param[in] vendor The desired vendor. + * @param[in] vendor The desired vendor. * - * @return List of VLNVs in Vendor:Library:Name:Version format. + * @return List of VLNVs in Vendor:Library:Name:Version format. */ std::vector listVLNVs(std::string const& vendor = std::string()) const; @@ -190,19 +190,19 @@ class PythonAPI /*! * List all the component VLNVs in the library. * - * @return List of component VLNVs in Vendor:Library:Name:Version format. + * @return List of component VLNVs in Vendor:Library:Name:Version format. */ std::vector listComponentVLNVs() const; /*! * Check if the selected VLNV exists in the library. * - * @param [in] vendor Vendor of the selected VLNV. - * @param [in] library Library of the selected VLNV. - * @param [in] name Name of the selected VLNV. - * @param [in] version Version of the selected VLNV. + * @param [in] vendor Vendor of the selected VLNV. + * @param [in] library Library of the selected VLNV. + * @param [in] name Name of the selected VLNV. + * @param [in] version Version of the selected VLNV. * - * @return True, if the VLNV exists in the library, false otherwise. + * @return True, if the VLNV exists in the library, false otherwise. */ bool vlnvExistsInLibrary(std::string const& vendor, std::string const& library, std::string const& name, std::string const& version) const; @@ -210,12 +210,12 @@ class PythonAPI /*! * Create a new component with the selected VLNV. * - * @param [in] vendor Vendor of the selected VLNV. - * @param [in] library Library of the selected VLNV. - * @param [in] name Name of the selected VLNV. - * @param [in] version Version of the selected VLNV. + * @param [in] vendor Vendor of the selected VLNV. + * @param [in] library Library of the selected VLNV. + * @param [in] name Name of the selected VLNV. + * @param [in] version Version of the selected VLNV. * - * @return True, if the component was created successfully, false otherwise. + * @return True, if the component was created successfully, false otherwise. */ bool createComponent(std::string const& vendor, std::string const& library, std::string const& name, std::string const& version); @@ -223,12 +223,12 @@ class PythonAPI /*! * Get the directory path of the selected VLNV document. * - * @param [in] vendor Vendor of the selected VLNV. - * @param [in] library Library of the selected VLNV. - * @param [in] name Name of the selected VLNV. - * @param [in] version Version of the selected VLNV. + * @param [in] vendor Vendor of the selected VLNV. + * @param [in] library Library of the selected VLNV. + * @param [in] name Name of the selected VLNV. + * @param [in] version Version of the selected VLNV. * - * @return Path of the selected VLNV document. + * @return Path of the selected VLNV document. */ std::string getVLNVDirectory(std::string const& vendor, std::string const& library, std::string const& name, std::string const& version) const; @@ -236,16 +236,16 @@ class PythonAPI /*! * Get the name of the first view contained within the active component. * - * @return Name of the first view contained within the active component. + * @return Name of the first view contained within the active component. */ std::string getFirstViewName() const; /*! * Set the selected component as active component. * - * @param [in] componentVLNV VLNV of the selected component. + * @param [in] componentVLNV VLNV of the selected component. * - * @return True, if the component exists, false otherwise. + * @return True, if the component exists, false otherwise. */ bool openComponent(std::string const& vlnvString); @@ -275,24 +275,24 @@ class PythonAPI /*! * Set the available address blocks for the address block interface. * - * @param [in] mapName Name of the memory map containing the desired address blocks. + * @param [in] mapName Name of the memory map containing the desired address blocks. */ void setBlocksForInterface(std::string const& mapName); /*! * Set the available registers for the register interface. * - * @param [in] mapName Name of the memory map containing the desired address blocks. - * @param [in] blockName Name of the address block containing the desired registers. + * @param [in] mapName Name of the memory map containing the desired address blocks. + * @param [in] blockName Name of the address block containing the desired registers. */ void setRegistersForInterface(std::string const& mapName, std::string const& blockName); /*! * Set the available fields for the field interface. * - * @param [in] mapName Name of the memory map containing the desired address blocks. - * @param [in] blockName Name of the address block containing the desired registers. - * @param [in] registerName Name of the register containing the desired fields. + * @param [in] mapName Name of the memory map containing the desired address blocks. + * @param [in] blockName Name of the address block containing the desired registers. + * @param [in] registerName Name of the register containing the desired fields. */ void setFieldsForInterface(std::string const& mapName, std::string const& blockName, std::string const& registerName); @@ -300,10 +300,10 @@ class PythonAPI /*! * Set the available resets for the reset interface. * - * @param [in] mapName Name of the memory map containing the desired address blocks. - * @param [in] blockName Name of the address block containing the desired registers. - * @param [in] registerName Name of the register containing the desired fields. - * @param [in] fieldName Name of the field containing the desired resets. + * @param [in] mapName Name of the memory map containing the desired address blocks. + * @param [in] blockName Name of the address block containing the desired registers. + * @param [in] registerName Name of the register containing the desired fields. + * @param [in] fieldName Name of the field containing the desired resets. */ void setResetsForInterface(std::string const& mapName, std::string const& blockName, std::string const& registerName, std::string const& fieldName); @@ -311,26 +311,26 @@ class PythonAPI /*! * Set the available files for the file interface. * - * @param [in] setName Name of the file set containing the available files. + * @param [in] setName Name of the file set containing the available files. */ void setFilesForInterface(std::string const& setName); /*! * Set the available file builders for the file interface. * - * @param [in] setName Name of the file set containing the available file builders. + * @param [in] setName Name of the file set containing the available file builders. */ void setFileBuildersForInterface(std::string const& setName); /*! * Create a new design with the selected VLNV. * - * @param [in] vendor Vendor of the selected VLNV. - * @param [in] library Library of the selected VLNV. - * @param [in] name Name of the selected VLNV. - * @param [in] version Version of the selected VLNV. + * @param [in] vendor Vendor of the selected VLNV. + * @param [in] library Library of the selected VLNV. + * @param [in] name Name of the selected VLNV. + * @param [in] version Version of the selected VLNV. * - * @return True, if the design was created successfully, false otherwise. + * @return True, if the design was created successfully, false otherwise. */ bool createDesign(std::string const& vendor, std::string const& library, std::string const& name, std::string const& version); @@ -338,9 +338,9 @@ class PythonAPI /*! * Set the selected design as active design. * - * @param [in] vlnvString VLNV of the selected design. + * @param [in] vlnvString VLNV of the selected design. * - * @return True, if the design exists, false otherwise. + * @return True, if the design exists, false otherwise. */ bool openDesign(std::string const& vlnvString); @@ -357,59 +357,59 @@ class PythonAPI /*! * Add the selected component instance to the active design. * - * @param [in] vlnvString VLNV of the component within the selected component instance. - * @param [in] instanceName Name for the new component instance. + * @param [in] vlnvString VLNV of the component within the selected component instance. + * @param [in] instanceName Name for the new component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool addComponentInstance(std::string const& vlnvString, std::string const& instanceName); /*! * Remove the selected component instance from the active design. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeComponentInstance(std::string const& instanceName); /*! * Remove connections from the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeInstanceConnections(std::string const& instanceName); /*! * Remove ad hoc connections from the selected component instance. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeInstanceAdHocConnections(std::string const& instanceName); /*! * Set a new name for the selected component instance. * - * @param [in] currentName Name of the selected component instance. - * @param [in] newName New name for the component instance. + * @param [in] currentName Name of the selected component instance. + * @param [in] newName New name for the component instance. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool renameInstance(std::string const& currentName, std::string const& newName); /*! * Create an interconnection between two bus interfaces. * - * @param [in] startInstanceName Name of the component instance containing the first bus interface. - * @param [in] startBus Name of the first bus interface. - * @param [in] endInstanceName Name of the component instance containing the second bus interface. - * @param [in] endBus Name of the second bus interface. + * @param [in] startInstanceName Name of the component instance containing the first bus interface. + * @param [in] startBus Name of the first bus interface. + * @param [in] endInstanceName Name of the component instance containing the second bus interface. + * @param [in] endBus Name of the second bus interface. * - * @return True, if the connection was created, false otherwise. + * @return True, if the connection was created, false otherwise. */ bool createConnection(std::string const& startInstanceName, std::string const& startBus, std::string const& endInstanceName, std::string const& endBus); @@ -417,11 +417,11 @@ class PythonAPI /*! * Create a hierarchical interconnection between two bus interfaces. * - * @param [in] instanceName Name of the component instance containing the selected bus interface. - * @param [in] instanceBus Name of the component instance bus interface. - * @param [in] topBus Name of the top component bus interface. + * @param [in] instanceName Name of the component instance containing the selected bus interface. + * @param [in] instanceBus Name of the component instance bus interface. + * @param [in] topBus Name of the top component bus interface. * - * @return True, if the connection was created, false otherwise. + * @return True, if the connection was created, false otherwise. */ bool createHierarchicalConnection(std::string const& instanceName, std::string const& instanceBus, std::string const& topBus); @@ -429,12 +429,12 @@ class PythonAPI /*! * Remove an interconnection between two bus interfaces. * - * @param [in] startInstanceName Name of the component instance containing the first bus interface. - * @param [in] startBus Name of the first bus interface. - * @param [in] endInstanceName Name of the component instance containing the second bus interface. - * @param [in] endBus Name of the second bus interface. + * @param [in] startInstanceName Name of the component instance containing the first bus interface. + * @param [in] startBus Name of the first bus interface. + * @param [in] endInstanceName Name of the component instance containing the second bus interface. + * @param [in] endBus Name of the second bus interface. * - * @return True, if the connection was removed, false otherwise. + * @return True, if the connection was removed, false otherwise. */ bool removeInstanceConnection(std::string const& startInstanceName, std::string const& startBus, std::string const& endInstanceName, std::string const& endBus); @@ -442,11 +442,11 @@ class PythonAPI /*! * Remove an interconnection between two bus interfaces. * - * @param [in] instanceName Name of the component instance containing the selected bus interface. - * @param [in] instanceBus Name of the component instance bus interface. - * @param [in] topBus Name of the top component bus interface. + * @param [in] instanceName Name of the component instance containing the selected bus interface. + * @param [in] instanceBus Name of the component instance bus interface. + * @param [in] topBus Name of the top component bus interface. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeHierarchicalConnection(std::string const& instanceName, std::string const& instanceBus, std::string const& topBus); @@ -454,22 +454,22 @@ class PythonAPI /*! * Set a new name for the selected interconnection. * - * @param [in] currentName Name of the selected interconnection. - * @param [in] newName New name for the interconnection. + * @param [in] currentName Name of the selected interconnection. + * @param [in] newName New name for the interconnection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool renameConnection(std::string const& currentName, std::string const& newName); /*! * Create an ad hoc connection between two ports. * - * @param [in] startInstanceName Name of the component instance containing the first port. - * @param [in] startPort Name of the first port. - * @param [in] endInstanceName Name of the component instance containing the second port. - * @param [in] endPort Name of the second port. + * @param [in] startInstanceName Name of the component instance containing the first port. + * @param [in] startPort Name of the first port. + * @param [in] endInstanceName Name of the component instance containing the second port. + * @param [in] endPort Name of the second port. * - * @return True, if the connection was created, false otherwise. + * @return True, if the connection was created, false otherwise. */ bool createAdHocConnection(std::string const& startInstanceName, std::string const& startPort, std::string const& endInstanceName, std::string const& endPort); @@ -477,11 +477,11 @@ class PythonAPI /*! * Create a hierarchical ad hoc connection between two ports. * - * @param [in] instanceName Name of the component instance containing the selected port. - * @param [in] instancePort Name of the component instance port. - * @param [in] topPort Name of the top component port. + * @param [in] instanceName Name of the component instance containing the selected port. + * @param [in] instancePort Name of the component instance port. + * @param [in] topPort Name of the top component port. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool createHierarchicalAdHocConnection(std::string const& instanceName, std::string const& instancePort, std::string const& topPort); @@ -489,12 +489,12 @@ class PythonAPI /*! * Remove an ad hoc connection between two ports. * - * @param [in] startInstanceName Name of the component instance containing the first port. - * @param [in] startPort Name of the first port. - * @param [in] endInstanceName Name of the component instance containing the second port. - * @param [in] endPort Name of the second port. + * @param [in] startInstanceName Name of the component instance containing the first port. + * @param [in] startPort Name of the first port. + * @param [in] endInstanceName Name of the component instance containing the second port. + * @param [in] endPort Name of the second port. * - * @return True, if the ad hoc connection was removed, false otherwise. + * @return True, if the ad hoc connection was removed, false otherwise. */ bool removeInstanceAdHocConnection(std::string const& startInstanceName, std::string const& startPort, std::string const& endInstanceName, std::string const& endPort); @@ -502,11 +502,11 @@ class PythonAPI /*! * Remove a hierarchical ad hoc connection between two ports. * - * @param [in] instanceName Name of the component instance containing the selected port. - * @param [in] instancePort Name of the component instance port. - * @param [in] topPort Name of the top component port. + * @param [in] instanceName Name of the component instance containing the selected port. + * @param [in] instancePort Name of the component instance port. + * @param [in] topPort Name of the top component port. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeHierarchicalAdHocConnection(std::string const& instanceName, std::string const& instancePort, std::string const& topPort); @@ -514,10 +514,10 @@ class PythonAPI /*! * Set a new name for the selected ad hoc connection. * - * @param [in] currentName Name of the selected ad hoc connection. - * @param [in] newName New name for the ad hoc connection. + * @param [in] currentName Name of the selected ad hoc connection. + * @param [in] newName New name for the ad hoc connection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool renameAdHocConnection(std::string const& currentName, std::string const& newName); @@ -526,13 +526,13 @@ class PythonAPI /*! * Check if the connection end points exist. * - * @param [in] startInstanceName Name of the instance containing the first interface. - * @param [in] startBus Name of the first interface. - * @param [in] endInstanceName Name of the instance containing the second interface. - * @param [in] endBus Name of the second interface. - * @param [in] isAdHocConnection Flag for ad hoc connections. + * @param [in] startInstanceName Name of the instance containing the first interface. + * @param [in] startBus Name of the first interface. + * @param [in] endInstanceName Name of the instance containing the second interface. + * @param [in] endBus Name of the second interface. + * @param [in] isAdHocConnection Flag for ad hoc connections. * - * @return True, if the connection end points exist, false otherwise. + * @return True, if the connection end points exist, false otherwise. */ bool connectionEndsCheck(QString const& startInstanceName, QString const& startBus, QString const& endInstanceName, QString const& endBus, bool isAdHocConnection); @@ -540,23 +540,23 @@ class PythonAPI /*! * Check if the selected component instance exists. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. * - * @return True, if the component instance exists, false otherwise. + * @return True, if the component instance exists, false otherwise. */ bool instanceExists(QString const& instanceName) const; /*! * Check if the ad hoc connection end points exist. * - * @param [in] startComponent Component containing the first port. - * @param [in] startBus Name of the first port. - * @param [in] startInstanceName Name of the instance containing the first port. - * @param [in] endComponent Component containing the second port. - * @param [in] endBus Name of the second port. - * @param [in] endInstanceName Name of the instance containing the second port. + * @param [in] startComponent Component containing the first port. + * @param [in] startBus Name of the first port. + * @param [in] startInstanceName Name of the instance containing the first port. + * @param [in] endComponent Component containing the second port. + * @param [in] endBus Name of the second port. + * @param [in] endInstanceName Name of the instance containing the second port. * - * @return True, if the ad hoc connection end points exist, false otherwise. + * @return True, if the ad hoc connection end points exist, false otherwise. */ bool endsCheckForAdHoc(QSharedPointer startComponent, QString const& startBus, QString const& startInstanceName, QSharedPointer endComponent, QString const& endBus, @@ -565,14 +565,14 @@ class PythonAPI /*! * Check if the interconnection end points exist. * - * @param [in] startComponent Component containing the first bus interface. - * @param [in] startBus Name of the first bus interface. - * @param [in] startInstanceName Name of the instance containing the first bus interface. - * @param [in] endComponent Component containing the second bus interface. - * @param [in] endBus Name of the second bus interface. - * @param [in] endInstanceName Name of the instance containing the second bus interface. + * @param [in] startComponent Component containing the first bus interface. + * @param [in] startBus Name of the first bus interface. + * @param [in] startInstanceName Name of the instance containing the first bus interface. + * @param [in] endComponent Component containing the second bus interface. + * @param [in] endBus Name of the second bus interface. + * @param [in] endInstanceName Name of the instance containing the second bus interface. * - * @return True, if the interconnection end points exist, false otherwise. + * @return True, if the interconnection end points exist, false otherwise. */ bool endsCheckForInterconnection(QSharedPointer startComponent, QString const& startBus, QString const& startInstanceName, QSharedPointer endComponent, QString const& endBus, @@ -581,27 +581,27 @@ class PythonAPI /*! * Remove the selected interconnection. * - * @param [in] connectionName Name of the selected interconnection. + * @param [in] connectionName Name of the selected interconnection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeConnection(std::string const& connectionName); /*! * Remove the selected ad hoc connection. * - * @param [in] connectionName Name of the selected ad hoc connection. + * @param [in] connectionName Name of the selected ad hoc connection. * - * @return True, if successful, false otherwise. + * @return True, if successful, false otherwise. */ bool removeAdHocConnection(std::string const& connectionName); /*! * Get the selected document. * - * @param [in] vlnvString VLNV of the selected document in string form. + * @param [in] vlnvString VLNV of the selected document in string form. * - * @return The selected document. + * @return The selected document. */ QSharedPointer getDocument(QString const& vlnvString) const; @@ -623,19 +623,19 @@ class PythonAPI /*! * Get the selected memory map. * - * @param [in] mapName Name of the selected memory map. + * @param [in] mapName Name of the selected memory map. * - * @return The selected memory map. + * @return The selected memory map. */ QSharedPointer getMemoryMap(QString const& mapName) const; /*! * Get the selected address block. * - * @param [in] containingMap Memory map containing the address block. - * @param [in] blockName Name of the selected address block. + * @param [in] containingMap Memory map containing the address block. + * @param [in] blockName Name of the selected address block. * - * @return The selected address block. + * @return The selected address block. */ QSharedPointer getAddressBock(QSharedPointer containingMap, QString const& blockName) const; @@ -643,10 +643,10 @@ class PythonAPI /*! * Get the selected register. * - * @param [in] containingBlock Address block containing the registers. - * @param [in] registerName Name of the selected register. + * @param [in] containingBlock Address block containing the registers. + * @param [in] registerName Name of the selected register. * - * @return The selected register. + * @return The selected register. */ QSharedPointer getRegister(QSharedPointer containingBlock, QString const& registerName) const; @@ -654,43 +654,43 @@ class PythonAPI /*! * Get the selected field. * - * @param [in] containingRegister Register containing the fields. - * @param [in] fieldName Name of the selected field. + * @param [in] containingRegister Register containing the fields. + * @param [in] fieldName Name of the selected field. * - * @return The selected field. + * @return The selected field. */ QSharedPointer getField(QSharedPointer containingRegister, QString const& fieldName) const; /*! * Get the selected file set. * - * @param [in] setName Name of the selected file set. + * @param [in] setName Name of the selected file set. * - * @return The selected file set. + * @return The selected file set. */ QSharedPointer getFileSet(QString const& setName) const; /*! * Send an error text for a non-existing memory map. * - * @param [in] mapName Name of the memory map. + * @param [in] mapName Name of the memory map. */ void sendMemoryMapNotFoundError(QString const& mapName) const; /*! * Send an error text for a non-existing address block. * - * @param [in] mapName Name of the memory map containing the address block. - * @param [in] blockName Name of the address block. + * @param [in] mapName Name of the memory map containing the address block. + * @param [in] blockName Name of the address block. */ void sendAddressBlockNotFoundError(QString const& mapName, QString const& blockName) const; /*! * Send an error text for a non-existing register. * - * @param [in] mapName Name of the memory map containing the address block. - * @param [in] blockName Name of the address block containing the register. - * @param [in] registerName Name of the register. + * @param [in] mapName Name of the memory map containing the address block. + * @param [in] blockName Name of the address block containing the register. + * @param [in] registerName Name of the register. */ void sendRegisterNotFoundError(QString const& mapName, QString const& blockName, QString const& registerName) const; @@ -698,10 +698,10 @@ class PythonAPI /*! * Send an error text for a non-existing field. * - * @param [in] mapName Name of the memory map containing the address block. - * @param [in] blockName Name of the address block containing the register. - * @param [in] registerName Name of the register containing the field. - * @param [in] fieldName Name of the field. + * @param [in] mapName Name of the memory map containing the address block. + * @param [in] blockName Name of the address block containing the register. + * @param [in] registerName Name of the register containing the field. + * @param [in] fieldName Name of the field. */ void sendFieldNotFoundError(QString const& mapName, QString const& blockName, QString const& registerName, QString const& fieldName) const; @@ -709,7 +709,7 @@ class PythonAPI /*! * Send an error text for a non-existing file set. * - * @param [in] setName Name of the file set. + * @param [in] setName Name of the file set. */ void sendFileSetNotFoundError(QString const& setName) const; diff --git a/PythonAPI/PythonInterpreter.h b/PythonAPI/PythonInterpreter.h index 41f7a86a6..7de1b0c35 100644 --- a/PythonAPI/PythonInterpreter.h +++ b/PythonAPI/PythonInterpreter.h @@ -34,10 +34,10 @@ class PythonInterpreter : public QObject, public WriteChannel /*! * The constructor. * - * @param [in] outputChannel Channel for standard messages and interpreter output. - * @param [in] errorChannel Channel for error messages. - * @param [in] printPromt Flag for enabling prompt printing. - * @param [in] parent The parent object. + * @param [in] outputChannel Channel for standard messages and interpreter output. + * @param [in] errorChannel Channel for error messages. + * @param [in] printPromt Flag for enabling prompt printing. + * @param [in] parent The parent object. */ explicit PythonInterpreter(WriteChannel* outputChannel, WriteChannel* errorChannel, bool printPromt = true, @@ -49,9 +49,9 @@ class PythonInterpreter : public QObject, public WriteChannel /*! * Initializes the interpreter. This function must be called before writing any commands with write(). * - * @param [in] interactive Flag for enabling interactive std input. Set to true on command-line. + * @param [in] interactive Flag for enabling interactive std input. Set to true on command-line. * - * @return True, if initialization was successful, otherwise false. + * @return True, if initialization was successful, otherwise false. */ bool initialize(bool interactive = true); @@ -63,7 +63,7 @@ class PythonInterpreter : public QObject, public WriteChannel /*! * Execute a single line in the interpreter. * - * @param [in] line The line to execute. + * @param [in] line The line to execute. */ void execute(std::string const& line); @@ -76,21 +76,21 @@ public slots: /*! * Write a command for interpreter to execute. * - * @param [in] command The command to execute. + * @param [in] command The command to execute. */ virtual void write(QString const& command) override final; /*! * Execute the given arbitrary long string in the interpreter. * - * @param [in] string The string to execute. + * @param [in] string The string to execute. */ void executeString(QString const& string); /*! * Run a script from a given file. * - * @param [in] filePath Path to the file to run. + * @param [in] filePath Path to the file to run. */ void runFile(QString const& filePath); @@ -99,16 +99,16 @@ public slots: /*! * Redirect the interpreter output and error output to WriteChannels. * - * @param [in] interactive Flag for enabling interactive std input. Set to true on command-line. + * @param [in] interactive Flag for enabling interactive std input. Set to true on command-line. * - * @return True, if the input and outputs could be redirected, otherwise false. + * @return True, if the input and outputs could be redirected, otherwise false. */ bool redirectIO(bool interactive); /*! * Import and set the core api available in python context. * - * @return True, if the api was set, otherwise false. + * @return True, if the api was set, otherwise false. */ bool setAPI(); diff --git a/common/GenericEditProvider.h b/common/GenericEditProvider.h index 2670a7e8c..b2400d34f 100644 --- a/common/GenericEditProvider.h +++ b/common/GenericEditProvider.h @@ -32,7 +32,7 @@ class GenericEditProvider : public IEditProvider /*! * Constructor. * - * @param [in] historySize The maximum number of undo commands kept in the history. + * @param [in] historySize The maximum number of undo commands kept in the history. */ GenericEditProvider(int historySize); @@ -44,7 +44,7 @@ class GenericEditProvider : public IEditProvider /*! * Stores a new command to the edit stack. * - * @param [in] command The command to add. + * @param [in] command The command to add. */ void addCommand(QSharedPointer command); diff --git a/common/IEditProvider.h b/common/IEditProvider.h index 2625b1e6f..e4221e5eb 100644 --- a/common/IEditProvider.h +++ b/common/IEditProvider.h @@ -32,7 +32,7 @@ class IEditProvider : public QObject /*! * Stores a new command to the edit stack. * - * @param [in] command The command to add. + * @param [in] command The command to add. */ virtual void addCommand(QSharedPointer command) = 0; diff --git a/common/NameGenerationPolicy.h b/common/NameGenerationPolicy.h index e145b8e12..44a151248 100644 --- a/common/NameGenerationPolicy.h +++ b/common/NameGenerationPolicy.h @@ -19,19 +19,19 @@ namespace NameGenerationPolicy /*! * Returns name of a system view file set, based on the name of it. * - * @param [in] systemViewName Name of the system view. + * @param [in] systemViewName Name of the system view. * - * @return The resolved name for the file set. + * @return The resolved name for the file set. */ QString systemViewFilesetName(QString const& systemViewName); /*! * Returns name of a instance file set, based on the name of it. and its system view. * - * @param [in] systemViewName Name of the system view. - * @param [in] instanceName Name of the component instance. + * @param [in] systemViewName Name of the system view. + * @param [in] instanceName Name of the component instance. * - * @return The resolved name for the file set. + * @return The resolved name for the file set. */ QString instanceFilesetName(QString const& systemViewName, QString const& instanceName); @@ -39,7 +39,7 @@ namespace NameGenerationPolicy * Returns name of a flat view, based on a qualifier. * If the qualifier is empty, returns a name without language. * - * @param [in] qualifierName The qualifier that separates the view from others. + * @param [in] qualifierName The qualifier that separates the view from others. */ QString flatViewName(QString const& qualifierName = QString("")); @@ -47,7 +47,7 @@ namespace NameGenerationPolicy * Returns name of a hierarchical view, on a qualifier. * If the qualifier is empty, returns a name without language. * - * @param [in] qualifierName The qualifier that separates the view from others. + * @param [in] qualifierName The qualifier that separates the view from others. */ QString hierarchicalViewName(QString const& qualifierName = QString("")); @@ -55,21 +55,21 @@ namespace NameGenerationPolicy * Returns name of a component instantiation, based on a qualifier. * If the qualifier is empty, returns a name without language. * - * @param [in] qualifierName The qualifier that separates the instantiation from others. + * @param [in] qualifierName The qualifier that separates the instantiation from others. */ QString componentInstantiationName(QString const& qualifierName = QString("")); /*! * Returns name of a design instantiation, based on a qualifier. * - * @param [in] qualifierName The qualifier that separates the instantiation from others. + * @param [in] qualifierName The qualifier that separates the instantiation from others. */ QString designInstantiationName(QString const& qualifierName); /*! * Returns name of a design configuration instantiation, based on a qualifier. * - * @param [in] qualifierName The qualifier that separates the instantiation from others. + * @param [in] qualifierName The qualifier that separates the instantiation from others. */ QString designConfigurationInstantiationName(QString const& qualifierName); }; diff --git a/common/TextEditProvider.h b/common/TextEditProvider.h index 33ab7adae..a1c38bf7d 100644 --- a/common/TextEditProvider.h +++ b/common/TextEditProvider.h @@ -25,7 +25,7 @@ class TextEditProvider : public IEditProvider /*! * Constructor. * - * @param [in] textEdit The text editor to which the provider applies. + * @param [in] textEdit The text editor to which the provider applies. */ explicit TextEditProvider(QPlainTextEdit& textEdit); @@ -41,7 +41,7 @@ class TextEditProvider : public IEditProvider /*! * Stores a new command to the edit stack. * - * @param [in] command The command to add. + * @param [in] command The command to add. */ virtual void addCommand(QSharedPointer command) override final; diff --git a/common/dialogs/LibrarySettingsDialog/LibrarySettingsDialog.h b/common/dialogs/LibrarySettingsDialog/LibrarySettingsDialog.h index ca4da0414..76e1d3995 100644 --- a/common/dialogs/LibrarySettingsDialog/LibrarySettingsDialog.h +++ b/common/dialogs/LibrarySettingsDialog/LibrarySettingsDialog.h @@ -32,8 +32,8 @@ class LibrarySettingsDialog : public QDialog /*! * Constructor. * - * @param [in/out] settings The settings store. - * @param [in] parent The parent widget. + * @param [in/out] settings The settings store. + * @param [in] parent The parent widget. */ LibrarySettingsDialog(QSettings& settings, QWidget* parent = 0); @@ -45,7 +45,7 @@ class LibrarySettingsDialog : public QDialog /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. */ bool validate(); @@ -69,8 +69,8 @@ public slots: /*! * Called when a location is selected in the locations list. * - * @param [in] cur Pointer to the selected item. - * @param [in] prev Pointer to the previously selected item. + * @param [in] cur Pointer to the selected item. + * @param [in] prev Pointer to the previously selected item. */ void onSelectLocation(QTableWidgetItem* cur, QTableWidgetItem* prev); @@ -86,7 +86,7 @@ private slots: /*! * Handler for item clicks on the lib locations list. * - * @param [in] item Pointer to the clicked item. + * @param [in] item Pointer to the clicked item. */ void onItemClicked(QTableWidgetItem* item); @@ -109,23 +109,23 @@ private slots: /*! * Creates a row in the library path table for the given directory. * - * @param [in] directory The directory to add as library path. - * @param [in] isActive Is the directory is set active or not. - * @param [in] isDefault Is the directory is set default or not. + * @param [in] directory The directory to add as library path. + * @param [in] isActive Is the directory is set active or not. + * @param [in] isDefault Is the directory is set default or not. */ void createRowForDirectory(QString const& directory, bool isActive, bool isDefault); /*! * Change the default path for the library. * - * @param [in] item Table item for the new default path. + * @param [in] item Table item for the new default path. */ void changeDefaultPath(QTableWidgetItem* item); /*! * Change the active status of the selected library path. * - * @param [in] item The selected table item. + * @param [in] item The selected table item. */ void changeActivePathStatus(QTableWidgetItem* item); diff --git a/common/dialogs/LibrarySettingsDialog/librarysettingsdelegate.h b/common/dialogs/LibrarySettingsDialog/librarysettingsdelegate.h index 5beaae8e0..30f5de9af 100644 --- a/common/dialogs/LibrarySettingsDialog/librarysettingsdelegate.h +++ b/common/dialogs/LibrarySettingsDialog/librarysettingsdelegate.h @@ -26,7 +26,7 @@ class LibrarySettingsDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] parent Pointer to the owner of the delegate. */ LibrarySettingsDelegate(QObject *parent); @@ -38,9 +38,9 @@ class LibrarySettingsDelegate : public QStyledItemDelegate /*! * Paint the check marks in the middle of the active and default columns. * - * @param [in] painter The selected painter. - * @param [in] option Options of the painter. - * @param [in] index Current table index. + * @param [in] painter The selected painter. + * @param [in] option Options of the painter. + * @param [in] index Current table index. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; diff --git a/common/dialogs/NewBusDialog/NewBusDialog.h b/common/dialogs/NewBusDialog/NewBusDialog.h index 27c70fe57..b21973c62 100644 --- a/common/dialogs/NewBusDialog/NewBusDialog.h +++ b/common/dialogs/NewBusDialog/NewBusDialog.h @@ -37,8 +37,8 @@ class NewBusDialog : public NewObjectDialog /*! * Constructor. * - * @param [in] lh The library interface. - * @param [in] parent The parent wizard. + * @param [in] lh The library interface. + * @param [in] parent The parent wizard. */ NewBusDialog(LibraryInterface* lh, QWidget* parent); @@ -50,7 +50,7 @@ class NewBusDialog : public NewObjectDialog /*! * Gets the selected source for logical signal name genertaion. * - * @return The selected source that is either name or description. + * @return The selected source that is either name or description. */ Signal_selection getSignalSelection() const; diff --git a/common/dialogs/NewDesignDialog/NewDesignDialog.h b/common/dialogs/NewDesignDialog/NewDesignDialog.h index 9c8acb049..3b7cc96bd 100644 --- a/common/dialogs/NewDesignDialog/NewDesignDialog.h +++ b/common/dialogs/NewDesignDialog/NewDesignDialog.h @@ -38,10 +38,10 @@ class NewDesignDialog : public QDialog /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] component The component for which the design will be created. - * @param [in] designType The type of design to create. - * @param [in] parent The parent widget. + * @param [in] libInterface The library interface. + * @param [in] component The component for which the design will be created. + * @param [in] designType The type of design to create. + * @param [in] parent The parent widget. */ NewDesignDialog(LibraryInterface* libInterface, QSharedPointer component, KactusAttribute::Implementation designType, QWidget *parent = 0); @@ -50,7 +50,7 @@ class NewDesignDialog : public QDialog /*! * Sets the pre-filled view name. * - * @param [in] viewName The view name to set. + * @param [in] viewName The view name to set. */ void setViewName(QString const& viewName); @@ -62,7 +62,7 @@ class NewDesignDialog : public QDialog /*! * Sets the pre-filled VLNV. * - * @param [in] vlnv The VLNV to set. + * @param [in] vlnv The VLNV to set. */ void setVLNV(const VLNV& vlnv); diff --git a/common/dialogs/createConfigurationDialog/createconfigurationdialog.h b/common/dialogs/createConfigurationDialog/createconfigurationdialog.h index d8d94f40b..7a07e6207 100644 --- a/common/dialogs/createConfigurationDialog/createconfigurationdialog.h +++ b/common/dialogs/createConfigurationDialog/createconfigurationdialog.h @@ -45,10 +45,10 @@ class CreateConfigurationDialog : public QDialog /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component to create the configuration for. - * @param [in] configType What kind of configuration is to be created. - * @param [in] parent Pointer to the owner of this dialog + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component to create the configuration for. + * @param [in] configType What kind of configuration is to be created. + * @param [in] parent Pointer to the owner of this dialog */ CreateConfigurationDialog(LibraryInterface* handler, QSharedPointer component, @@ -61,28 +61,28 @@ class CreateConfigurationDialog : public QDialog /*! * Get the VLNV for the design configuration to create. * - * @return VLNV the vlnv for the design configuration. + * @return VLNV the vlnv for the design configuration. */ VLNV getConfigurationVLNV() const; /*! * Get the VLNV for the design to create. * - * @return VLNV the vlnv for the design. + * @return VLNV the vlnv for the design. */ VLNV getDesignVLNV() const; /*! * Get the name for the view to be saved to the component. * - * @return QString Contains the name for the view. + * @return QString Contains the name for the view. */ QString getConfigurationName() const; /*! * Find out if user wanted to use existing design or create a new one. * - * @return CreateConfigurationDialog::DesignSelection specifies what kind of operation was selected. + * @return CreateConfigurationDialog::DesignSelection specifies what kind of operation was selected. */ DesignSelection designSelection() const; diff --git a/common/dialogs/listSelectDialog/ListSelectDialog.h b/common/dialogs/listSelectDialog/ListSelectDialog.h index 8863b8398..f3390a143 100644 --- a/common/dialogs/listSelectDialog/ListSelectDialog.h +++ b/common/dialogs/listSelectDialog/ListSelectDialog.h @@ -35,14 +35,14 @@ class ListSelectDialog : public QDialog /*! * Sets the description text for the list. * - * @param [in] desc The description text. + * @param [in] desc The description text. */ void setDescription(QString const& desc); /*! * Adds a new item to the list. * - * @param [in] item The item to add. + * @param [in] item The item to add. */ void addItem(QListWidgetItem* item); diff --git a/common/dialogs/newObjectDialog/newobjectdialog.h b/common/dialogs/newObjectDialog/newobjectdialog.h index ba2948850..648793a1f 100644 --- a/common/dialogs/newObjectDialog/newobjectdialog.h +++ b/common/dialogs/newObjectDialog/newobjectdialog.h @@ -37,10 +37,10 @@ class NewObjectDialog: public QDialog /*! * The constructor. * - * @param [in] libInterface The library interface. - * @param [in] type New object type. - * @param [in] showAttributes Flag for visible attributes. - * @param [in] parent Owner of this dialog. + * @param [in] libInterface The library interface. + * @param [in] type New object type. + * @param [in] showAttributes Flag for visible attributes. + * @param [in] parent Owner of this dialog. */ NewObjectDialog(LibraryInterface* libInterface, VLNV::IPXactType type, bool showAttributes, QWidget *parent = 0); @@ -52,16 +52,16 @@ class NewObjectDialog: public QDialog /*! * Set the vlnv for the editor. * - * @param [in] vlnv Reference to the vlnv to set. + * @param [in] vlnv Reference to the vlnv to set. */ void setVLNV(const VLNV& vlnv); /*! * Sets the Kactus attributes for the dialog. * - * @param [in] prodHier Product hierarchy. - * @param [in] firmness firmness. - * @param [in] tags Tags. + * @param [in] prodHier Product hierarchy. + * @param [in] firmness firmness. + * @param [in] tags Tags. */ void setKactusAttributes(KactusAttribute::ProductHierarchy prodHier, KactusAttribute::Firmness firmness, QVector tags); @@ -84,7 +84,7 @@ class NewObjectDialog: public QDialog /*! * Get the document tags. * - * @return Document tags. + * @return Document tags. */ QVector getTags() const; @@ -96,16 +96,16 @@ class NewObjectDialog: public QDialog /*! * Shows a pre-filled dialog with the version field set empty. * - * @param [in] parent The parent widget. - * @param [in] lh Interface to the library. - * @param [in] oldVLNV The old VLNV. - * @param [in] prodHier Product hierarchy. - * @param [in] firmness Firmness. - * @param [in] tags Document tags. - * @param [in] vlnv VLNV. - * @param [in] directory Directory. + * @param [in] parent The parent widget. + * @param [in] lh Interface to the library. + * @param [in] oldVLNV The old VLNV. + * @param [in] prodHier Product hierarchy. + * @param [in] firmness Firmness. + * @param [in] tags Document tags. + * @param [in] vlnv VLNV. + * @param [in] directory Directory. * - * @return True, if the user pressed OK. False if the user pressed Cancel. + * @return True, if the user pressed OK. False if the user pressed Cancel. */ static bool saveAsDialog(QWidget* parent, LibraryInterface* lh, VLNV const& oldVLNV, KactusAttribute::ProductHierarchy& prodHier, KactusAttribute::Firmness& firmness, QVector& tags, @@ -114,7 +114,7 @@ class NewObjectDialog: public QDialog /*! * Shows a pre-filled dialog with the version field set empty and attributes hidden. * - * @return True, if the user pressed OK. False if the user pressed Cancel. + * @return True, if the user pressed OK. False if the user pressed Cancel. */ static bool saveAsDialog(QWidget* parent, LibraryInterface* lh, VLNV const& oldVLNV, VLNV& vlnv, QString& directory, QString const& windowTitle = QString("Save As")); diff --git a/common/dialogs/propertyPageDialog/PropertyPageDialog.h b/common/dialogs/propertyPageDialog/PropertyPageDialog.h index 385906d27..df4853773 100644 --- a/common/dialogs/propertyPageDialog/PropertyPageDialog.h +++ b/common/dialogs/propertyPageDialog/PropertyPageDialog.h @@ -49,11 +49,11 @@ class PropertyPageDialog : public QDialog /*! * Constructor. * - * @param [in] listIconSize The icon size in the contents list. - * @param [in] viewMode Specifies the view mode how the organizer is shown. - * @param [in] applyMode Apply mode which specifies what pages are applied when + * @param [in] listIconSize The icon size in the contents list. + * @param [in] viewMode Specifies the view mode how the organizer is shown. + * @param [in] applyMode Apply mode which specifies what pages are applied when * the user presses OK. - * @param [in] parent The parent widget. Can be null. + * @param [in] parent The parent widget. Can be null. */ PropertyPageDialog(QSize const& listIconSize, int iconColumnCount, ViewMode viewMode, ApplyMode applyMode, QWidget* parent = 0); @@ -66,9 +66,9 @@ class PropertyPageDialog : public QDialog /*! * Adds a new property page to the dialog. * - * @param [in] icon The icon for the page. - * @param [in] text The text description for the page. - * @param [in] view The page view. + * @param [in] icon The icon for the page. + * @param [in] text The text description for the page. + * @param [in] view The page view. */ void addPage(QIcon const& icon, QString const& text, PropertyPageView* view); @@ -81,8 +81,8 @@ public slots: /*! * Changes the current page based on the selection in the contents list. * - * @param [in] current The current list item selected in the contents list. - * @param [in] previous The previously selected item in the contents list. + * @param [in] current The current list item selected in the contents list. + * @param [in] previous The previously selected item in the contents list. */ void changePage(QListWidgetItem* current, QListWidgetItem* previous); diff --git a/common/dialogs/propertyPageDialog/PropertyPageView.h b/common/dialogs/propertyPageDialog/PropertyPageView.h index 0ab5a9ce6..e37040e31 100644 --- a/common/dialogs/propertyPageDialog/PropertyPageView.h +++ b/common/dialogs/propertyPageDialog/PropertyPageView.h @@ -35,7 +35,7 @@ class PropertyPageView : public QWidget /*! * Pre-validates the contents of the page. This is used for enabling/disabling the OK button. * - * @return True, if the contents are valid and OK button should be enabled. + * @return True, if the contents are valid and OK button should be enabled. * False, if the contents are invalid and OK button should be disabled. * * @remarks Must not show any message boxes. @@ -45,7 +45,7 @@ class PropertyPageView : public QWidget /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -59,7 +59,7 @@ class PropertyPageView : public QWidget /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ virtual bool onPageChange(); diff --git a/common/expressions/utilities.h b/common/expressions/utilities.h index 69be4b07f..d3cb07c2f 100644 --- a/common/expressions/utilities.h +++ b/common/expressions/utilities.h @@ -23,11 +23,11 @@ namespace ExpressionUtilities /*! * Finds the index of a matching end parenthesis in an equation. * - * @param [in] equation The selected equation. - * @param [in] parenthesisStart Index of the start parenthesis. - * @param [in] commentSyntax Syntax for possible comments in the equation. + * @param [in] equation The selected equation. + * @param [in] parenthesisStart Index of the start parenthesis. + * @param [in] commentSyntax Syntax for possible comments in the equation. * - * @return Index of the end parenthesis matching the selected start parenthesis. + * @return Index of the end parenthesis matching the selected start parenthesis. */ int findMatchingEndParenthesis(QString const& equation, int parenthesesStart, QString commentSyntax = "[/]{2}[\\t]*([^\\r\\n]*)(?=\\r?\\n|$)"); diff --git a/common/graphicsItems/CommonGraphicsUndoCommands.h b/common/graphicsItems/CommonGraphicsUndoCommands.h index ddce85cf8..24582f3f0 100644 --- a/common/graphicsItems/CommonGraphicsUndoCommands.h +++ b/common/graphicsItems/CommonGraphicsUndoCommands.h @@ -31,10 +31,10 @@ class ItemAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] stack The stack to which to add the item. - * @param [in] item The item to add. - * @param [in] diagram Diagram containing the scene of the added item. - * @param [in] parent The parent command. + * @param [in] stack The stack to which to add the item. + * @param [in] item The item to add. + * @param [in] diagram Diagram containing the scene of the added item. + * @param [in] parent The parent command. */ ItemAddCommand(IGraphicsItemStack* stack, QGraphicsItem* item, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -85,11 +85,11 @@ class ItemMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] item The item to move. - * @param [in] oldPos The item's old position. - * @param [in] oldStack The item's old stack. - * @param [in] diagram Diagram containing the scene of the moved item. - * @param [in] parent The parent command. + * @param [in] item The item to move. + * @param [in] oldPos The item's old position. + * @param [in] oldStack The item's old stack. + * @param [in] diagram Diagram containing the scene of the moved item. + * @param [in] parent The parent command. */ ItemMoveCommand(QGraphicsItem* item, QPointF const& oldPos, IGraphicsItemStack* oldStack, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -97,13 +97,13 @@ class ItemMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] item The item to move. - * @param [in] oldPos The item's old position. - * @param [in] oldStack The item's old stack. - * @param [in] newPos The item's new position. - * @param [in] newStacke The item's new stack. - * @param [in] diagram Diagram containing the scene of the moved item. - * @param [in] parent The parent command. + * @param [in] item The item to move. + * @param [in] oldPos The item's old position. + * @param [in] oldStack The item's old stack. + * @param [in] newPos The item's new position. + * @param [in] newStacke The item's new stack. + * @param [in] diagram Diagram containing the scene of the moved item. + * @param [in] parent The parent command. */ ItemMoveCommand(QGraphicsItem* item, QPointF const& oldPos, IGraphicsItemStack* oldStack, QPointF const& newPos, IGraphicsItemStack* newStack, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/common/graphicsItems/ComponentItem.h b/common/graphicsItems/ComponentItem.h index 7e893f490..84c26779f 100644 --- a/common/graphicsItems/ComponentItem.h +++ b/common/graphicsItems/ComponentItem.h @@ -39,11 +39,11 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Constructor. * - * @param [in] size The initial rectangle size. - * @param [in] libInterface The library interface. - * @param [in] component The actual component. - * @param [in] instanceName The name of the component instance. - * @param [in] parent The parent graphics item. + * @param [in] size The initial rectangle size. + * @param [in] libInterface The library interface. + * @param [in] component The actual component. + * @param [in] instanceName The name of the component instance. + * @param [in] parent The parent graphics item. */ @@ -85,21 +85,21 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Sets the instance name. * - * @param [in] newName The instance name to set. + * @param [in] newName The instance name to set. */ void setName(QString const& newName); /*! * Sets the display name for the component instance. * - * @param [in] displayName The display name to set. + * @param [in] displayName The display name to set. */ void setDisplayName(QString const& displayName); /*! * Sets the description of the component instance. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(const QString& description); @@ -153,9 +153,9 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Defines the connection point for associations in scene coordinates. * - * @param [in] otherEnd The position of the other end connection point. + * @param [in] otherEnd The position of the other end connection point. * - * @return The connection point of the item. + * @return The connection point of the item. */ virtual QPointF connectionPoint(QPointF const& otherEnd = QPointF()) const; @@ -172,7 +172,7 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Handle the movement of a connection end point item. * - * @param [in] port The selected connection end point item. + * @param [in] port The selected connection end point item. */ virtual void onMovePort(ConnectionEndpoint* port) = 0; @@ -213,7 +213,7 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Updates the name label with the given text. * - * @param [in] text The text to display in the label. + * @param [in] text The text to display in the label. */ virtual void updateNameLabel(); @@ -221,28 +221,28 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Adds an interface item to component side determined by the item position. * - * @param [in] port The interface item to add. + * @param [in] port The interface item to add. */ void addPortToSideByPosition(ConnectionEndpoint* port); /*! * Adds an interface item to the component side with less ports. * - * @param [in] port The interface item to add. + * @param [in] port The interface item to add. */ void addPortToSideWithLessPorts(ConnectionEndpoint* port); /*! * Adds a bus interface on the left side of the component item. * - * @param [in] port The port to add. + * @param [in] port The port to add. */ void addPortToLeft(ConnectionEndpoint* port); /*! * Adds a bus interface on the right side of the component item. * - * @param [in] port The port to add. + * @param [in] port The port to add. */ void addPortToRight(ConnectionEndpoint* port); @@ -250,8 +250,8 @@ class ComponentItem : public QObject, public QGraphicsRectItem, public Associabl /*! * Check and resize the port labels to better match with the component width. * - * @param [in] port The port that is compared to the other stack. - * @param [in] otherSide The stack containing the ports of the other side. + * @param [in] port The port that is compared to the other stack. + * @param [in] otherSide The stack containing the ports of the other side. */ void checkPortLabelSize(ConnectionEndpoint* port, QList const& otherSide); diff --git a/common/graphicsItems/ConnectionEndpoint.h b/common/graphicsItems/ConnectionEndpoint.h index dd697b7e1..ce244e933 100644 --- a/common/graphicsItems/ConnectionEndpoint.h +++ b/common/graphicsItems/ConnectionEndpoint.h @@ -63,7 +63,7 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Constructor. * - * @param [in] parent The parent graphics item. + * @param [in] parent The parent graphics item. */ ConnectionEndpoint(QGraphicsItem* parent = 0); @@ -80,28 +80,28 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Sets the highlighting mode. * - * @param [in] mode The highlight mode. + * @param [in] mode The highlight mode. */ void setHighlight(HighlightMode mode); /*! * Sets the selection highlight on/off. * - * @param [in] on If true, the selection highlight is turned on. Otherwise it is turned off. + * @param [in] on If true, the selection highlight is turned on. Otherwise it is turned off. */ virtual void setSelectionHighlight(bool on); /*! * Attaches the endpoint to a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ virtual void addConnection(GraphicsConnection* connection); /*! * Unattaches the endpoint from a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ virtual void removeConnection(GraphicsConnection* connection); @@ -133,16 +133,16 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Called when a connection between this and another endpoint is done. * - * @param [in] other The other endpoint of the connection. + * @param [in] other The other endpoint of the connection. * - * @return False if there was an error in the connection. Otherwise true. + * @return False if there was an error in the connection. Otherwise true. */ virtual bool onConnect(ConnectionEndpoint const* other) = 0; /*! * Called when a connection has been removed from between this and another endpoint. * - * @param [in] other The other endpoint of the connection. + * @param [in] other The other endpoint of the connection. */ virtual void onDisconnect(); @@ -150,21 +150,21 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem * Returns true if this endpoint can be connected to the given endpoint, taking existing * connections into account. * - * @param [in] other The endpoint to which to connect. + * @param [in] other The endpoint to which to connect. */ virtual bool canConnect(ConnectionEndpoint const* other) const; /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks The function checks all possible connections between * two endpoint, including there off-page connectors * and parent connectors. Does not take into account * if endpoint is exclusive. * - * @return Boolean true if two endpoints can be connected, otherwise false. + * @return Boolean true if two endpoints can be connected, otherwise false. */ virtual bool isConnectionValid(ConnectionEndpoint const* other) const; @@ -176,7 +176,7 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Sets the draw direction of the endpoint. * - * @param [in] dir The draw direction to set. + * @param [in] dir The draw direction to set. * * @remarks The direction can be changed only if isDirectionFixed() returns false. */ @@ -308,7 +308,7 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Sets the endpoint temporary or not temporary. Temporary endpoints can be deleted. * - * @param [in] temp True if temporary; false if not temporary. + * @param [in] temp True if temporary; false if not temporary. */ virtual void setTemporary(bool temp); @@ -326,7 +326,7 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem * Sets the endpoint type locked or not. A locked endpoint has a strict type, while a non-locked * endpoint automatically adjusts its type when connections are added/removed. * - * @param [in] typed If true, the endpoint is set as typed. + * @param [in] typed If true, the endpoint is set as typed. */ void setTypeLocked(bool typed); @@ -338,7 +338,7 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Get the interface mode of the connected bus interface. * - * @return The interface mode of the end point. + * @return The interface mode of the end point. */ virtual General::InterfaceMode getInterfaceMode() const; @@ -350,14 +350,14 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Shorten the name label to better fit the component. * - * @param [in] width The width of the shortened name. + * @param [in] width The width of the shortened name. */ virtual void shortenNameLabel( qreal width ); /*! * Checks if the endpoint is off-page. * - * @return Boolean true if endpoint is off-page, otherwise false. + * @return Boolean true if endpoint is off-page, otherwise false. */ bool isOffPage() const; @@ -387,9 +387,9 @@ class ConnectionEndpoint : public QObject, public QGraphicsPolygonItem /*! * Checks if points are connected * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * - * @return Boolean true is the points are connected, otherwise false. + * @return Boolean true is the points are connected, otherwise false. * * @remarks Does not take into account weather points are off-page or not, thus checking two points directly. diff --git a/common/graphicsItems/ConnectionItem.h b/common/graphicsItems/ConnectionItem.h index 25d6fd147..9f96718d4 100644 --- a/common/graphicsItems/ConnectionItem.h +++ b/common/graphicsItems/ConnectionItem.h @@ -46,43 +46,43 @@ class ConnectionItem : public GraphicsConnection /*! * Set the name for the connection item. * - * @param [in] name The new connection item name. + * @param [in] name The new connection item name. */ void setName(QString const& name) final; /*! * Get the name of the connection item. * - * @return The name of the connection item. + * @return The name of the connection item. */ QString name() const final; /*! * Set the description for the connection item. * - * @param [in] description The new description. + * @param [in] description The new description. */ void setDescription(QString const& description) final; /*! * Get the description for the connection item. * - * @return The description of the connection item. + * @return The description of the connection item. */ QString description() const final; /*! * Get the contained interconnection. * - * @return The interconnection contained within this item. + * @return The interconnection contained within this item. */ QSharedPointer getInterconnection(); /*! * Change the component reference of a contained interface. * - * @param [in] oldName The old component reference. - * @param [in] newName The new component reference. + * @param [in] oldName The old component reference. + * @param [in] newName The new component reference. */ void changeConnectionComponentReference(QString const& oldName, QString const& newName) final; diff --git a/common/graphicsItems/ConnectionUndoCommands.h b/common/graphicsItems/ConnectionUndoCommands.h index 1e2738027..64e79074b 100644 --- a/common/graphicsItems/ConnectionUndoCommands.h +++ b/common/graphicsItems/ConnectionUndoCommands.h @@ -27,9 +27,9 @@ class ConnectionMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] conn The interconnection. - * @param [in] oldRoute The old route of the interconnection. - * @param [in] parent The parent command. + * @param [in] conn The interconnection. + * @param [in] oldRoute The old route of the interconnection. + * @param [in] parent The parent command. */ ConnectionMoveCommand(GraphicsConnection* connection, QList const& oldRoute, QUndoCommand* parent = 0); @@ -134,10 +134,10 @@ class ConnectionExchangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] conn The connection. - * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. - * @param [in] newEndpoint The new endpoint to which to connect the connection. - * @param [in] parent The parent command. + * @param [in] conn The connection. + * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. + * @param [in] newEndpoint The new endpoint to which to connect the connection. + * @param [in] parent The parent command. */ ConnectionExchangeCommand(GraphicsConnection* connection, ConnectionEndpoint* oldEndpoint, ConnectionEndpoint* newEndpoint, QUndoCommand* parent = 0); @@ -185,7 +185,7 @@ class ConnectionToggleOffPageCommand : public QUndoCommand /*! * Constructor. * - * @param [in] conn The interconnection to delete. + * @param [in] conn The interconnection to delete. */ ConnectionToggleOffPageCommand(GraphicsConnection* conn, QUndoCommand* parent = 0); diff --git a/common/graphicsItems/GraphicsColumn.h b/common/graphicsItems/GraphicsColumn.h index 8bcc45f89..7ee7975fc 100644 --- a/common/graphicsItems/GraphicsColumn.h +++ b/common/graphicsItems/GraphicsColumn.h @@ -40,9 +40,9 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Constructor. * - * @param [in] desc The column description. - * @param [in] layout The parent column layout. - * @param [in] itemsCanTransferToOtherColumns Possibility of item transfer between columns. + * @param [in] desc The column description. + * @param [in] layout The parent column layout. + * @param [in] itemsCanTransferToOtherColumns Possibility of item transfer between columns. */ GraphicsColumn(QSharedPointer desc, GraphicsColumnLayout* layout, bool itemsCanTransferToOtherColumns = true); @@ -55,7 +55,7 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Sets the name of the system column. * - * @param [in] name The name of the column. + * @param [in] name The name of the column. */ void setName(QString const& name); @@ -77,14 +77,14 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Sets the column width. * - * @param [in] width The new width to set. + * @param [in] width The new width to set. */ void setWidth(unsigned int width); /*! * Sets the y coordinate offset. * - * @param [in] y The y coordinate offset. + * @param [in] y The y coordinate offset. */ void setOffsetY(qreal y); @@ -110,29 +110,29 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Adds an item to the system column. * - * @param [in] item The item to add. - * @param [in] load If true, the item is being loaded from a design. + * @param [in] item The item to add. + * @param [in] load If true, the item is being loaded from a design. */ virtual void addItem(QGraphicsItem* item, bool load = false); /*! * Removes an item from the system column. * - * @param [in] item the item to remove. + * @param [in] item the item to remove. */ virtual void removeItem(QGraphicsItem* item); /*! * Called when an item is moved within the column. * - * @param [in] item The item that has been moved. + * @param [in] item The item that has been moved. */ virtual void onMoveItem(QGraphicsItem* item); /*! * Called when an item is released from being moved by mouse. * - * @param [in] item The item that has been released. + * @param [in] item The item that has been released. */ virtual void onReleaseItem(QGraphicsItem* item); @@ -154,7 +154,7 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Returns true if the stack is allowed to contain the given item. * - * @param [in] item The item to test for. + * @param [in] item The item to test for. */ virtual bool isItemAllowed(QGraphicsItem* item) const; @@ -187,8 +187,8 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Returns true if the given item is allowed to reside in the column based on the allowed items. * - * @param [in] item The item. - * @param [in] allowedItems The allowed items flags. + * @param [in] item The item. + * @param [in] allowedItems The allowed items flags. */ virtual bool isItemAllowed(QGraphicsItem* item, unsigned int allowedItems) const = 0; @@ -200,14 +200,14 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Creates an undo command for the column move. * - * @return The created undo command. + * @return The created undo command. */ virtual QSharedPointer createMoveUndoCommand(); /*! * Changes the item layout. * - * @param [in] itemLayout The item layout to set. + * @param [in] itemLayout The item layout to set. */ void setItemLayout(QSharedPointer< IVGraphicsLayout > itemLayout); @@ -219,8 +219,8 @@ class GraphicsColumn : public QObject, public QGraphicsRectItem, public IGraphic /*! * Switches the given item to another column. * - * @param [in] item The item to move. - * @param [in] column The destination column. + * @param [in] item The item to move. + * @param [in] column The destination column. */ void switchItemToColumn(QGraphicsItem* item, GraphicsColumn* column); diff --git a/common/graphicsItems/GraphicsColumnAddCommand.h b/common/graphicsItems/GraphicsColumnAddCommand.h index 526426488..c3670098a 100644 --- a/common/graphicsItems/GraphicsColumnAddCommand.h +++ b/common/graphicsItems/GraphicsColumnAddCommand.h @@ -29,10 +29,10 @@ class GraphicsColumnAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] layout The column layout. - * @param [in] column The column to add. - * @param [in] diagram Design diagram containing the new column. - * @param [in] parent The parent command. + * @param [in] layout The column layout. + * @param [in] column The column to add. + * @param [in] diagram Design diagram containing the new column. + * @param [in] parent The parent command. */ GraphicsColumnAddCommand(GraphicsColumnLayout* layout, GraphicsColumn* column, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -57,28 +57,28 @@ class GraphicsColumnAddCommand : public QUndoCommand /*! * Get the added graphics column. * - * @return The new graphics column. + * @return The new graphics column. */ GraphicsColumn* getColumn() const; /*! * Get the column layout. * - * @return The column layout. + * @return The column layout. */ GraphicsColumnLayout* getLayout() const; /*! * Get the design diagram. * - * @return The design diagram. + * @return The design diagram. */ DesignDiagram* getDiagram() const; /*! * Check if the column should be deleted. * - * @return True, if the column should be deleted, false otherwise. + * @return True, if the column should be deleted, false otherwise. */ bool columnShouldBeDeleted() const; diff --git a/common/graphicsItems/GraphicsColumnLayout.h b/common/graphicsItems/GraphicsColumnLayout.h index 4b55e4b07..ddbb7a119 100644 --- a/common/graphicsItems/GraphicsColumnLayout.h +++ b/common/graphicsItems/GraphicsColumnLayout.h @@ -33,7 +33,7 @@ class GraphicsColumnLayout : public QObject /*! * Constructor. * - * @param [in] scene The parent graphics scene. + * @param [in] scene The parent graphics scene. */ GraphicsColumnLayout(QGraphicsScene* scene = 0); @@ -45,52 +45,52 @@ class GraphicsColumnLayout : public QObject /*! * Adds an item to the first column where it is allowed to be placed. * - * @param [in] item The item to add. + * @param [in] item The item to add. */ void addItem(QGraphicsItem* item); /*! * Adds a column to the layout. * - * @param [in] column The column to add. - * @param [in] append If true, the column is appended to the end of the layout. + * @param [in] column The column to add. + * @param [in] append If true, the column is appended to the end of the layout. */ void addColumn(GraphicsColumn* column, bool append = false); /*! * Add the selected column to the end of the layout. * - * @param [in] column The selected column. + * @param [in] column The selected column. */ void appendColumn(GraphicsColumn* column); /*! * Removes a column from the layout. * - * @param [in] column The column to remove. + * @param [in] column The column to remove. */ void removeColumn(GraphicsColumn* column); /*! * Searches for a column containing the given point. * - * @param [in] pt The point. + * @param [in] pt The point. * - * @return The column containing the given point, if found. Otherwise null. + * @return The column containing the given point, if found. Otherwise null. */ GraphicsColumn* findColumnAt(QPointF pt); /*! * Called when a column is moved within the layout. * - * @param [in] column The column that has been moved. + * @param [in] column The column that has been moved. */ void onMoveColumn(GraphicsColumn* column); /*! * Called when a column is released from being moved by mouse. * - * @param [in] column The column that has been released. + * @param [in] column The column that has been released. */ void onReleaseColumn(GraphicsColumn* column); @@ -102,7 +102,7 @@ class GraphicsColumnLayout : public QObject /*! * Sets auto-reorganize on/off. * - * @param [in] autoReorganized If true, auto-reorganize is set on. + * @param [in] autoReorganized If true, auto-reorganize is set on. */ void setAutoReorganized(bool autoReorganized); @@ -119,7 +119,7 @@ class GraphicsColumnLayout : public QObject /*! * Sets the drawing offset for the title bars. * - * @param [in] y The y coordinate offset. + * @param [in] y The y coordinate offset. */ void setOffsetY(qreal y); diff --git a/common/graphicsItems/GraphicsColumnUndoCommands.h b/common/graphicsItems/GraphicsColumnUndoCommands.h index 5a12f9396..9b01e8d02 100644 --- a/common/graphicsItems/GraphicsColumnUndoCommands.h +++ b/common/graphicsItems/GraphicsColumnUndoCommands.h @@ -32,10 +32,10 @@ class GraphicsColumnMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] layout The column layout. - * @param [in] column The column to move. - * @param [in] oldPos The column's old position. - * @param [in] parent The parent command. + * @param [in] layout The column layout. + * @param [in] column The column to move. + * @param [in] oldPos The column's old position. + * @param [in] parent The parent command. */ GraphicsColumnMoveCommand(GraphicsColumnLayout* layout, GraphicsColumn* column, QPointF const& oldPos, QUndoCommand* parent = 0); @@ -86,9 +86,9 @@ class GraphicsColumnChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] column The column. - * @param [in] newDesc The column's new description. - * @param [in] diagram Diagram containing the scene of the column. + * @param [in] column The column. + * @param [in] newDesc The column's new description. + * @param [in] diagram Diagram containing the scene of the column. */ GraphicsColumnChangeCommand(GraphicsColumn* column, QSharedPointer newDesc, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -147,9 +147,9 @@ class GraphicsColumnResizeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] column The column. - * @param [in] oldWidth The column's old width. - * @param [in] diagram Diagram containing the scene of the column. + * @param [in] column The column. + * @param [in] oldWidth The column's old width. + * @param [in] diagram Diagram containing the scene of the column. */ GraphicsColumnResizeCommand(GraphicsColumn* column, unsigned int oldWidth, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -177,7 +177,7 @@ class GraphicsColumnResizeCommand : public QUndoCommand /*! * Change the width of the column. * - * @param [in] selectedWidth The new width for the column. + * @param [in] selectedWidth The new width for the column. */ void changeWidth(unsigned int selectedWidth); diff --git a/common/graphicsItems/GraphicsConnection.h b/common/graphicsItems/GraphicsConnection.h index e97aab9d2..394daae5c 100644 --- a/common/graphicsItems/GraphicsConnection.h +++ b/common/graphicsItems/GraphicsConnection.h @@ -68,21 +68,21 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Get the type of this connection. * - * @return HW connection. + * @return HW connection. */ virtual int type() const = 0; /*! * Sets the routing mode. * - * @param [in] mode The routing mode. + * @param [in] mode The routing mode. */ void setRoutingMode(RoutingMode mode); /*! * Sets the line width. * - * @param [in] width The line width in pixels. + * @param [in] width The line width in pixels. */ void setLineWidth(int width); @@ -99,7 +99,7 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso * is disconnected from the old endpoint and connected to the new given endpoint, updating the * route too. * - * @param [in] endpoint1 The first endpoint to set. + * @param [in] endpoint1 The first endpoint to set. */ void setEndpoint1(ConnectionEndpoint* endpoint1); @@ -108,7 +108,7 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso * is disconnected from the old endpoint and connected to the new given endpoint, updating the * route too. * - * @param [in] endpoint2 The second endpoint to set. + * @param [in] endpoint2 The second endpoint to set. */ void setEndpoint2(ConnectionEndpoint* endpoint2); @@ -132,7 +132,7 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Sets the routing of the connection. * - * @param [in] path The route to set. + * @param [in] path The route to set. */ void setRoute(QList path); @@ -164,30 +164,30 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Ends the position update of the connection and creates an undo command. * - * @param [in] parent The parent command. + * @param [in] parent The parent command. * - * @return The created (child) command. + * @return The created (child) command. */ QUndoCommand* endUpdatePosition(QUndoCommand* parent); /*! * Set the name for the connection. * - * @param [in] name The name to set for the connection. + * @param [in] name The name to set for the connection. */ virtual void setName(QString const& name); /*! * Sets the description for the connection. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ virtual void setDescription(QString const& /*description*/) {}; /*! * Sets the imported state. * - * @param [in] imported If true, the connection is an imported one. + * @param [in] imported If true, the connection is an imported one. */ void setImported(bool imported); @@ -229,7 +229,7 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Get the route of the connection. * - * @return The connection route. + * @return The connection route. */ QSharedPointer getRouteExtension() const; @@ -241,7 +241,7 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Set hovering flag indicating if the mouse is being hovered above the connection item. * - * @param [in] hovered Flag indicating if currently hovering. + * @param [in] hovered Flag indicating if currently hovering. */ void setHovered(bool hovered); @@ -260,17 +260,17 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Defines the connection point for associations in scene coordinates. * - * @param [in] otherEnd The position of the other end connection point. + * @param [in] otherEnd The position of the other end connection point. * - * @return The connection point of the item. + * @return The connection point of the item. */ virtual QPointF connectionPoint(QPointF const& otherEnd) const; /*! * Change the component reference of a contained interface. * - * @param [in] oldName The old component reference. - * @param [in] newName The new component reference. + * @param [in] oldName The old component reference. + * @param [in] newName The new component reference. */ virtual void changeConnectionComponentReference(QString const& oldName, QString const& newName); @@ -293,14 +293,14 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Called when the mouse starts to hover above the connection item. * - * @param [in] hoverEvent The hover event. + * @param [in] hoverEvent The hover event. */ virtual void hoverEnterEvent(QGraphicsSceneHoverEvent* hoverEvent); /*! * Called when the mouse stops hovering above the connection item. * - * @param [in] hoverEvent The hover event. + * @param [in] hoverEvent The hover event. */ virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent* hoverEvent); @@ -347,50 +347,50 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Draws specific helper graphics for overlapping graphics items. * - * @param [in] painter The painter. + * @param [in] painter The painter. */ void drawOverlapGraphics(QPainter* painter); /*! * Draws overlapping graphics with another connection. * - * @param [in] painter The painter to use. - * @param [in] connection The connection who overlaps with this. + * @param [in] painter The painter to use. + * @param [in] connection The connection who overlaps with this. */ void drawOverlapWithConnection(QPainter* painter, GraphicsConnection* connection); /*! * Draws an undercrossing with another connection. * - * @param [in] painter The painter to use. - * @param [in] path The segment of the connection intersecting with other connection. - * @param [in] crossingPoint The point where the connections intersect. - * @param [in] crossConnectionWidth The withd of the intersecting connection. + * @param [in] painter The painter to use. + * @param [in] path The segment of the connection intersecting with other connection. + * @param [in] crossingPoint The point where the connections intersect. + * @param [in] crossConnectionWidth The withd of the intersecting connection. */ void drawUndercrossing(QPainter* painter, QLineF const& path, QPointF const& crossingPoint, int crossConnectionWidth); /*! * Draws a junction point on the connection. * - * @param [in] painter The painter to use. - * @param [in] intersectionPoint The point where the connections intersect. + * @param [in] painter The painter to use. + * @param [in] intersectionPoint The point where the connections intersect. */ void drawJunctionPoint(QPainter* painter, QPointF const& intersectionPoint); /*! * Draws overlapping with a component item. * - * @param [in] painter The painter to use. - * @param [in] item The component item overlapping the connection. + * @param [in] painter The painter to use. + * @param [in] item The component item overlapping the connection. */ void drawOverlapWithComponent(QPainter* painter, QGraphicsItem* item); /*! * Draws a "gap" to a line with the currently selected pen. * - * @param [in] painter The painter. - * @param [in] line The line to which to draw the gap. - * @param [in] pt The intersection point where to draw the gap. + * @param [in] painter The painter. + * @param [in] line The line to which to draw the gap. + * @param [in] pt The intersection point where to draw the gap. */ void drawLineGap(QPainter* painter, QLineF const& line, QPointF const& pt); @@ -419,8 +419,8 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Creates segment bounds from the existing connections. * - * @param [out] verBounds The list of vertical segment bounds. - * @param [out] horizontalBounds The list of horizontal bounds. + * @param [out] verBounds The list of vertical segment bounds. + * @param [out] horizontalBounds The list of horizontal bounds. */ void createSegmentBounds(QList& verBounds, QList& horizontalBounds); @@ -442,105 +442,105 @@ class GraphicsConnection : public QObject, public QGraphicsPathItem, public Asso /*! * Retrieves the minimum and maximum X coordinates for the horizontal segment identified by index i. * - * @param [in] i The segment index. + * @param [in] i The segment index. * - * @return The limits for the segment. + * @return The limits for the segment. */ QPair getSegmentLimitsX(int i) const; /*! * Retrieves the minimum and maximum Y coordinates for the vertical segment identified by index i. * - * @param [in] i The segment index. + * @param [in] i The segment index. * - * @return The limits for the segment. + * @return The limits for the segment. */ QPair getSegmentLimitsY(int i) const; /*! * Searches for a vertical segment overlap. * - * @param [in] verBounds The collection of vertical segment bounds to test against. - * @param [in] bounds The vertical segment being tested for overlap. + * @param [in] verBounds The collection of vertical segment bounds to test against. + * @param [in] bounds The vertical segment being tested for overlap. * - * @return The index of the first found overlapping bound in the collection, or -1 if not found. + * @return The index of the first found overlapping bound in the collection, or -1 if not found. */ int findVerticalSegmentOverlap(QList const& verBounds, SegmentBound const& bounds); /*! * Fixes vertical segment overlap issues for the vertical segment identified by index i. * - * @param [in] verBounds The collection of vertical segment bounds to test against. - * @param [in] i The index of the segment to fix. + * @param [in] verBounds The collection of vertical segment bounds to test against. + * @param [in] i The index of the segment to fix. * - * @return True if modifications were made; false if nothing was changed. + * @return True if modifications were made; false if nothing was changed. */ bool fixVerticalSegmentClearance(QList const& verBounds, int i); /*! * Searches for a horizontal segment overlap. * - * @param [in] horBounds The collection of horizontal segment bounds to test against. - * @param [in] bounds The horizontal segment being tested for overlap. + * @param [in] horBounds The collection of horizontal segment bounds to test against. + * @param [in] bounds The horizontal segment being tested for overlap. * - * @return The index of the first found overlapping bound in the collection, or -1 if not found. + * @return The index of the first found overlapping bound in the collection, or -1 if not found. */ int findHorizontalSegmentOverlap(QList const& horBounds, SegmentBound const& bounds); /*! * Fixes horizontal segment overlap issues for the horizontal segment identified by index i. * - * @param [in] horBounds The collection of horizontal segment bounds to test against. - * @param [in] i The index of the segment to fix. + * @param [in] horBounds The collection of horizontal segment bounds to test against. + * @param [in] i The index of the segment to fix. * - * @return True if modifications were made; false if nothing was changed. + * @return True if modifications were made; false if nothing was changed. */ bool fixHorizontalSegmentClearance(QList const& horBounds, int i); /*! * Tests for horizontal overlap between two segment bounds. * - * @param [in] bound1 The first segment bound. - * @param [in] bound2 The second segment bound. + * @param [in] bound1 The first segment bound. + * @param [in] bound2 The second segment bound. * - * @return True if the bounds overlap by X coordinate. + * @return True if the bounds overlap by X coordinate. */ bool testSegmentOverlapX(SegmentBound const& bound1, SegmentBound const& bound2) const; /*! * Tests for vertical overlap between two segment bounds. * - * @param [in] bound1 The first segment bound. - * @param [in] bound2 The second segment bound. + * @param [in] bound1 The first segment bound. + * @param [in] bound2 The second segment bound. * - * @return True if the bounds overlap by Y coordinate. + * @return True if the bounds overlap by Y coordinate. */ bool testSegmentOverlapY(SegmentBound const& bound1, SegmentBound const& bound2) const; /*! * Updates the endpoint direction to given direction. * - * @param [in] endpoint The endpoint to update. - * @param [in] dir The direction to change to. + * @param [in] endpoint The endpoint to update. + * @param [in] dir The direction to change to. */ void updateEndpointDirection(ConnectionEndpoint* endpoint, QVector2D dir); /*! * Finds the point closest to the given point from a set of points. * - * @param [in] sourcePoints The points to search through. - * @param [in] destination The point get closest to. + * @param [in] sourcePoints The points to search through. + * @param [in] destination The point get closest to. * - * @return The point closest to destination. + * @return The point closest to destination. */ QPointF findClosestPoint(QList const& sourcePoints, QPointF const& destination) const; /*! * Creates lines connecting the given points. * - * @param [in] points The line endpoints. + * @param [in] points The line endpoints. * - * @return The lines connecting the given points. + * @return The lines connecting the given points. */ QList pointsToLines(QList const& points) const; diff --git a/common/graphicsItems/GraphicsLineEdit.h b/common/graphicsItems/GraphicsLineEdit.h index 6498da4be..2b604341c 100644 --- a/common/graphicsItems/GraphicsLineEdit.h +++ b/common/graphicsItems/GraphicsLineEdit.h @@ -26,7 +26,7 @@ class GraphicsLineEdit : public QGraphicsTextItem /*! * Constructor. * - * @param [in] parent The parent. + * @param [in] parent The parent. */ GraphicsLineEdit(QGraphicsItem* parent); @@ -38,7 +38,7 @@ class GraphicsLineEdit : public QGraphicsTextItem /*! * Sets the editor read only. * - * @param [in] readOnly True for read only. + * @param [in] readOnly True for read only. */ void setReadOnly(bool readOnly); diff --git a/common/graphicsItems/IGraphicsItemStack.h b/common/graphicsItems/IGraphicsItemStack.h index 69a78774c..8ee1161e6 100644 --- a/common/graphicsItems/IGraphicsItemStack.h +++ b/common/graphicsItems/IGraphicsItemStack.h @@ -31,29 +31,29 @@ class IGraphicsItemStack /*! * Adds an item to stack. * - * @param [in] item The item to add. - * @param [in] load If true, the item is being loaded from a design. + * @param [in] item The item to add. + * @param [in] load If true, the item is being loaded from a design. */ virtual void addItem(QGraphicsItem* item, bool load = false) = 0; /*! * Removes an item from the stack. * - * @param [in] item the item to remove. + * @param [in] item the item to remove. */ virtual void removeItem(QGraphicsItem* item) = 0; /*! * Called when an item is moved within the stack. * - * @param [in] item The item that has been moved. + * @param [in] item The item that has been moved. */ virtual void onMoveItem(QGraphicsItem* item) = 0; /*! * Called when an item is released from being moved by mouse. * - * @param [in] item The item that has been released. + * @param [in] item The item that has been released. */ virtual void onReleaseItem(QGraphicsItem* item) = 0; @@ -75,7 +75,7 @@ class IGraphicsItemStack /*! * Returns true if the stack is allowed to contain the given item. * - * @param [in] item The item to test for. + * @param [in] item The item to test for. */ virtual bool isItemAllowed(QGraphicsItem* item) const = 0; diff --git a/common/graphicsItems/expandableitem.h b/common/graphicsItems/expandableitem.h index c874fd341..c25f6a7d5 100644 --- a/common/graphicsItems/expandableitem.h +++ b/common/graphicsItems/expandableitem.h @@ -50,7 +50,7 @@ class ExpandableItem : public AddressableItem { /*! Get the rectangle reserved by this item and it's sub-items recursively. * - * @return The rectangle of this item and sub-items and their children recursively. + * @return The rectangle of this item and sub-items and their children recursively. */ virtual QRectF itemTotalRect() const = 0; @@ -82,7 +82,7 @@ protected slots: /*! * Sets the default coloring brush for the item. * - * @param [in] brush The brush to set. + * @param [in] brush The brush to set. */ void setDefaultBrush(QBrush brush) final; @@ -100,7 +100,7 @@ protected slots: /*! * Update the expand arrow direction based on expansion state. * - * @param [in] expanded Indicates if the item is expanded or not. + * @param [in] expanded Indicates if the item is expanded or not. */ void updateExpandArrow(bool expanded); diff --git a/common/graphicsItems/graphicsexpandcollapseitem.h b/common/graphicsItems/graphicsexpandcollapseitem.h index d85197622..eeae0f78d 100644 --- a/common/graphicsItems/graphicsexpandcollapseitem.h +++ b/common/graphicsItems/graphicsexpandcollapseitem.h @@ -37,7 +37,7 @@ class GraphicsExpandCollapseItem : public QObject, public QGraphicsRectItem /*! * The constructor. * - * @param [in] parent Pointer to the owner of this graphics item. + * @param [in] parent Pointer to the owner of this graphics item. */ GraphicsExpandCollapseItem(QGraphicsItem* parent = 0); @@ -56,7 +56,7 @@ class GraphicsExpandCollapseItem : public QObject, public QGraphicsRectItem /*! * Check if the item is in expanded state. * - * @return True if the item is in expanded state. + * @return True if the item is in expanded state. */ virtual bool isExpanded() const; @@ -66,7 +66,7 @@ class GraphicsExpandCollapseItem : public QObject, public QGraphicsRectItem /*! * Check if the item is in collapsed state. * - * @return True if the item is in collapsed state. + * @return True if the item is in collapsed state. */ virtual bool isCollapsed() const; @@ -83,7 +83,7 @@ class GraphicsExpandCollapseItem : public QObject, public QGraphicsRectItem * This is emitted only when user clicks on the item. * The expand() and collapse() functions do not emit this signal. * - * @param [in] expanded True if the item changed to expanded state. + * @param [in] expanded True if the item changed to expanded state. */ void stateChanged(bool expanded); diff --git a/common/graphicsItems/visualizeritem.h b/common/graphicsItems/visualizeritem.h index 0b0fcaa04..79b877cb3 100644 --- a/common/graphicsItems/visualizeritem.h +++ b/common/graphicsItems/visualizeritem.h @@ -50,7 +50,7 @@ class VisualizerItem : public QObject, public QGraphicsRectItem /*! The constructor. * - * @param parent Pointer to the owner of this graphics item. + * @param parent Pointer to the owner of this graphics item. * */ explicit VisualizerItem(QGraphicsItem* parent = nullptr); @@ -66,13 +66,13 @@ class VisualizerItem : public QObject, public QGraphicsRectItem /*! Get the displayed name of the object. * - * @return The name of the object. + * @return The name of the object. */ virtual QString name() const; /*! Set the width for the item. * - * @param width The new width of the item. + * @param width The new width of the item. * */ virtual void setWidth(qreal width); @@ -81,14 +81,14 @@ class VisualizerItem : public QObject, public QGraphicsRectItem * * The width is dependent on the parents width. * - * @return The width of the item and it's sub-items. + * @return The width of the item and it's sub-items. */ virtual qreal itemTotalWidth() const; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const; @@ -104,21 +104,21 @@ protected slots: /*! Set the display name of the item. * - * @param name The name to display. + * @param name The name to display. * */ void setName(QString const& name); /*! Set text to the top left corner. * - * @param text The text to display in the corner. + * @param text The text to display in the corner. * */ virtual void setTopLabelText(QString const& text); /*! Set text to the bottom left corner. * - * @param text The text to display in the corner. + * @param text The text to display in the corner. * */ virtual void setBottomLabelText(QString const& text); @@ -126,35 +126,35 @@ protected slots: /*! * Set how the text labels are positioned within the item. * - * @param [in] labelLayout The positioning style to set. + * @param [in] labelLayout The positioning style to set. */ void setLayoutType(VisualizerItem::LabelLayout labelLayout); /*! * Set the text labels contents to be shortened, if the label cannot fit within the item. * - * @param [in] enableClip If true, text is shortened, otherwise not. + * @param [in] enableClip If true, text is shortened, otherwise not. */ void setClipText(bool enableClip); /*! Get the minimum rectangle of the item. * - * @return The minimum size needed by this item. + * @return The minimum size needed by this item. */ virtual QRectF minimumRect() const; /*! * Sets the default coloring brush for the item. * - * @param [in] brush The brush to set. + * @param [in] brush The brush to set. */ virtual void setDefaultBrush(QBrush brush); /*! * Gets the default coloring brush for the item. * - * @return [in] brush The default brush. + * @return [in] brush The default brush. */ QBrush defaultBrush() const; @@ -179,10 +179,10 @@ protected slots: /*! If text is longer than maxChars, cuts the length to maxChars is and appends "...". * - * @param text The text to clip. - * @param maxChars Maximum number of characters to show. + * @param text The text to clip. + * @param maxChars Maximum number of characters to show. * - * @return The string with maximum length of maxChars. + * @return The string with maximum length of maxChars. */ QString clipText(QString const& text, int maxChars) const; diff --git a/common/layouts/HCollisionLayout.h b/common/layouts/HCollisionLayout.h index 2982ab705..99a6c04c5 100644 --- a/common/layouts/HCollisionLayout.h +++ b/common/layouts/HCollisionLayout.h @@ -22,7 +22,7 @@ class HCollisionLayout : public IHGraphicsLayout /*! * Constructor. * - * @param [in] spacing The spacing. + * @param [in] spacing The spacing. */ HCollisionLayout(qreal spacing); @@ -34,9 +34,9 @@ class HCollisionLayout : public IHGraphicsLayout /*! * Updates the positions of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minY The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minY The minimum x coordinate. * * @remarks The list of items is assumed to initially have correct top-bottom * ordering and positioning. @@ -46,19 +46,19 @@ class HCollisionLayout : public IHGraphicsLayout /*! * Sets the position of an item according to the collision-based layout. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] x The y coordinate for the item's position. - * @param [in] minY The minimum x coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] x The y coordinate for the item's position. + * @param [in] minY The minimum x coordinate. */ void setItemPos(QList const& items, T* item, qreal y, qreal minX = 0.0); /*! * Updates the positions of all items using horizontal stacking. * - * @param [in] items The list of items. - * @param [in] x The y coordinate for the items. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] x The y coordinate for the items. + * @param [in] minX The minimum x coordinate. */ void updateItemPositions(QList& items, qreal y, qreal minX = 0.0); diff --git a/common/layouts/HStackedLayout.h b/common/layouts/HStackedLayout.h index 1ebeefb3c..d449505e3 100644 --- a/common/layouts/HStackedLayout.h +++ b/common/layouts/HStackedLayout.h @@ -38,9 +38,9 @@ class HStackedLayout : public IHGraphicsLayout /*! * Updates the horizontal stacking of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minX The minimum x coordinate. * * @remarks The list of items is assumed to initially have correct left-right ordering and * positioning. @@ -50,19 +50,19 @@ class HStackedLayout : public IHGraphicsLayout /*! * Sets the position of an item based on its index in the list using horizontal stacking. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] y The y coordinate for the item's position. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] y The y coordinate for the item's position. + * @param [in] minX The minimum x coordinate. */ void setItemPos(QList const& items, T* item, qreal y, qreal minX = 0.0); /*! * Updates the positions of all items using horizontal stacking. * - * @param [in] items The list of items. - * @param [in] x The y coordinate for the items. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] x The y coordinate for the items. + * @param [in] minX The minimum x coordinate. */ void updateItemPositions(QList& items, qreal y, qreal minX = 0.0); diff --git a/common/layouts/IHGraphicsLayout.h b/common/layouts/IHGraphicsLayout.h index 67cf46861..8fa6fa341 100644 --- a/common/layouts/IHGraphicsLayout.h +++ b/common/layouts/IHGraphicsLayout.h @@ -29,9 +29,9 @@ class IHGraphicsLayout /*! * Updates the horizontal stacking of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minX The minimum x coordinate. * * @remarks The list of items is assumed to initially have correct left-right ordering and * positioning. @@ -41,19 +41,19 @@ class IHGraphicsLayout /*! * Sets the position of an item based on its index in the list using horizontal stacking. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] y The y coordinate for the item's position. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] y The y coordinate for the item's position. + * @param [in] minX The minimum x coordinate. */ virtual void setItemPos(QList const& items, T* item, qreal y, qreal minX = 0.0) = 0; /*! * Updates the positions of all items using horizontal stacking. * - * @param [in] items The list of items. - * @param [in] x The y coordinate for the items. - * @param [in] minX The minimum x coordinate. + * @param [in] items The list of items. + * @param [in] x The y coordinate for the items. + * @param [in] minX The minimum x coordinate. */ virtual void updateItemPositions(QList& items, qreal y, qreal minX = 0.0) = 0; }; diff --git a/common/layouts/IVGraphicsLayout.h b/common/layouts/IVGraphicsLayout.h index b953c5906..2b99b4755 100644 --- a/common/layouts/IVGraphicsLayout.h +++ b/common/layouts/IVGraphicsLayout.h @@ -29,9 +29,9 @@ class IVGraphicsLayout /*! * Updates the vertical stacking of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minY The minimum y coordinate. * * @remarks The list of items is assumed to initially have correct left-right ordering and * positioning. @@ -41,19 +41,19 @@ class IVGraphicsLayout /*! * Sets the position of an item based on its index in the list using vertical stacking. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] x The x coordinate for the item's position. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] x The x coordinate for the item's position. + * @param [in] minY The minimum y coordinate. */ virtual void setItemPos(QList const& items, T* item, qreal x, qreal minY = 0.0) = 0; /*! * Updates the positions of all items using vertical stacking. * - * @param [in] items The list of items. - * @param [in] x The x coordinate for the items. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] x The x coordinate for the items. + * @param [in] minY The minimum y coordinate. */ virtual void updateItemPositions(QList& items, qreal x, qreal minY = 0.0) = 0; }; diff --git a/common/layouts/VCollisionLayout.h b/common/layouts/VCollisionLayout.h index 8196ec49f..237de08b7 100644 --- a/common/layouts/VCollisionLayout.h +++ b/common/layouts/VCollisionLayout.h @@ -24,7 +24,7 @@ class VCollisionLayout : public IVGraphicsLayout /*! * Constructor. * - * @param [in] spacing The spacing between items. + * @param [in] spacing The spacing between items. */ VCollisionLayout(qreal spacing = 0.0); @@ -36,9 +36,9 @@ class VCollisionLayout : public IVGraphicsLayout /*! * Updates the positions of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minY The minimum y coordinate. * * @remarks The list of items is assumed to initially have correct top-bottom * ordering and positioning. @@ -48,19 +48,19 @@ class VCollisionLayout : public IVGraphicsLayout /*! * Sets the position of an item according to the collision-based layout. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] x The x coordinate for the item's position. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] x The x coordinate for the item's position. + * @param [in] minY The minimum y coordinate. */ void setItemPos(QList const& items, T* item, qreal x, qreal minY = 0.0); /*! * Updates the positions of all items using vertical stacking. * - * @param [in] items The list of items. - * @param [in] x The x coordinate for the items. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] x The x coordinate for the items. + * @param [in] minY The minimum y coordinate. */ void updateItemPositions(QList& items, qreal x, qreal minY = 0.0); diff --git a/common/layouts/VStackedLayout.h b/common/layouts/VStackedLayout.h index 3a889c0d3..8b1ef800b 100644 --- a/common/layouts/VStackedLayout.h +++ b/common/layouts/VStackedLayout.h @@ -26,7 +26,7 @@ class VStackedLayout : public IVGraphicsLayout /*! * Constructor. * - * @param [in] spacing The spacing between items. + * @param [in] spacing The spacing between items. */ VStackedLayout(qreal spacing); @@ -38,9 +38,9 @@ class VStackedLayout : public IVGraphicsLayout /*! * Updates the vertical stacking of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minY The minimum y coordinate. * * @remarks The list of items is assumed to initially have correct left-right ordering and * positioning. @@ -50,19 +50,19 @@ class VStackedLayout : public IVGraphicsLayout /*! * Sets the position of an item based on its index in the list using vertical stacking. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] x The x coordinate for the item's position. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] x The x coordinate for the item's position. + * @param [in] minY The minimum y coordinate. */ void setItemPos(QList const& items, T* item, qreal x, qreal minY = 0.0); /*! * Updates the positions of all items using vertical stacking. * - * @param [in] items The list of items. - * @param [in] x The x coordinate for the items. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] x The x coordinate for the items. + * @param [in] minY The minimum y coordinate. */ void updateItemPositions(QList& items, qreal x, qreal minY = 0.0); diff --git a/common/layouts/VStaticLayout.h b/common/layouts/VStaticLayout.h index 921993c2a..0609e0e42 100644 --- a/common/layouts/VStaticLayout.h +++ b/common/layouts/VStaticLayout.h @@ -24,7 +24,7 @@ class VStaticLayout : public IVGraphicsLayout /*! * Constructor. * - * @param [in] spacing The spacing between items. + * @param [in] spacing The spacing between items. */ VStaticLayout(qreal spacing = 0.0); @@ -36,9 +36,9 @@ class VStaticLayout : public IVGraphicsLayout /*! * Updates the positions of the items when one item is being moved. * - * @param [in] items The list of items. - * @param [in] item The item that is being moved. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] item The item that is being moved. + * @param [in] minY The minimum y coordinate. * * @remarks The list of items is assumed to initially have correct top-bottom * ordering and positioning. @@ -48,19 +48,19 @@ class VStaticLayout : public IVGraphicsLayout /*! * Sets the position of an item according to the layout. * - * @param [in] items The list of items. Assumed to be already in correct order. - * @param [in] item The item to position. - * @param [in] x The x coordinate for the item's position. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. Assumed to be already in correct order. + * @param [in] item The item to position. + * @param [in] x The x coordinate for the item's position. + * @param [in] minY The minimum y coordinate. */ void setItemPos(QList const& items, T* item, qreal x, qreal minY = 0.0); /*! * Updates the positions of all items using. * - * @param [in] items The list of items. - * @param [in] x The x coordinate for the items. - * @param [in] minY The minimum y coordinate. + * @param [in] items The list of items. + * @param [in] x The x coordinate for the items. + * @param [in] minY The minimum y coordinate. */ void updateItemPositions(QList& items, qreal x, qreal minY = 0.0); diff --git a/common/views/EditableListView/editablelistview.h b/common/views/EditableListView/editablelistview.h index f83b94a79..d0e548baf 100644 --- a/common/views/EditableListView/editablelistview.h +++ b/common/views/EditableListView/editablelistview.h @@ -30,7 +30,7 @@ class EditableListView : public QListView /*! * The constructor. * - * @param [in] parent The owner of this view. + * @param [in] parent The owner of this view. */ EditableListView(QWidget *parent); @@ -49,22 +49,22 @@ class EditableListView : public QListView /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void addItem(QModelIndex const& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void removeItem(QModelIndex const& index); /*! * Move item to another position. * - * @param [in] originalPos Identifies the item that should be moved. - * @param [in] newPos The new position the item should be moved to. + * @param [in] originalPos Identifies the item that should be moved. + * @param [in] newPos The new position the item should be moved to. */ void moveItem(QModelIndex const& originalPos, QModelIndex const& newPos); @@ -73,57 +73,57 @@ class EditableListView : public QListView /*! * Handler for paint events. * - * @param [in] event The paint event. + * @param [in] event The paint event. */ virtual void paintEvent(QPaintEvent *event); /*! * Handler for mouse move events * - * @param [in] event The mouse movement event. + * @param [in] event The mouse movement event. */ virtual void mouseMoveEvent(QMouseEvent* event); /*! * Handler for mouse double click events * - * @param [in] event The double click event. + * @param [in] event The double click event. */ virtual void mouseDoubleClickEvent(QMouseEvent* event); /*! * Handler for mouse press events * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ virtual void mousePressEvent(QMouseEvent* event); /*! * Handler for mouse release events * - * @param [in] event The mouse release event. + * @param [in] event The mouse release event. */ virtual void mouseReleaseEvent(QMouseEvent* event); /*! * Handler for context menu events * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event); /*! * Handler for key press events. * - * @param [in] event The key press event. + * @param [in] event The key press event. */ virtual void keyPressEvent(QKeyEvent *event); /*! * Handler for changes in current selection. * - * @param [in] current The current model index. - * @param [in] previous The previous model index. + * @param [in] current The current model index. + * @param [in] previous The previous model index. */ virtual void currentChanged(const QModelIndex ¤t, const QModelIndex &previous); diff --git a/common/views/EditableTableView/editabletableview.h b/common/views/EditableTableView/editabletableview.h index 6dfa66e74..bcbbe9333 100644 --- a/common/views/EditableTableView/editabletableview.h +++ b/common/views/EditableTableView/editabletableview.h @@ -39,7 +39,7 @@ class EditableTableView : public QTableView /*! * The constructor. * - * @param [in] parent Pointer to the owner of this view. + * @param [in] parent Pointer to the owner of this view. */ EditableTableView(QWidget *parent); @@ -51,42 +51,42 @@ class EditableTableView : public QTableView /*! * Enable/disable the import/export csv file functionality. * - * @param [in] allow If true then import/export is enabled. + * @param [in] allow If true then import/export is enabled. */ virtual void setAllowImportExport(bool allow); /*! * Checks if import and export are allowed in the table. * - * @return True, if import and export are allowed, otherwise false. + * @return True, if import and export are allowed, otherwise false. */ bool importExportAllowed() const; /*! * Enable / disable the element copying. * - * @param [in] allow If true, element copying is allowed. + * @param [in] allow If true, element copying is allowed. */ void setAllowElementCopying(bool allow); /*! * Set the model class for this view. * - * @param [in] model The model displayed by this view. + * @param [in] model The model displayed by this view. */ virtual void setModel(QAbstractItemModel* model); /*! * Sets the text visible in the corner button. Both headers must be visible for the text to show. * - * @param [in] text The text to set. + * @param [in] text The text to set. */ void setCornerButtonText(QString const& text); /*! * Sets if the column sizes are fit to content at model load. * - * @param [in] fit To fit or not. + * @param [in] fit To fit or not. */ void setFitColumnsToContent(bool fit); @@ -95,28 +95,28 @@ public slots: /*! * Set the items in the view to be draggable or not. * - * @param [in] draggable If true the positions of the items can change by dragging. + * @param [in] draggable If true the positions of the items can change by dragging. */ void setItemsDraggable(bool draggable); /*! * Create a csv-file of the editor contents. * - * @param [in] filePath Contains an absolute file path to the file to create. + * @param [in] filePath Contains an absolute file path to the file to create. */ void onCSVExport(const QString& filePath = QString()); /*! * Import contents of a csv-file to the editor. * - * @param [in] filePath The path to the csv-file to import. + * @param [in] filePath The path to the csv-file to import. */ void onCSVImport(const QString& filePath = QString()); /*! * Set the default path to use for import/export csv. * - * @param [in] path The path to use as default. + * @param [in] path The path to use as default. */ virtual void setDefaultImportExportPath(const QString& path); @@ -125,7 +125,7 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void addItem(const QModelIndex& index); @@ -139,15 +139,15 @@ public slots: /*! * Move item to another position. * - * @param [in] originalPos Identifies the item that should be moved. - * @param [in] newPos The new position the item should be moved to. + * @param [in] originalPos Identifies the item that should be moved. + * @param [in] newPos The new position the item should be moved to. */ void moveItem(const QModelIndex& originalPos, const QModelIndex& newPos); /*! * Copy the selected rows. * - * @param [in] indexList List of selected indexes containing the copied rows. + * @param [in] indexList List of selected indexes containing the copied rows. */ void copyRows(QModelIndexList indexList); @@ -176,42 +176,42 @@ public slots: /*! * Adds basic actions for the context menu (add, remove, clear, cut, copy, paste). * - * @param [in] menu Menu containing the actions. - * @param [in] index Index of the item at the context menu event position. + * @param [in] menu Menu containing the actions. + * @param [in] index Index of the item at the context menu event position. */ void addBasicActionsForContextMenu(QMenu& menu, QModelIndex const& index); /*! * Add actions for copying and pasting elements to the context menu. * - * @param [in] menu Menu containing the actions. - * @param [in] index Index of the item at the context menu event position. + * @param [in] menu Menu containing the actions. + * @param [in] index Index of the item at the context menu event position. */ void addElementCopyActionForContextMenu(QMenu& menu, QModelIndex const& index); /*! * Add actions for importing and exporting to the context menu. * - * @param [in] menu Menu containing the actions. + * @param [in] menu Menu containing the actions. */ void addImportExportActionsForContextMenu(QMenu& menu); /*! * Counts the number of rows in a list of indexes. * - * @param [in] indexes The indexes to count. + * @param [in] indexes The indexes to count. * - * @return The number of rows in the indexes. + * @return The number of rows in the indexes. */ int countRows(QModelIndexList const& indexes); /*! * Handler for intercepting events. * - * @param [in] target The target for the event. - * @param [in] event The event to intercept or pass to target. + * @param [in] target The target for the event. + * @param [in] event The event to intercept or pass to target. * - * @return True, if the event is filtered and not passed to target, otherwise false. + * @return True, if the event is filtered and not passed to target, otherwise false. */ virtual bool eventFilter(QObject* target, QEvent* event); @@ -295,9 +295,9 @@ protected slots: /*! * Generates a unique name within the table for the item. * - * @param [in] original The original name of the item. + * @param [in] original The original name of the item. * - * @return Unique name for the item. + * @return Unique name for the item. */ QString getUniqueName(QString const& original); diff --git a/common/views/EditableTreeView/EditableTreeSortFilter.h b/common/views/EditableTreeView/EditableTreeSortFilter.h index 9ae0bb1e6..0f23fe871 100644 --- a/common/views/EditableTreeView/EditableTreeSortFilter.h +++ b/common/views/EditableTreeView/EditableTreeSortFilter.h @@ -27,7 +27,7 @@ class EditableTreeSortFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] parent Parent object. + * @param [in] parent Parent object. */ EditableTreeSortFilter(QObject* parent); @@ -45,28 +45,28 @@ public slots: /*! * Handle the item addition. * - * @param [in] indexes Indexes the selected items. + * @param [in] indexes Indexes the selected items. */ void onAddItem(QModelIndexList const& indexes); /*! * Handle the sub item addition. * - * @param [in] parentIndexes Indexes of the selected parent. + * @param [in] parentIndexes Indexes of the selected parent. */ void onAddSubItem(QModelIndexList const& parentIndexes); /*! * Handle the item removal. * - * @param [in] indexes Indexes of the selected items. + * @param [in] indexes Indexes of the selected items. */ void onRemoveSelectedRows(QModelIndexList const& indexes); /*! * Handle the removal of the sub items of the selected item. * - * @param [in] parentIndexes Indexes of the selected items. + * @param [in] parentIndexes Indexes of the selected items. */ void onRemoveAllSubItemsFromIndexes(QModelIndexList const& parentIndexes); @@ -75,28 +75,28 @@ public slots: /*! * Add a new item to the selected index position. * - * @param [in] newItemIndex The selected index. + * @param [in] newItemIndex The selected index. */ void addItem(QModelIndex const& newItemIndex); /*! * Add a new sub item to the selected parent item. * - * @param [in] parentItemIndex Index of the selected parent item. + * @param [in] parentItemIndex Index of the selected parent item. */ void addSubItem(QModelIndex const& parentItemIndex); /*! * Remove the selected item. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. */ void removeItem(QModelIndex const& itemIndex); /*! * Remove all of the sub items contained within the selected item. * - * @param [in] itemIndex Index of the selected parent item. + * @param [in] itemIndex Index of the selected parent item. */ void removeAllSubItemsFromIndex(QModelIndex const& itemIndex); @@ -105,28 +105,28 @@ public slots: /*! * Change the selected index list To have indexes only from the first column. * - * @param [in] indexes The selected index list. + * @param [in] indexes The selected index list. * - * @return List of indexes from the first column. + * @return List of indexes from the first column. */ QModelIndexList concatIndexesToOneColumn(QModelIndexList const& indexes) const; /*! * Removes child indexes that have parent indexes in the selected index list. * - * @param [in] indexes The selected index list. + * @param [in] indexes The selected index list. * - * @return List of removable indexes. + * @return List of removable indexes. */ QModelIndexList getRemovableIndexes(QModelIndexList const& indexes) const; /*! * Check if the selected index is removable in the selected index list. * - * @param [in] index The selected index. - * @param [in] indexList List of the comparison indexes. + * @param [in] index The selected index. + * @param [in] indexList List of the comparison indexes. * - * @return True, if the selected index is removable, false otherwise. + * @return True, if the selected index is removable, false otherwise. */ bool indexIsRemovable(QModelIndex const& index, QModelIndexList indexList) const; }; diff --git a/common/views/EditableTreeView/EditableTreeView.h b/common/views/EditableTreeView/EditableTreeView.h index ce7430279..4aec2c461 100644 --- a/common/views/EditableTreeView/EditableTreeView.h +++ b/common/views/EditableTreeView/EditableTreeView.h @@ -30,12 +30,12 @@ class EditableTreeView : public QTreeView /*! * The constructor. * - * @param [in] allowNewRows Flag for allowing new items to be added. - * @param [in] addItemText Text for adding new items. - * @param [in] addSubItemText Text for adding new sub items. - * @param [in] removeItemText Text for removing items. - * @param [in] removeSubItemsText Text for removing all sub items. - * @param [in] parent The owner of this view. + * @param [in] allowNewRows Flag for allowing new items to be added. + * @param [in] addItemText Text for adding new items. + * @param [in] addSubItemText Text for adding new sub items. + * @param [in] removeItemText Text for removing items. + * @param [in] removeSubItemsText Text for removing all sub items. + * @param [in] parent The owner of this view. */ EditableTreeView(bool allowNewRows, QString const& addItemText, QString const& addSubItemText, QString const& removeItemText, QString const& removeSubItemsText, QWidget* parent); @@ -50,28 +50,28 @@ class EditableTreeView : public QTreeView /*! * Add items to the selected indexes. * - * @param [in] indexes The selected indexes. + * @param [in] indexes The selected indexes. */ void addItems(QModelIndexList const& indexes); /*! * Add sub items to the selected indexes. * - * @param [in] indexes The selected indexes. + * @param [in] indexes The selected indexes. */ void addSubItem(QModelIndexList const& indexes); /*! * Emitted when the user attempts to remove an item. * - * @param [in] index The indexes of the item to be removed. + * @param [in] index The indexes of the item to be removed. */ void removeSelectedItems(QModelIndexList const& indexes); /*! * Emitted when the user attempts to remove all sub items from the selected items. * - * @param [in] index The indexes of the items whose sub items are removed. + * @param [in] index The indexes of the items whose sub items are removed. */ void removeAllSubItems(QModelIndexList const& indexes); @@ -80,16 +80,16 @@ class EditableTreeView : public QTreeView /*! * Handle the double click. * - * @param [in] event The mouse event. + * @param [in] event The mouse event. */ virtual void mouseDoubleClickEvent(QMouseEvent* event) override; /*! * Draws a row and. * - * @param [in] painter The painter used for the drawing. - * @param [in] option Options for the drawing. - * @param [in] index Index of the item to draw. + * @param [in] painter The painter used for the drawing. + * @param [in] option Options for the drawing. + * @param [in] index Index of the item to draw. */ virtual void drawRow(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const override; @@ -97,56 +97,56 @@ class EditableTreeView : public QTreeView /*! * Handler for context menu events. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event) override; /*! * Gets the action for adding items. * - * @return The add item action. + * @return The add item action. */ QAction* getAddItemAction() const; /*! * Gets the action for adding sub items. * - * @return The add sub item action. + * @return The add sub item action. */ QAction* getAddSubItemAction() const; /*! * Gets the action for the remove command. * - * @return The action for the remove command. + * @return The action for the remove command. */ QAction* getRemoveAction() const; /*! * Gets the action for removing all sub items. * - * @return The remove all sub items action. + * @return The remove all sub items action. */ QAction* getRemoveAllSubItemsAction() const; /*! * Gets the action for clearing an item. * - * @return The clear item action. + * @return The clear item action. */ QAction* getClearAction() const; /*! * Gets the action for displaying all child items of an item. * - * @return The expand all item action. + * @return The expand all item action. */ QAction* getExpandAllAction() const; /*! * Gets the action for hiding all child items of an item. * - * @return The collapse all item action. + * @return The collapse all item action. */ QAction* getCollapseAllAction() const; @@ -186,10 +186,10 @@ protected slots: /*! * Setup the actions. * - * @param [in] addItemText Text for adding new items. - * @param [in] addSubItemText Text for adding new sub items. - * @param [in] removeItemText Text for removing items. - * @param [in] removeSubItemsText Text for removing all sub items. + * @param [in] addItemText Text for adding new items. + * @param [in] addSubItemText Text for adding new sub items. + * @param [in] removeItemText Text for removing items. + * @param [in] removeSubItemsText Text for removing all sub items. */ void setupActions(QString const& addItemText, QString const& addSubItemText, QString const& removeItemText, QString const& removeSubItemsText); diff --git a/common/views/ExpandingTreeView/ExpandingTreeView.h b/common/views/ExpandingTreeView/ExpandingTreeView.h index b99e1f6e9..5484907c8 100644 --- a/common/views/ExpandingTreeView/ExpandingTreeView.h +++ b/common/views/ExpandingTreeView/ExpandingTreeView.h @@ -36,7 +36,7 @@ private slots: /*! * Expand the tree until first branch i.e. index with more than one children is found. * - * @param [in] index The starting index for expanding. + * @param [in] index The starting index for expanding. */ void expandUntilFirstBranch(QModelIndex const& index); }; diff --git a/common/widgets/DirectoryListSelector/DirectoryListSelector.h b/common/widgets/DirectoryListSelector/DirectoryListSelector.h index cddfc32a3..9b131b062 100644 --- a/common/widgets/DirectoryListSelector/DirectoryListSelector.h +++ b/common/widgets/DirectoryListSelector/DirectoryListSelector.h @@ -33,9 +33,9 @@ class DirectoryListSelector : public QWidget /*! * Constructor. * - * @param [in] basePath The path to base directory. - * @param [in] initialDirs The current list of directories. - * @param [in] parent The parent widget. + * @param [in] basePath The path to base directory. + * @param [in] initialDirs The current list of directories. + * @param [in] parent The parent widget. */ DirectoryListSelector(QString const& basePath = QString(), QStringList const& initialDirs = QStringList(), @@ -49,28 +49,28 @@ class DirectoryListSelector : public QWidget /*! * Sets a directory non-removable. * - * @param [in] directory The directory to set. + * @param [in] directory The directory to set. */ void setPersistentDirectory(QString const& directory); /*! * Sets a directory removable. * - * @param [in] directory The directory to set. + * @param [in] directory The directory to set. */ void removePersistentDirectory(QString const& directory); /*! * Gets the list of non-removable directories. * - * @return List of non-removable directories. + * @return List of non-removable directories. */ QStringList getPersistentDirectories() const; /*! * Retrieves the list of directories. * - * @return The list of directories. + * @return The list of directories. */ QStringList getDirectories() const; diff --git a/common/widgets/EnumCollectionEditor/EnumCollectionEditor.h b/common/widgets/EnumCollectionEditor/EnumCollectionEditor.h index ff4fe73f3..eff56a7f8 100644 --- a/common/widgets/EnumCollectionEditor/EnumCollectionEditor.h +++ b/common/widgets/EnumCollectionEditor/EnumCollectionEditor.h @@ -27,7 +27,7 @@ class EnumCollectionEditor : public QWidget /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ EnumCollectionEditor(QWidget* parent); @@ -39,9 +39,9 @@ class EnumCollectionEditor : public QWidget /*! * Adds a new enumerable item to the editor. * - * @param [in] text The name of the item. - * @param [in] isExclusivePort Flag for exclusive ports. - * @param [in] selected If true, the item is initially selected. + * @param [in] text The name of the item. + * @param [in] isExclusivePort Flag for exclusive ports. + * @param [in] selected If true, the item is initially selected. */ void addItem(QString const& text, bool isExclusivePort, bool selected); @@ -55,7 +55,7 @@ class EnumCollectionEditor : public QWidget /*! * Change the state of all the enumerations. * - * @param [in] newState New state for the enumerations. + * @param [in] newState New state for the enumerations. */ void changeStatesOfAllItems(bool newState); @@ -64,7 +64,7 @@ class EnumCollectionEditor : public QWidget /*! * Inform of a change in the combined state of the enumerations. * - * @param [in] newState Combined state of the enumerations. + * @param [in] newState Combined state of the enumerations. */ void itemStateChanged(Qt::CheckState newState); @@ -80,14 +80,14 @@ private slots: /*! * Handle the state change in enumeration check box. * - * @param [in] newState New state of the enumeration check box. + * @param [in] newState New state of the enumeration check box. */ void onItemClicked(bool newState); /*! * Handle the state change in an exclusive enumeration check box. * - * @param [in] newState New state of the exclusive enumeration check box. + * @param [in] newState New state of the exclusive enumeration check box. */ void onExclusiveItemClicked(bool newState); @@ -99,17 +99,17 @@ private slots: /*! * Create an enumeration check box. * - * @param [in] text The name of the item. - * @param [in] selected If true, the item is initially selected. + * @param [in] text The name of the item. + * @param [in] selected If true, the item is initially selected. * - * @return The created enumeration check box. + * @return The created enumeration check box. */ QCheckBox* createCheckBox(QString const& text, bool isSelected); /*! * Handle the change in the state of the check all check box. * - * @param [in] newState New state of the item initiating this change. + * @param [in] newState New state of the item initiating this change. */ void handleCheckAllStateChangeFromItemClick(bool newState); diff --git a/common/widgets/EnumCollectionEditor/EnumerationEditor.h b/common/widgets/EnumCollectionEditor/EnumerationEditor.h index e22a255ac..0a28af771 100644 --- a/common/widgets/EnumCollectionEditor/EnumerationEditor.h +++ b/common/widgets/EnumCollectionEditor/EnumerationEditor.h @@ -28,8 +28,8 @@ class EnumerationEditor : public QFrame /*! * Constructor. * - * @param [in] hideCheckAll Flag for hiding the check all enumerations check box. - * @param [in] parent The parent widget. + * @param [in] hideCheckAll Flag for hiding the check all enumerations check box. + * @param [in] parent The parent widget. */ EnumerationEditor(bool hideCheckAll, QWidget* parent); @@ -46,9 +46,9 @@ class EnumerationEditor : public QFrame /*! * Setup the list of selected enumerations. * - * @param [in] availableItems List of the available enumerations. - * @param [in] exclusiveItems List of exclusive enumerations. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] availableItems List of the available enumerations. + * @param [in] exclusiveItems List of exclusive enumerations. + * @param [in] selectedItems List of the selected enumerations. */ void setupItems(QStringList const& availableItems, QStringList const& exclusiveItems, QStringList const& selectedItems); @@ -69,14 +69,14 @@ private slots: /*! * Change the state of all the enumerations. * - * @param [in] newState The new state for the enumerations. + * @param [in] newState The new state for the enumerations. */ void onCheckAllStateChange(bool newState); /*! * Change the state of the check all button to match the state of the enumerations. * - * @param [in] newState The new state. + * @param [in] newState The new state. */ void onChangeCheckAllState(Qt::CheckState newState); diff --git a/common/widgets/FileSelector/fileselector.h b/common/widgets/FileSelector/fileselector.h index da81b9f86..d09c4f1ae 100644 --- a/common/widgets/FileSelector/fileselector.h +++ b/common/widgets/FileSelector/fileselector.h @@ -31,8 +31,8 @@ class FileSelector : public QComboBox /*! * The constructor. * - * @param [in] component Pointer to the component whose files are selected. - * @param [in] parent Pointer to the owner of the combo box. + * @param [in] component Pointer to the component whose files are selected. + * @param [in] parent Pointer to the owner of the combo box. */ FileSelector(QSharedPointer component, QWidget *parent); @@ -42,7 +42,7 @@ class FileSelector : public QComboBox /*! * Add a file suffix to be used as filter when selecting files to display. * - * @param [in] suffix The file suffix to use as filter. + * @param [in] suffix The file suffix to use as filter. */ void addFilter(const QString& suffix); @@ -59,7 +59,7 @@ public slots: /*! * Set the specified file as selected. * - * @param [in] filePath The file path of the file to select. + * @param [in] filePath The file path of the file to select. */ void selectFile(const QString& filePath); @@ -78,7 +78,7 @@ private slots: /*! * Get the file names. * - * @param [in] component The component to search the files from. + * @param [in] component The component to search the files from. */ QStringList getFileNames(QSharedPointer component); diff --git a/common/widgets/GroupBoxWithAlertSign/StyleGroupBoxWithAlertSign.h b/common/widgets/GroupBoxWithAlertSign/StyleGroupBoxWithAlertSign.h index 1fca5194e..8f1a76413 100644 --- a/common/widgets/GroupBoxWithAlertSign/StyleGroupBoxWithAlertSign.h +++ b/common/widgets/GroupBoxWithAlertSign/StyleGroupBoxWithAlertSign.h @@ -57,10 +57,10 @@ class StyleGroupBoxWithAlertSign : public QCommonStyle /*! * Draws complex control for the group box with alert sign. * - * @param [in] cc The complex control to draw. - * @param [in] opt The style options for drawing. - * @param [in] p The painter object for drawing. - * @param [in] widget The widget to draw on. + * @param [in] cc The complex control to draw. + * @param [in] opt The style options for drawing. + * @param [in] p The painter object for drawing. + * @param [in] widget The widget to draw on. * * @remarks The function is slightly altered to incorporate vertical offset. * To better understand structure of the funcition refer to the source diff --git a/common/widgets/LibrarySelectorWidget/LibraryPathSelector/librarypathselector.h b/common/widgets/LibrarySelectorWidget/LibraryPathSelector/librarypathselector.h index 01706a29a..198cadd80 100644 --- a/common/widgets/LibrarySelectorWidget/LibraryPathSelector/librarypathselector.h +++ b/common/widgets/LibrarySelectorWidget/LibraryPathSelector/librarypathselector.h @@ -49,25 +49,25 @@ class LibraryPathSelector : public QComboBox { /*! * Gets the active library paths. * - * @return The active library locations. + * @return The active library locations. */ QStringList getLibraryLocations(); /*! * Checks if there is a library for a given path. * - * @param [in] path The path to search for. + * @param [in] path The path to search for. * - * @return True, if the path is under any of the active libraries, otherwise false. + * @return True, if the path is under any of the active libraries, otherwise false. */ bool hasIndexFor(QString const& path); /*! * Sets the index for the corresponding library for a given path. * - * @param [in] path The path under a library. + * @param [in] path The path under a library. * - * @return True, if the path is under any of the active libraries and can be set, otherwise false. + * @return True, if the path is under any of the active libraries and can be set, otherwise false. */ bool setIndexFor(QString const& path); diff --git a/common/widgets/LibrarySelectorWidget/LibrarySelectorWidget.h b/common/widgets/LibrarySelectorWidget/LibrarySelectorWidget.h index 87034ce3f..018ad7301 100644 --- a/common/widgets/LibrarySelectorWidget/LibrarySelectorWidget.h +++ b/common/widgets/LibrarySelectorWidget/LibrarySelectorWidget.h @@ -30,7 +30,7 @@ class LibrarySelectorWidget : public QWidget /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ LibrarySelectorWidget(QWidget *parent = 0); @@ -40,7 +40,7 @@ class LibrarySelectorWidget : public QWidget /*! * Get the edited path. * - * @return Path in the edit field. + * @return Path in the edit field. */ QString getPath() const; @@ -52,7 +52,7 @@ class LibrarySelectorWidget : public QWidget /*! * Checks if the path is valid. * - * @return True, if the path is in an active library, otherwise false. + * @return True, if the path is in an active library, otherwise false. */ bool isValid() const; diff --git a/common/widgets/LineEditEx/LineEditEx.h b/common/widgets/LineEditEx/LineEditEx.h index a48f53f65..377352f10 100644 --- a/common/widgets/LineEditEx/LineEditEx.h +++ b/common/widgets/LineEditEx/LineEditEx.h @@ -29,7 +29,7 @@ class LineEditEx : public AssistedLineEdit /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ LineEditEx(QWidget* parent = 0); @@ -47,14 +47,14 @@ class LineEditEx : public AssistedLineEdit * Sets the notification message template which is used when the user inputs a * string that is included in the disallowed inputs. Example: "View '%1' is already in use." * - * @param [in] template The template string. Must contain %1 to allow argumentation. + * @param [in] template The template string. Must contain %1 to allow argumentation. */ void setMessageTemplate(QString const& messageTemplate); /*! * Sets the notification message icon. * - * @param [in] icon The icon to set. + * @param [in] icon The icon to set. */ void setMessageIcon(QPixmap const& icon); @@ -71,7 +71,7 @@ private slots: /*! * Validates the given current text and either shows or hides the notification icon. * - * @param [in] text The text to validate. + * @param [in] text The text to validate. */ void validateText(QString const& text); diff --git a/common/widgets/ParameterGroupBox/parametergroupbox.h b/common/widgets/ParameterGroupBox/parametergroupbox.h index 87fd70dec..755192b24 100644 --- a/common/widgets/ParameterGroupBox/parametergroupbox.h +++ b/common/widgets/ParameterGroupBox/parametergroupbox.h @@ -43,12 +43,12 @@ class ParameterGroupBox : public QGroupBox /*! * The constructor. * - * @param [in] parameters The list containing the parameters. - * @param [in] choices The available choices for the parameters. - * @param [in] parameterFinder The parameter finder used to search the components parameters. - * @param [in] expressionFormatter The expression formatter. - * @param [in] docRevision The IP-XACT standard revision to use. - * @param [in] parent The owner of this editor. + * @param [in] parameters The list containing the parameters. + * @param [in] choices The available choices for the parameters. + * @param [in] parameterFinder The parameter finder used to search the components parameters. + * @param [in] expressionFormatter The expression formatter. + * @param [in] docRevision The IP-XACT standard revision to use. + * @param [in] parent The owner of this editor. */ ParameterGroupBox(QSharedPointer > > parameters, QSharedPointer > > choices, QSharedPointer parameterFinder, @@ -67,7 +67,7 @@ class ParameterGroupBox : public QGroupBox /*! * Setup a list of new parameters. * - * @param [in] newParameters New parameter list. + * @param [in] newParameters New parameter list. */ void setNewParameters(QSharedPointer > > newParameters, QSharedPointer > > newChoices, Document::Revision docRevision); @@ -86,30 +86,30 @@ class ParameterGroupBox : public QGroupBox /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); /*! * Open the reference tree of the parameter with the id. * - * @param [in] id The id of the parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id The id of the parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName) const; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); diff --git a/common/widgets/SnippetTextEdit/SnippetHighlighter.h b/common/widgets/SnippetTextEdit/SnippetHighlighter.h index 62b0bf557..9b0b5fb49 100644 --- a/common/widgets/SnippetTextEdit/SnippetHighlighter.h +++ b/common/widgets/SnippetTextEdit/SnippetHighlighter.h @@ -33,7 +33,7 @@ class SnippetHighlighter : public QSyntaxHighlighter /*! * Adds magic words. * - * @param [in] magicWords The magic words to add. + * @param [in] magicWords The magic words to add. */ void addMagicWords(QStringList const& magicWords); diff --git a/common/widgets/SnippetTextEdit/SnippetTextEdit.h b/common/widgets/SnippetTextEdit/SnippetTextEdit.h index f8137124c..df2b2017a 100644 --- a/common/widgets/SnippetTextEdit/SnippetTextEdit.h +++ b/common/widgets/SnippetTextEdit/SnippetTextEdit.h @@ -28,7 +28,7 @@ class SnippetTextEdit : public QPlainTextEdit /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ SnippetTextEdit(QWidget* parent); @@ -40,8 +40,8 @@ class SnippetTextEdit : public QPlainTextEdit /*! * Adds the given magic words available for use. * - * @param [in] magicWords The magic words to add. - * @param [in] category The category name for the words. Empty if uncategorized. + * @param [in] magicWords The magic words to add. + * @param [in] category The category name for the words. Empty if uncategorized. */ void addMagicWords(QStringList const& magicWords, QString const& category = QString("")); @@ -54,7 +54,7 @@ private slots: /*! * Shows a custom context menu. * - * @param [in] pt The upper-left corner coordinate for the context menu. + * @param [in] pt The upper-left corner coordinate for the context menu. */ void showContextMenu(QPoint const& pt); diff --git a/common/widgets/TreeItemSelector/FramedTreeItemEditor.h b/common/widgets/TreeItemSelector/FramedTreeItemEditor.h index 4e5da660e..a3676da93 100644 --- a/common/widgets/TreeItemSelector/FramedTreeItemEditor.h +++ b/common/widgets/TreeItemSelector/FramedTreeItemEditor.h @@ -30,7 +30,7 @@ class FramedTreeItemEditor : public QFrame /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ FramedTreeItemEditor(MemoryTreeFactory const* factory, QWidget* parent); diff --git a/common/widgets/TreeItemSelector/TreeItem.h b/common/widgets/TreeItemSelector/TreeItem.h index 7f3eaf6af..bb4625899 100644 --- a/common/widgets/TreeItemSelector/TreeItem.h +++ b/common/widgets/TreeItemSelector/TreeItem.h @@ -21,11 +21,11 @@ struct TreeItem /*! * The constructor. * - * @param [in] name The name of the item. - * @param [in] type The type of the item. - * @param [in] parent The parent of the item. + * @param [in] name The name of the item. + * @param [in] type The type of the item. + * @param [in] parent The parent of the item. * - * @return + * @return */ TreeItem(QString const& name, QString const& type) : name(name), type(type), parent(nullptr) {}; @@ -42,7 +42,7 @@ struct TreeItem /*! * Adds a child to the item. * - * @param [in] child The child to add. + * @param [in] child The child to add. */ void addChild(TreeItem* child) { diff --git a/common/widgets/TreeItemSelector/TreeItemEditor.h b/common/widgets/TreeItemSelector/TreeItemEditor.h index 4fe67e593..2ca4f08dc 100644 --- a/common/widgets/TreeItemSelector/TreeItemEditor.h +++ b/common/widgets/TreeItemSelector/TreeItemEditor.h @@ -34,8 +34,8 @@ class TreeItemEditor : public QWidget /*! * The constructor. * - * @param [in] factory Factory for creating the tree. - * @param [in] parent The parent widget. + * @param [in] factory Factory for creating the tree. + * @param [in] parent The parent widget. */ TreeItemEditor(MemoryTreeFactory const* factory, QWidget* parent = nullptr); @@ -50,7 +50,7 @@ class TreeItemEditor : public QWidget /*! * Selects the given path in the tree. * - * @param [in] path The path to select. + * @param [in] path The path to select. */ void selectPath(QStringList const& path); @@ -74,10 +74,10 @@ private slots: /*! * Finds a child with the given name. * - * @param [in] parent The parent of the child. - * @param [in] name The name of the child to find. + * @param [in] parent The parent of the child. + * @param [in] name The name of the child to find. * - * @return The index of the found child. + * @return The index of the found child. */ QModelIndex findChild(QModelIndex const& parent, QString const& name); diff --git a/common/widgets/accessComboBox/accesscombobox.h b/common/widgets/accessComboBox/accesscombobox.h index 5f3b4b05c..3ebb831e2 100644 --- a/common/widgets/accessComboBox/accesscombobox.h +++ b/common/widgets/accessComboBox/accesscombobox.h @@ -38,14 +38,14 @@ class AccessComboBox : public QComboBox /*! * Get the currently selected access value. * - * @return The selected value. + * @return The selected value. */ AccessTypes::Access getCurrentValue() const; /*! * Set the value to be currently selected. * - * @param [in] access The value to select. + * @param [in] access The value to select. */ void setCurrentValue(AccessTypes::Access access); diff --git a/common/widgets/assistedLineEdit/AssistedLineEdit.h b/common/widgets/assistedLineEdit/AssistedLineEdit.h index 473ad2c89..daf47322b 100644 --- a/common/widgets/assistedLineEdit/AssistedLineEdit.h +++ b/common/widgets/assistedLineEdit/AssistedLineEdit.h @@ -33,8 +33,8 @@ class AssistedLineEdit : public QLineEdit /*! * The constructor. * - * @param [in] parentWnd The parent window of the line edit. Must not be null. - * @param [in] parent The parent widget. Can be null. + * @param [in] parentWnd The parent window of the line edit. Must not be null. + * @param [in] parent The parent widget. Can be null. */ AssistedLineEdit(QWidget* parentWnd, QWidget* parent = 0); @@ -50,7 +50,7 @@ class AssistedLineEdit : public QLineEdit /*! * Sets the content matcher. * - * @param [in] matcher The matcher to set. + * @param [in] matcher The matcher to set. */ void setContentMatcher(ILineContentMatcher* matcher); @@ -59,7 +59,7 @@ class AssistedLineEdit : public QLineEdit /*! * Handles the given key press event. * - * @param [in] e The key event. + * @param [in] e The key event. */ void keyPressEvent(QKeyEvent* e); diff --git a/common/widgets/assistedLineEdit/BasicLineContentMatcher.h b/common/widgets/assistedLineEdit/BasicLineContentMatcher.h index ba32af080..98e0482cf 100644 --- a/common/widgets/assistedLineEdit/BasicLineContentMatcher.h +++ b/common/widgets/assistedLineEdit/BasicLineContentMatcher.h @@ -33,29 +33,29 @@ class BasicLineContentMatcher : public ILineContentMatcher /*! * Sets the items that will be suggested by the content assist. * - * @param [in] items A list of string items. + * @param [in] items A list of string items. */ void setItems(QStringList const& items); /*! * Looks forward for matching contents in the given text. * - * @param [in] text The text. + * @param [in] text The text. * - * @return True, if there is a match. Otherwise false. + * @return True, if there is a match. Otherwise false. */ bool lookForwardMatch(QString const& text); /*! * Fills the content assist with content based on the given text. * - * @param [in] text The text. - * @param [in] assist The content assist to fill with content. - * @param [out] startIndex The start index of the selection to which the content applies. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. + * @param [in] text The text. + * @param [in] assist The content assist to fill with content. + * @param [out] startIndex The start index of the selection to which the content applies. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. * - * @return True, if content was found; otherwise false. + * @return True, if content was found; otherwise false. */ bool fillWithContent(QString const& text, LineContentAssistWidget& assist, int& startIndex, QString& toolTipText, int& toolTipIndex); @@ -69,10 +69,10 @@ class BasicLineContentMatcher : public ILineContentMatcher * Enumerates matches based on the string. If the content assist is specified, the matching * contents is also added to it. * - * @param [in] text The text to which to match content. - * @param [in] assist The content assist to fill with content. Can be null. + * @param [in] text The text to which to match content. + * @param [in] assist The content assist to fill with content. Can be null. * - * @return True, if there was content found; otherwise false. + * @return True, if there was content found; otherwise false. */ bool enumerateMatches(QString const& text, LineContentAssistWidget* assist) const; diff --git a/common/widgets/assistedLineEdit/ILineContentMatcher.h b/common/widgets/assistedLineEdit/ILineContentMatcher.h index fd53db537..4aead5ab7 100644 --- a/common/widgets/assistedLineEdit/ILineContentMatcher.h +++ b/common/widgets/assistedLineEdit/ILineContentMatcher.h @@ -30,22 +30,22 @@ class ILineContentMatcher /*! * Looks forward for matching contents in the given text. * - * @param [in] text The text. + * @param [in] text The text. * - * @return True, if there is a match. Otherwise false. + * @return True, if there is a match. Otherwise false. */ virtual bool lookForwardMatch(QString const& text) = 0; /*! * Fills the content assist with content based on the given text. * - * @param [in] text The text. - * @param [in] assist The content assist to fill with content. - * @param [out] startIndex The start index of the selection to which the content applies. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. + * @param [in] text The text. + * @param [in] assist The content assist to fill with content. + * @param [out] startIndex The start index of the selection to which the content applies. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. * - * @return True, if content was found; otherwise false. + * @return True, if content was found; otherwise false. */ virtual bool fillWithContent(QString const& text, LineContentAssistWidget& assist, int& startIndex, QString& toolTipText, int& toolTipIndex) = 0; diff --git a/common/widgets/assistedLineEdit/LineContentAssistWidget.h b/common/widgets/assistedLineEdit/LineContentAssistWidget.h index ffd12330a..516276259 100644 --- a/common/widgets/assistedLineEdit/LineContentAssistWidget.h +++ b/common/widgets/assistedLineEdit/LineContentAssistWidget.h @@ -28,8 +28,8 @@ class LineContentAssistWidget : public QListWidget /*! * The constructor. * - * @param [in] target The target line edit. Must not be null. - * @param [in] parentWnd The parent window of the line edit. + * @param [in] target The target line edit. Must not be null. + * @param [in] parentWnd The parent window of the line edit. */ LineContentAssistWidget(QLineEdit* target, QWidget* parentWnd); @@ -45,14 +45,14 @@ class LineContentAssistWidget : public QListWidget /*! * Sets the content matcher. * - * @param [in] matcher The matcher to set. + * @param [in] matcher The matcher to set. */ void setContentMatcher(ILineContentMatcher* matcher); /*! * Tries to handle the given key press fully, committing the selection if possible. * - * @return True, if the key was handle fully and the editor should not handle it. + * @return True, if the key was handle fully and the editor should not handle it. * False, if the editor still needs to handle the key. * * @remarks Assumes that the given key event has not yet been handled by the editor. @@ -79,7 +79,7 @@ class LineContentAssistWidget : public QListWidget /*! * Sets the maximum number of items to be visible at once. * - * @param [in] count The maximum number of visible items at once. + * @param [in] count The maximum number of visible items at once. */ void setMaxVisibleItems(int count); @@ -91,7 +91,7 @@ class LineContentAssistWidget : public QListWidget /*! * Set a new width for the assist. * - * @param [in] newWidth The new assist width. + * @param [in] newWidth The new assist width. */ void setWidthForAssist(int newWidth); @@ -99,14 +99,14 @@ class LineContentAssistWidget : public QListWidget /*! * Handles the mouse press event. * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ void mousePressEvent(QMouseEvent* event); /*! * Handles the mouse double click event. * - * @param [in] event The mouse double click event. + * @param [in] event The mouse double click event. */ void mouseDoubleClickEvent(QMouseEvent* event); @@ -115,8 +115,8 @@ class LineContentAssistWidget : public QListWidget /*! * Handles the wrapping of item selection. * - * @param [in] event The key event. - * @param [in] key The pressed key. + * @param [in] event The key event. + * @param [in] key The pressed key. */ bool handleKeyboardItemSelection(QKeyEvent* event, int key); @@ -129,9 +129,9 @@ class LineContentAssistWidget : public QListWidget /*! * Returns true if the content assist can currently commit with the given key. * - * @param [in] key The commit key. + * @param [in] key The commit key. * - * @return True, if the content assist can currently commit. + * @return True, if the content assist can currently commit. */ bool canCommitWith(QKeyEvent* e) const; diff --git a/common/widgets/assistedTextEdit/AssistedTextEdit.h b/common/widgets/assistedTextEdit/AssistedTextEdit.h index d5e1c17e7..7243eca49 100644 --- a/common/widgets/assistedTextEdit/AssistedTextEdit.h +++ b/common/widgets/assistedTextEdit/AssistedTextEdit.h @@ -41,9 +41,9 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Constructor. * - * @param [in] contentMatcher The content matcher for the content assist. - * @param [in] mainWnd The program main window. Must not be null. - * @param [in] parent The parent widget. Can be null. + * @param [in] contentMatcher The content matcher for the content assist. + * @param [in] mainWnd The program main window. Must not be null. + * @param [in] parent The parent widget. Can be null. */ AssistedTextEdit(QSharedPointer contentMatcher, QWidget* mainWnd, QWidget* parent = 0); @@ -56,8 +56,8 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Sets the indentation style. * - * @param [in] style The indentation style. - * @param [in] width The indentation width. + * @param [in] style The indentation style. + * @param [in] width The indentation width. */ void setIndentStyle(IndentStyle style, unsigned int width); @@ -79,8 +79,8 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Filters events. * - * @param [in] obj The event owner. - * @param [in] e The event. + * @param [in] obj The event owner. + * @param [in] e The event. */ bool eventFilter(QObject* obj, QEvent* e); @@ -88,14 +88,14 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Handles the given key press event. * - * @param [in] e The key event. + * @param [in] e The key event. */ void keyPressEvent(QKeyEvent* e); /*! * Handles the given mouse press event. * - * @param [in] e The mouse press event. + * @param [in] e The mouse press event. */ void mousePressEvent(QMouseEvent* e); @@ -112,14 +112,14 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Creates a correct indentation string based on the indentation style. * - * @param [in] depth The indentation depth, that is, the number of indentations. + * @param [in] depth The indentation depth, that is, the number of indentations. */ QString createIndentString(unsigned int depth); /*! * Determines the correct indentation depth for the given position. * - * @param [in] The position index. + * @param [in] The position index. */ int calculateIndentDepth(int pos); @@ -136,16 +136,16 @@ class AssistedTextEdit : public QPlainTextEdit /*! * Replaces a substring in the text with the given indentation. * - * @param [in] startIndex The start index of the substring. - * @param [in] endIndex The end index of the substring (excluded from the substring). - * @param [in] indentDepth The desired indentation depth. + * @param [in] startIndex The start index of the substring. + * @param [in] endIndex The end index of the substring (excluded from the substring). + * @param [in] indentDepth The desired indentation depth. */ void replaceWithIndent(int startIndex, int endIndex, int indentDepth); /*! * Handles the Return key press event. * - * @param [in] e The Return key press event. + * @param [in] e The Return key press event. */ void onReturnKeyPress(QKeyEvent* e); diff --git a/common/widgets/assistedTextEdit/ITextContentMatcher.h b/common/widgets/assistedTextEdit/ITextContentMatcher.h index f7bb61e8c..fd2f0e547 100644 --- a/common/widgets/assistedTextEdit/ITextContentMatcher.h +++ b/common/widgets/assistedTextEdit/ITextContentMatcher.h @@ -28,22 +28,22 @@ class ITextContentMatcher /*! * Looks forward for matching contents in the given text. * - * @param [in] text The text. + * @param [in] text The text. * - * @return True, if there is a match. Otherwise false. + * @return True, if there is a match. Otherwise false. */ virtual bool lookForwardMatch(QString const& text) = 0; /*! * Fills the content assist with content based on the given text. * - * @param [in] text The text. - * @param [in] assist The content assist to fill with content. - * @param [out] startIndex The start index of the selection to which the content applies. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. + * @param [in] text The text. + * @param [in] assist The content assist to fill with content. + * @param [out] startIndex The start index of the selection to which the content applies. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. * - * @return The content state (what kind of content was detected). + * @return The content state (what kind of content was detected). */ virtual bool fillWithContent(QString const& text, TextContentAssistWidget& assist, int& startIndex, QString& toolTipText, int& toolTipIndex) = 0; diff --git a/common/widgets/assistedTextEdit/TextContentAssistWidget.h b/common/widgets/assistedTextEdit/TextContentAssistWidget.h index c42ff50d5..e039d08b7 100644 --- a/common/widgets/assistedTextEdit/TextContentAssistWidget.h +++ b/common/widgets/assistedTextEdit/TextContentAssistWidget.h @@ -28,8 +28,8 @@ class TextContentAssistWidget : public QListWidget /*! * Constructor. * - * @param [in] parent The target text editor. Must not be null. - * @param [in] matcher The content matcher to use. Must not be null. + * @param [in] parent The target text editor. Must not be null. + * @param [in] matcher The content matcher to use. Must not be null. */ TextContentAssistWidget(QPlainTextEdit* target, QWidget* parentWnd, QSharedPointer matcher); @@ -42,7 +42,7 @@ class TextContentAssistWidget : public QListWidget /*! * Tries to handle the given key press fully, committing the selection if possible. * - * @return True, if the key was handle fully and the editor should not handle it. + * @return True, if the key was handle fully and the editor should not handle it. * False, if the editor still needs to handle the key. * * @remarks Assumes that the given key event has not yet been handled by the editor. @@ -66,7 +66,7 @@ class TextContentAssistWidget : public QListWidget /*! * Sets the maximum number of items to be visible at once. * - * @param [in] count The maximum number of visible items at once. + * @param [in] count The maximum number of visible items at once. */ void setMaxVisibleItems(int count); @@ -79,14 +79,14 @@ class TextContentAssistWidget : public QListWidget /*! * Handles the mouse press event. * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ void mousePressEvent(QMouseEvent* event); /*! * Handles the mouse double click event. * - * @param [in] event The mouse double click event. + * @param [in] event The mouse double click event. */ void mouseDoubleClickEvent(QMouseEvent* event); @@ -104,9 +104,9 @@ class TextContentAssistWidget : public QListWidget /*! * Returns true if the content assist can currently commit with the given key. * - * @param [in] key The commit key. + * @param [in] key The commit key. * - * @return True, if the content assist can currently commit. + * @return True, if the content assist can currently commit. */ bool canCommitWith(QKeyEvent* e) const; diff --git a/common/widgets/booleanComboBox/booleancombobox.h b/common/widgets/booleanComboBox/booleancombobox.h index a72190f30..149777f37 100644 --- a/common/widgets/booleanComboBox/booleancombobox.h +++ b/common/widgets/booleanComboBox/booleancombobox.h @@ -26,7 +26,7 @@ class BooleanComboBox : public QComboBox /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ BooleanComboBox(QWidget *parent); @@ -36,14 +36,14 @@ class BooleanComboBox : public QComboBox /*! * Get the value currently selected in the combo box. * - * @return Boolean value that matches the currently selected item. + * @return Boolean value that matches the currently selected item. */ QString getCurrentValue() const; /*! * Set the current value to be selected. * - * @param [in] value The value to be selected. + * @param [in] value The value to be selected. */ void setCurrentValue(QString const& value); diff --git a/common/widgets/busReferenceComboBox/BusReferenceComboBox.h b/common/widgets/busReferenceComboBox/BusReferenceComboBox.h index 495855414..3ef9ed8c8 100644 --- a/common/widgets/busReferenceComboBox/BusReferenceComboBox.h +++ b/common/widgets/busReferenceComboBox/BusReferenceComboBox.h @@ -30,8 +30,8 @@ class BusReferenceComboBox: public QComboBox /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent Pointer to the owner of the combo box. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent Pointer to the owner of the combo box. */ BusReferenceComboBox(BusInterfaceInterface* busInterface, QWidget *parent); @@ -43,8 +43,8 @@ class BusReferenceComboBox: public QComboBox /*! * Setup the combo box. * - * @param [in] currentValue Currently selected bus interface. - * @param [in] busMode Filtering bus mode for available bus interfaces. + * @param [in] currentValue Currently selected bus interface. + * @param [in] busMode Filtering bus mode for available bus interfaces. */ void setupSelection(QString const& currentValue = "", General::InterfaceMode busMode = General::INTERFACE_MODE_COUNT); diff --git a/common/widgets/colorBox/ColorBox.h b/common/widgets/colorBox/ColorBox.h index c0be6d91c..186cf8300 100644 --- a/common/widgets/colorBox/ColorBox.h +++ b/common/widgets/colorBox/ColorBox.h @@ -27,7 +27,7 @@ class ColorBox : public QFrame /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ColorBox(QSize const& size, QWidget* parent = 0); @@ -39,7 +39,7 @@ class ColorBox : public QFrame /*! * Sets the color for the color box. * - * @param [in] color The color to set. + * @param [in] color The color to set. */ void setColor(QColor const& color); @@ -51,14 +51,14 @@ class ColorBox : public QFrame /*! * Sets the text font. * - * @param [in] font The font to set. + * @param [in] font The font to set. */ void setTextFont(QFont const& font); /*! * Sets the text color. * - * @param [in] color The color to set. + * @param [in] color The color to set. */ void setTextColor(QColor const& color); diff --git a/common/widgets/componentPreviewBox/ComponentPreviewBox.h b/common/widgets/componentPreviewBox/ComponentPreviewBox.h index 42040f5f2..3569c3f42 100644 --- a/common/widgets/componentPreviewBox/ComponentPreviewBox.h +++ b/common/widgets/componentPreviewBox/ComponentPreviewBox.h @@ -34,8 +34,8 @@ class ComponentPreviewBox : public ItemVisualizer /*! * Constructor. * - * @param [in] lh The library interface. - * @param [in] parent The parent widget. + * @param [in] lh The library interface. + * @param [in] parent The parent widget. */ ComponentPreviewBox(LibraryInterface* lh, QWidget* parent = nullptr); @@ -51,7 +51,7 @@ class ComponentPreviewBox : public ItemVisualizer /*! * Sets the component that will be visualized. * - * @param [in] component The component to visualize. + * @param [in] component The component to visualize. */ void setComponent(QSharedPointer component); @@ -63,21 +63,21 @@ class ComponentPreviewBox : public ItemVisualizer /*! * Get the bounding rect of all items on the scene. * - * @return The rect that bounds all items. + * @return The rect that bounds all items. */ QRectF itemsBoundingRect() const; /*! * Get the graphics scene. * - * @return The graphics scene used by the preview. + * @return The graphics scene used by the preview. */ QGraphicsScene* scene() const; /*! * Set the preview interactive i.e. user can move interfaces. * - * @param [in] interactive Interactive or view-only. + * @param [in] interactive Interactive or view-only. */ void setInteractive(bool interactive); diff --git a/common/widgets/interfaceModeSelector/interfacemodeselector.h b/common/widgets/interfaceModeSelector/interfacemodeselector.h index 44a5bc9e2..8b7758fc1 100644 --- a/common/widgets/interfaceModeSelector/interfacemodeselector.h +++ b/common/widgets/interfaceModeSelector/interfacemodeselector.h @@ -31,10 +31,10 @@ class InterfaceModeSelector : public QComboBox /*! * The constructor. * - * @param [in] docRevision The IP-XACT version to comply to. - * @param [in] showMonitor If this is true then also "monitor" option is shown. - * @param [in] mode The interface mode that is selected at start. - * @param [in] parent The owner of the editor. + * @param [in] docRevision The IP-XACT version to comply to. + * @param [in] showMonitor If this is true then also "monitor" option is shown. + * @param [in] mode The interface mode that is selected at start. + * @param [in] parent The owner of the editor. */ InterfaceModeSelector(Document::Revision docRevision, General::InterfaceMode mode = General::INTERFACE_MODE_COUNT, @@ -54,7 +54,7 @@ class InterfaceModeSelector : public QComboBox /*! * Get the currently selected mode. * - * @return The selected interface mode. + * @return The selected interface mode. */ General::InterfaceMode selected() const; @@ -64,7 +64,7 @@ public slots: * * This slot does not emit any signals when it is called. * - * @param [in] mode The mode to set selected. + * @param [in] mode The mode to set selected. */ void setMode(const General::InterfaceMode mode); @@ -72,7 +72,7 @@ public slots: * * Calling this slot emits the modeSelected(mode) signal. * - * @param [in] modeName The name of the mode. This should be one of the defined in General::INTERFACE_MODE_NAMES + * @param [in] modeName The name of the mode. This should be one of the defined in General::INTERFACE_MODE_NAMES */ void setMode(QString const& modeName); diff --git a/common/widgets/interfaceSelector/interfaceselector.h b/common/widgets/interfaceSelector/interfaceselector.h index f4014134f..d8cb1c9c7 100644 --- a/common/widgets/interfaceSelector/interfaceselector.h +++ b/common/widgets/interfaceSelector/interfaceselector.h @@ -31,9 +31,9 @@ class InterfaceSelector : public QComboBox /*! The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this combo box. - * @param [in] mode The mode that defines the types of interfaces to show. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this combo box. + * @param [in] mode The mode that defines the types of interfaces to show. */ InterfaceSelector(BusInterfaceInterface* busInterface, QWidget* parent, General::InterfaceMode mode = General::INTERFACE_MODE_COUNT); @@ -46,7 +46,7 @@ class InterfaceSelector : public QComboBox /*! * Set the interface mode filter. * - * @param [in] mode The mode that defines the types of interfaces to show. + * @param [in] mode The mode that defines the types of interfaces to show. * * Note: If the mode is undefined (General::INTERFACE_MODE_COUNT) then all types of interfaces are shown. */ @@ -62,7 +62,7 @@ public slots: /*! * Set the specified interface as selected. * - * @param [in] interfaceName The name of the interface to select. + * @param [in] interfaceName The name of the interface to select. */ void selectInterface(const QString& interfaceName); diff --git a/common/widgets/kactusAttributeEditor/KactusAttributeEditor.h b/common/widgets/kactusAttributeEditor/KactusAttributeEditor.h index c0018613d..862b2e145 100644 --- a/common/widgets/kactusAttributeEditor/KactusAttributeEditor.h +++ b/common/widgets/kactusAttributeEditor/KactusAttributeEditor.h @@ -47,9 +47,9 @@ class KactusAttributeEditor : public QGroupBox /*! * Sets the given attributes as selected. * - * @param [in] prodHier Product hierarchy. - * @param [in] firmness Firmness. - * @param [in] tags Document tags. + * @param [in] prodHier Product hierarchy. + * @param [in] firmness Firmness. + * @param [in] tags Document tags. */ void setAttributes(KactusAttribute::ProductHierarchy prodHier, KactusAttribute::Firmness firmness, QVector tags); @@ -57,7 +57,7 @@ class KactusAttributeEditor : public QGroupBox /*! * Sets the implementation visible with the given value. * - * @param [in] implementation Implementation. + * @param [in] implementation Implementation. */ void setImplementation(KactusAttribute::Implementation implementation); @@ -74,7 +74,7 @@ class KactusAttributeEditor : public QGroupBox /*! * Get document tags. * - * @return Document tags. + * @return Document tags. */ QVector getTags() const; diff --git a/common/widgets/listManager/dirlistmanager.h b/common/widgets/listManager/dirlistmanager.h index b2067a0b7..8d7f7c025 100644 --- a/common/widgets/listManager/dirlistmanager.h +++ b/common/widgets/listManager/dirlistmanager.h @@ -31,9 +31,9 @@ class DirListManager : public ListManager /*! * The constructor. * - * @param [in] title Title to be set for the QGroupBox - * @param [in] basePath Path to start relative paths from. - * @param [in] parent The owner of this widget. + * @param [in] title Title to be set for the QGroupBox + * @param [in] basePath Path to start relative paths from. + * @param [in] parent The owner of this widget. */ DirListManager(QString const& title, QString const& basePath, QWidget *parent = 0); @@ -45,7 +45,7 @@ class DirListManager : public ListManager * * This function must be called after creating the directory list manager and before using it. * - * @param [in] items QStringList that contains the items to add to the widget. + * @param [in] items QStringList that contains the items to add to the widget. */ virtual void initialize(const QStringList& items = QStringList()); diff --git a/common/widgets/listManager/dirlistmanagermodel.h b/common/widgets/listManager/dirlistmanagermodel.h index 261d87fa8..09f2d9e2d 100644 --- a/common/widgets/listManager/dirlistmanagermodel.h +++ b/common/widgets/listManager/dirlistmanagermodel.h @@ -28,9 +28,9 @@ class DirListManagerModel : public ListManagerModel /*! * The constructor. * - * @param [in] basePath Path to start the relative paths from. - * @param [in] items QStringList which contains the items to add. - * @param [in] parent The owner of the model. + * @param [in] basePath Path to start the relative paths from. + * @param [in] items QStringList which contains the items to add. + * @param [in] parent The owner of the model. */ DirListManagerModel(QString const& basePath, QStringList const& items = QStringList(), QObject* parent = 0); @@ -40,8 +40,8 @@ class DirListManagerModel : public ListManagerModel /*! * Get the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; diff --git a/common/widgets/listManager/listeditor.h b/common/widgets/listManager/listeditor.h index 65ec76ed1..6f287ff48 100644 --- a/common/widgets/listManager/listeditor.h +++ b/common/widgets/listManager/listeditor.h @@ -30,7 +30,7 @@ class ListEditor : public QWidget /*! * The constructor. * - * @param [in] parent Pointer to the owner of this editor. + * @param [in] parent Pointer to the owner of this editor. */ ListEditor(QWidget *parent); @@ -42,28 +42,28 @@ class ListEditor : public QWidget /*! * Get the string items currently stored in the editor. * - * @return QStringList that contains the strings. + * @return QStringList that contains the strings. */ const QStringList& items() const; /*! * Set the items for the editor. * - * @param [in] items QStringList containing the strings to edit. + * @param [in] items QStringList containing the strings to edit. */ void setItems(const QStringList& items); /*! * Get the number of items stored in the list. * - * @return Number of items in the list. + * @return Number of items in the list. */ int size() const; /*! * Set delegate for the view. * - * @param [in] delegate Pointer to the delegate that provides editor for view. + * @param [in] delegate Pointer to the delegate that provides editor for view. */ virtual void setItemDelegate(QStyledItemDelegate* delegate); diff --git a/common/widgets/listManager/listmanager.h b/common/widgets/listManager/listmanager.h index d1fbe6dad..7948bab74 100644 --- a/common/widgets/listManager/listmanager.h +++ b/common/widgets/listManager/listmanager.h @@ -29,8 +29,8 @@ class ListManager : public QGroupBox /*! The constructor. * - * @param [in] title The title to be set for the QGroupBox - * @param [in] parent The owner of this widget. + * @param [in] title The title to be set for the QGroupBox + * @param [in] parent The owner of this widget. */ ListManager(QString const& title = tr("List"), QWidget *parent = 0); @@ -41,25 +41,25 @@ class ListManager : public QGroupBox * * This function must be called after creating the list manager and before using it. * - * @param [in] items QStringList that contains the items to add to the widget. + * @param [in] items QStringList that contains the items to add to the widget. */ virtual void initialize(const QStringList& items = QStringList()); /*! Get the string items currently stored in the model. * - * @return QStringList that is contained in this widget. + * @return QStringList that is contained in this widget. */ QStringList items() const; /*! Set the items to be stored in this widget. * - * @param [in] items QStringList containing the strings to add. + * @param [in] items QStringList containing the strings to add. */ void setItems(const QStringList& items); /*! Get the number of items stored in the list. * - * @return Number of items in the list. + * @return Number of items in the list. */ int size() const; diff --git a/common/widgets/listManager/listmanagermodel.h b/common/widgets/listManager/listmanagermodel.h index edb38554b..4b28bbadf 100644 --- a/common/widgets/listManager/listmanagermodel.h +++ b/common/widgets/listManager/listmanagermodel.h @@ -30,8 +30,8 @@ class ListManagerModel : public QAbstractListModel /*! * The constructor. * - * @param [in] items QStringList that contains the items to add. - * @param [in] parent The owner of this model. + * @param [in] items QStringList that contains the items to add. + * @param [in] parent The owner of this model. */ ListManagerModel(QStringList const& items = QStringList(), QObject *parent = 0); @@ -43,73 +43,73 @@ class ListManagerModel : public QAbstractListModel /*! * Get the number of rows in this model. * - * @param [in] parent ModelIndex of the item that's rowCount is requested. + * @param [in] parent ModelIndex of the item that's rowCount is requested. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Get the data for the header of the list. * - * @param [in] section Specifies the column for which the header is requested. - * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. - * @param [in] role Specifies what kind of header data is requested. + * @param [in] section Specifies the column for which the header is requested. + * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. + * @param [in] role Specifies what kind of header data is requested. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Append a new item to the end of the list. * - * @param [in] item The string to be appended to the end of the list. + * @param [in] item The string to be appended to the end of the list. */ virtual void appendItem(QString const& item); /*! * Get the items currently stored in the model. * - * @return QStringList containing the items. + * @return QStringList containing the items. */ virtual QStringList const& items() const; /*! * Set the items to the model. * - * @param [in] items QStringList containing the items to be contained in the model. + * @param [in] items QStringList containing the items to be contained in the model. */ virtual void setItems(const QStringList& items); /*! * Replace an item text in the list. * - * @param [in] index ModelIndex of the item that is to be replaced. - * @param [in] newText The new text for the given item. + * @param [in] index ModelIndex of the item that is to be replaced. + * @param [in] newText The new text for the given item. */ virtual void replace(QModelIndex& index, const QString newText); @@ -118,22 +118,22 @@ public slots: /*! * Removes the specified item from the model. * - * @param [in] index The model index of the item to remove. + * @param [in] index The model index of the item to remove. */ virtual void remove(QModelIndex const& index); /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void addItem(QModelIndex const& index); /*! * Move item to another position. * - * @param [in] originalPos Identifies the item that should be moved. - * @param [in] newPos The new position the item should be moved to. + * @param [in] originalPos Identifies the item that should be moved. + * @param [in] newPos The new position the item should be moved to. */ virtual void moveItem(QModelIndex const& originalPos, QModelIndex const& newPos); diff --git a/common/widgets/nameGroupBox/namegroupbox.h b/common/widgets/nameGroupBox/namegroupbox.h index 3302d65cc..0642e07f0 100644 --- a/common/widgets/nameGroupBox/namegroupbox.h +++ b/common/widgets/nameGroupBox/namegroupbox.h @@ -31,7 +31,7 @@ class NameGroupBox: public QGroupBox /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ NameGroupBox(QWidget* parent = 0, const QString& title = QString("Names")); @@ -41,21 +41,21 @@ class NameGroupBox: public QGroupBox /*! * Get the value of the name-field. * - * @return QString containing the name. + * @return QString containing the name. */ QString name() const; /*! * Get the value of the displayName-field. * - * @return QString containing the displayName. + * @return QString containing the displayName. */ QString displayName() const; /*! * Get the value of the description-field. * - * @return QString containing the description. + * @return QString containing the description. */ QString description() const; @@ -65,7 +65,7 @@ class NameGroupBox: public QGroupBox * This function checks that name-field is not empty and does not contain string with embedded whitespace * characters. * - * @return True if everything is ok. + * @return True if everything is ok. */ bool isValid() const; @@ -74,21 +74,21 @@ public slots: /*! * Set the value for the name-field. * - * @param [in] name QString containing the name. + * @param [in] name QString containing the name. */ void setName(const QString& name); /*! * Set the value for the displayName-field. * - * @param [in] displayName QString containing the displayName. + * @param [in] displayName QString containing the displayName. */ void setDisplayName(const QString& displayName); /*! * Set the value for the description-field. * - * @param [in] description QString containing the description. + * @param [in] description QString containing the description. */ void setDescription(const QString& description); diff --git a/common/widgets/segmentComboBox/SegmentComboBox.h b/common/widgets/segmentComboBox/SegmentComboBox.h index 0492a7a84..d1801d96c 100644 --- a/common/widgets/segmentComboBox/SegmentComboBox.h +++ b/common/widgets/segmentComboBox/SegmentComboBox.h @@ -41,8 +41,8 @@ class SegmentComboBox : public QComboBox /*! * Setup the combo box. * - * @param [in] containingSpace Address space containing the available segments. - * @param [in] segmentReference Currently selected segment. + * @param [in] containingSpace Address space containing the available segments. + * @param [in] segmentReference Currently selected segment. */ void setupSelection(QSharedPointer containingSpace, QString const& segmentReference = ""); diff --git a/common/widgets/summaryLabel/summarylabel.h b/common/widgets/summaryLabel/summarylabel.h index 69d2082c8..dca95a3a3 100644 --- a/common/widgets/summaryLabel/summarylabel.h +++ b/common/widgets/summaryLabel/summarylabel.h @@ -24,9 +24,9 @@ class SummaryLabel : public QLabel { /*! * The constructor * - * @param [in] text The text to display in the label. - * @param [in] parent The owner of this label. - * @param [in] showExtensionIcon If true, an extension icon is shown next to the label. + * @param [in] text The text to display in the label. + * @param [in] parent The owner of this label. + * @param [in] showExtensionIcon If true, an extension icon is shown next to the label. */ SummaryLabel(const QString& text, QWidget *parent, bool showExtensionIcon = false); diff --git a/common/widgets/tabDocument/TabDocument.h b/common/widgets/tabDocument/TabDocument.h index 5648ac31b..a761e6ec7 100644 --- a/common/widgets/tabDocument/TabDocument.h +++ b/common/widgets/tabDocument/TabDocument.h @@ -86,11 +86,11 @@ class TabDocument : public QWidget /*! * Constructor. * - * @param [in] parent The parent widget. - * @param [in] libHandler The instance that handles the library. - * @param [in] flags The document support flags. - * @param [in] minZoomLevel The minimum zoom level. - * @param [in] maxZoomLevel The maximum zoom level. + * @param [in] parent The parent widget. + * @param [in] libHandler The instance that handles the library. + * @param [in] flags The document support flags. + * @param [in] minZoomLevel The minimum zoom level. + * @param [in] maxZoomLevel The maximum zoom level. */ TabDocument(QWidget* parent, LibraryInterface* libHandler = nullptr, unsigned int flags = 0, int minZoomLevel = 100, int maxZoomLevel = 100); @@ -115,8 +115,8 @@ class TabDocument : public QWidget /*! * Changes the state of a visibility control. * - * @param [in] name The name of the visibility control. - * @param [in] state The new state for the visibility control. + * @param [in] name The name of the visibility control. + * @param [in] state The new state for the visibility control. */ virtual void setVisibilityControlState(QString const& name, bool state); @@ -133,14 +133,14 @@ class TabDocument : public QWidget /*! * Sets the zoom level. * - * @param [in] level The zoom level in percents. + * @param [in] level The zoom level in percents. */ virtual void setZoomLevel(int level); /*! * Sets the draw mode of the document. * - * @param [in] mode The draw mode. + * @param [in] mode The draw mode. * * @remarks Proper implementation is required if the document is a diagram. */ @@ -149,7 +149,7 @@ class TabDocument : public QWidget /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); @@ -215,7 +215,7 @@ class TabDocument : public QWidget /*! * Adds a related VLNV. * - * @param [in] vlnv The VLNV to add. + * @param [in] vlnv The VLNV to add. * * @remarks The occurrences of each unique VLNV are calculated internally. */ @@ -224,7 +224,7 @@ class TabDocument : public QWidget /*! * Removes a related VLNV. * - * @param [in] vlnv The VLNV to remove. + * @param [in] vlnv The VLNV to remove. */ void removeRelatedVLNV(VLNV const& vlnv); @@ -243,7 +243,7 @@ class TabDocument : public QWidget /*! * Returns the edit provider. * - * @return Base class implementation returns null. + * @return Base class implementation returns null. * * @remarks Edit support should be queried with getFlags(). */ @@ -274,7 +274,7 @@ class TabDocument : public QWidget /*! * Validates that the file being edited in the tab exists. * - * @return True if libHandler is present and the file exists, otherwise false. + * @return True if libHandler is present and the file exists, otherwise false. */ bool fileExists(); @@ -288,9 +288,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); @@ -311,7 +311,7 @@ public slots: /*! * Sets the document modified/unmodified. * - * @param [in] modified True if the document should be set modified; otherwise false. + * @param [in] modified True if the document should be set modified; otherwise false. */ void setModified(bool modified = true); @@ -366,8 +366,8 @@ public slots: /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] containingID ID for the vendor extensions editor. - * @param [in] extensionItem The item containing the selected vendor extensions. + * @param [in] containingID ID for the vendor extensions editor. + * @param [in] extensionItem The item containing the selected vendor extensions. */ void changeVendorExtensions(QString const& containingID, QSharedPointer extensionItem); @@ -375,22 +375,22 @@ public slots: /*! * Sets the name of the document. * - * @param [in] name The name of the document. + * @param [in] name The name of the document. */ void setDocumentName(QString const& name); /*! * Sets the type of the document. If not empty, the name of the tab will be shown as: DocName [DocType] * - * @param [in] type The type of the document. + * @param [in] type The type of the document. */ void setDocumentType(DocumentType const& type); /*! * Adds a new visibility control to the document. * - * @param [in] name The name of the new visibility control. - * @param [in] state The initial state of the visibility control. + * @param [in] name The name of the new visibility control. + * @param [in] state The initial state of the visibility control. */ void addVisibilityControl(QString const& name, bool state); @@ -431,7 +431,7 @@ private slots: /*! * Sets the tab title of this document. * - * @param [in] title The title text. + * @param [in] title The title text. */ void setTabTitle(QString const& title); diff --git a/common/widgets/tagEditor/FlowLayout.h b/common/widgets/tagEditor/FlowLayout.h index 44799ae4c..a3f220cb7 100644 --- a/common/widgets/tagEditor/FlowLayout.h +++ b/common/widgets/tagEditor/FlowLayout.h @@ -65,19 +65,19 @@ class FlowLayout : public QLayout /*! * The constructor. * - * @param [in] parent The parent widget. - * @param [in] margin Margin around the layout. - * @param [in] hSpacing Horizontal spacing of the items. - * @param [in] vSpacing Vertical spacing of the items. + * @param [in] parent The parent widget. + * @param [in] margin Margin around the layout. + * @param [in] hSpacing Horizontal spacing of the items. + * @param [in] vSpacing Vertical spacing of the items. */ explicit FlowLayout(QWidget *parent, int margin = -1, int hSpacing = -1, int vSpacing = -1); /*! * The constructor. * - * @param [in] margin Margin around the layout. - * @param [in] hSpacing Horizontal spacing of the items. - * @param [in] vSpacing Vertical spacing of the items. + * @param [in] margin Margin around the layout. + * @param [in] hSpacing Horizontal spacing of the items. + * @param [in] vSpacing Vertical spacing of the items. */ explicit FlowLayout(int margin = -1, int hSpacing = -1, int vSpacing = -1); @@ -89,90 +89,90 @@ class FlowLayout : public QLayout /*! * Add a layout item to the layout. * - * @param [in] item The selected layout item. + * @param [in] item The selected layout item. */ void addItem(QLayoutItem *item) override; /*! * Get the current horizontal spacing. * - * @return The current horizontal spacing. + * @return The current horizontal spacing. */ int horizontalSpacing() const; /*! * Get the current vertical spacing. * - * @return The current vertical spacing. + * @return The current vertical spacing. */ int verticalSpacing() const; /*! * Returns the direction in which the layout can use more space than allocated. * - * @return 0. + * @return 0. */ Qt::Orientations expandingDirections() const override; /*! * Checks whether the layouts preferred height depends on width. * - * @return True. + * @return True. */ bool hasHeightForWidth() const override; /*! * Returns the preferred height for the selected width. * - * @param [in] width The selected width. + * @param [in] width The selected width. * - * @return The preferred height for the selected width. + * @return The preferred height for the selected width. */ int heightForWidth(int width) const override; /*! * Get the number of items in the layout. * - * @return The number of items in the layout. + * @return The number of items in the layout. */ int count() const override; /*! * Get the item at the selected index. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return Item at the selected index. + * @return Item at the selected index. */ QLayoutItem *itemAt(int index) const override; /*! * Get the minimum size of this layout. * - * @return The minimum size of this layout. + * @return The minimum size of this layout. */ QSize minimumSize() const override; /*! * Calculates the geometry of the layouts items. * - * @param [in] rect Rectangle of the available area. + * @param [in] rect Rectangle of the available area. */ void setGeometry(const QRect &rect) override; /*! * Get the preferred size of the layout. * - * @return The preferred size of the layout. + * @return The preferred size of the layout. */ QSize sizeHint() const override; /*! * Remove the selected item from the layout. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return The removed item. + * @return The removed item. */ QLayoutItem *takeAt(int index) override; @@ -181,15 +181,15 @@ class FlowLayout : public QLayout /*! * Handles the layout. * - * @param [in] rect Rectangle containing the layout. - * @param [in] testOnly Holds whether the placement is being tested. + * @param [in] rect Rectangle containing the layout. + * @param [in] testOnly Holds whether the placement is being tested. */ int doLayout(const QRect &rect, bool testOnly) const; /*! * Get the default spacing. * - * @param [in] pm The selected pixel metric. + * @param [in] pm The selected pixel metric. */ int smartSpacing(QStyle::PixelMetric pm) const; diff --git a/common/widgets/tagEditor/TagCompleterModel.h b/common/widgets/tagEditor/TagCompleterModel.h index 36b8d23af..3401d5edd 100644 --- a/common/widgets/tagEditor/TagCompleterModel.h +++ b/common/widgets/tagEditor/TagCompleterModel.h @@ -32,8 +32,8 @@ class TagCompleterModel : public QAbstractListModel /*! * The constructor. * - * @param [in] tagData The available tag data. - * @param [in] parent Onwer of this model. + * @param [in] tagData The available tag data. + * @param [in] parent Onwer of this model. */ TagCompleterModel(QVector tagData, QObject* parent = 0); @@ -45,19 +45,19 @@ class TagCompleterModel : public QAbstractListModel /*! * Finds the number of rows in the model. * - * @param [in] parent The parent index whose row count to find. + * @param [in] parent The parent index whose row count to find. * - * @return The number of rows in the model. + * @return The number of rows in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Finds the data in the model for the given index. * - * @param [in] index The index whose data to find. - * @param [in] role The role describing which aspect of the data to find. + * @param [in] index The index whose data to find. + * @param [in] role The role describing which aspect of the data to find. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; @@ -66,14 +66,14 @@ public slots: /*! * Handler for item selection. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. */ void itemSelected(QModelIndex const& index); /*! * Handler for item selection with item number. * - * @param [in] itemIndex Index of the selected item. + * @param [in] itemIndex Index of the selected item. */ void unfilteredItemSelected(int itemIndex); @@ -82,7 +82,7 @@ public slots: /*! * Informs of the color of the selected item. * - * @param [in] itemColor Color of the selected item. + * @param [in] itemColor Color of the selected item. */ void selectedColor(QColor const& itemColor); diff --git a/common/widgets/tagEditor/TagContainer.h b/common/widgets/tagEditor/TagContainer.h index dd8cf7fef..1c51a6946 100644 --- a/common/widgets/tagEditor/TagContainer.h +++ b/common/widgets/tagEditor/TagContainer.h @@ -34,7 +34,7 @@ class TagContainer : public QWidget /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ TagContainer(QWidget* parent); @@ -51,14 +51,14 @@ class TagContainer : public QWidget /*! * Setup the existing tags. * - * @param [in] documentTags The tags of the selected document. + * @param [in] documentTags The tags of the selected document. */ void setupTags(QVector documentTags); /*! * Get the tags. * - * @return A list of the edited document tags. + * @return A list of the edited document tags. */ QVector getTags() const; @@ -74,23 +74,23 @@ protected slots: /*! * Handler for selecting a tag. * - * @param [in] clickedItem The selected tag label. + * @param [in] clickedItem The selected tag label. */ void itemClicked(TagLabel* clickedItem); /*! * Handler for accepting changes made to the selected tag label. * - * @param [in] editedTag The edited tag label. - * @param [in] tagEditor Editor of the selected tag label. + * @param [in] editedTag The edited tag label. + * @param [in] tagEditor Editor of the selected tag label. */ void itemChangesAccepted(TagLabel* editedTag, TagDisplay* tagEditor); /*! * Handler for removing a tag. * - * @param [in] editedTag The edited tag label. - * @param [in] tagEditor Editor of the selected tag label. + * @param [in] editedTag The edited tag label. + * @param [in] tagEditor Editor of the selected tag label. */ void itemDeleted(TagLabel* editedTag, TagDisplay* tagEditor); @@ -106,7 +106,7 @@ private slots: /*! * Connect the selected tag label. * - * @param [in] tagItem The selected tag label. + * @param [in] tagItem The selected tag label. */ void connectTagLabel(QWidget* tagItem); @@ -119,18 +119,18 @@ private slots: /*! * Construct a tag editor for the selected tag label. * - * @param [in] editedLabel The selected tag label. + * @param [in] editedLabel The selected tag label. * - * @return The created tag editor. + * @return The created tag editor. */ virtual TagDisplay* constructTagEditor(TagLabel* editedLabel) = 0; /*! * Check if the selected tag exists. * - * @param [in] editedTag The selected tag. + * @param [in] editedTag The selected tag. * - * @return True, if the tag label exists, false otherwise. + * @return True, if the tag label exists, false otherwise. */ bool tagExists(TagLabel* editedTag) const; diff --git a/common/widgets/tagEditor/TagDisplay.h b/common/widgets/tagEditor/TagDisplay.h index 908a252d1..c0b417fdd 100644 --- a/common/widgets/tagEditor/TagDisplay.h +++ b/common/widgets/tagEditor/TagDisplay.h @@ -32,8 +32,8 @@ class TagDisplay : public QFrame /*! * The constructor. * - * @param [in] tagLabel The tag label being edited. - * @param [in] parent The parent widget. + * @param [in] tagLabel The tag label being edited. + * @param [in] parent The parent widget. */ TagDisplay(TagLabel* tagLabel, QWidget* parent = nullptr); @@ -49,10 +49,10 @@ class TagDisplay : public QFrame /*! * The event filter. * - * @param [in] watched The monitored object. - * @param [in] event The occurring event. + * @param [in] watched The monitored object. + * @param [in] event The occurring event. * - * @return True, if the event is caught, false otherwise. + * @return True, if the event is caught, false otherwise. */ bool eventFilter(QObject *watched, QEvent *event) final; @@ -62,35 +62,35 @@ class TagDisplay : public QFrame /*! * Check if color selection button should be shown. * - * @return True, if button should be shown, otherwise false. + * @return True, if button should be shown, otherwise false. */ virtual bool showColorButton() const noexcept; /*! * Handler for focus out events. * - * @param [in] event The focus event. + * @param [in] event The focus event. */ void focusOutEvent(QFocusEvent* event) final; /*! * Handler for key press events. * - * @param [in] event The key event. + * @param [in] event The key event. */ void keyPressEvent(QKeyEvent *event) final; /*! * Get the color display button. * - * @return The color display button. + * @return The color display button. */ ColorBox* getColorButton(); /*! * Get the edited tag label. * - * @return The edited tag label. + * @return The edited tag label. */ TagLabel* getEditedLabel() const; @@ -102,7 +102,7 @@ class TagDisplay : public QFrame /*! * Setup the tag editors. * - * @param [in] nameEditor The name editor for the tag. + * @param [in] nameEditor The name editor for the tag. */ virtual void setupEditors(QWidget* nameEditor); @@ -111,7 +111,7 @@ protected slots: /*! * Handler for changing color through completer. * - * @param [in] newColor The color of the selected completer item. + * @param [in] newColor The color of the selected completer item. */ void completerColorChange(QColor const& newColor); @@ -120,16 +120,16 @@ protected slots: /*! * Signals the accepted changes made in the editor. * - * @param [in] editedLabel The edited tag label. - * @param [in] tagEditor This editor. + * @param [in] editedLabel The edited tag label. + * @param [in] tagEditor This editor. */ void acceptChanges(TagLabel* editedLabel, TagDisplay* tagEditor); /*! * Signals the removal of this tag label. * - * @param [in] editedLabel The edited tag label. - * @param [in] tagEditor This editor. + * @param [in] editedLabel The edited tag label. + * @param [in] tagEditor This editor. */ void deleteItem(TagLabel* editedLabel, TagDisplay* tagEditor); @@ -150,14 +150,14 @@ private slots: /*! * Setup the layout. * - * @param [in] nameEditor Name editor of the tag. + * @param [in] nameEditor Name editor of the tag. */ void setupLayout(QWidget* nameEditor); /*! * Get the current name from the name editor. * - * @return The current name of the name editor. + * @return The current name of the name editor. */ virtual QString getNewName() const = 0; diff --git a/common/widgets/tagEditor/TagEditor.h b/common/widgets/tagEditor/TagEditor.h index 63b1dc03c..a3c356fae 100644 --- a/common/widgets/tagEditor/TagEditor.h +++ b/common/widgets/tagEditor/TagEditor.h @@ -30,8 +30,8 @@ class TagEditor : public TagDisplay /*! * The constructor. * - * @param [in] tagLabel The tag label being edited. - * @param [in] parent The parent widget. + * @param [in] tagLabel The tag label being edited. + * @param [in] parent The parent widget. */ TagEditor(TagLabel* tagLabel, QWidget* parent = nullptr); @@ -49,7 +49,7 @@ class TagEditor : public TagDisplay /*! * Check if color selection button should be shown. * - * @return True, if button should be shown, otherwise false. + * @return True, if button should be shown, otherwise false. */ bool showColorButton() const noexcept final; @@ -61,7 +61,7 @@ class TagEditor : public TagDisplay /*! * Setup the tag editors. * - * @param [in] nameEditor The name editor for the tag. + * @param [in] nameEditor The name editor for the tag. */ virtual void setupEditors(QWidget* nameEditor); @@ -77,7 +77,7 @@ private slots: /*! * Get the current name from the name editor. * - * @return The current name of the name editor. + * @return The current name of the name editor. */ virtual QString getNewName() const override final; diff --git a/common/widgets/tagEditor/TagEditorContainer.h b/common/widgets/tagEditor/TagEditorContainer.h index c7c666d93..4e5cfe8f7 100644 --- a/common/widgets/tagEditor/TagEditorContainer.h +++ b/common/widgets/tagEditor/TagEditorContainer.h @@ -26,7 +26,7 @@ class TagEditorContainer : public TagContainer /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ TagEditorContainer(QWidget* parent); @@ -44,9 +44,9 @@ class TagEditorContainer : public TagContainer /*! * Construct a tag editor for the selected tag label. * - * @param [in] editedLabel The selected tag label. + * @param [in] editedLabel The selected tag label. * - * @return The created tag editor. + * @return The created tag editor. */ virtual TagDisplay* constructTagEditor(TagLabel* editedLabel) final; }; diff --git a/common/widgets/tagEditor/TagLabel.h b/common/widgets/tagEditor/TagLabel.h index 023abffba..de69ac07c 100644 --- a/common/widgets/tagEditor/TagLabel.h +++ b/common/widgets/tagEditor/TagLabel.h @@ -26,9 +26,9 @@ class TagLabel : public QLabel /*! * The constructor. * - * @param [in] tagName Name of the tag. - * @param [in] parent The parent widget. - * @param [in] labelColor Color of the tag. + * @param [in] tagName Name of the tag. + * @param [in] parent The parent widget. + * @param [in] labelColor Color of the tag. */ TagLabel(QString const& tagName, QWidget* parent = 0, QString const& labelColor = QLatin1String("#DAE1DF")); @@ -42,7 +42,7 @@ class TagLabel : public QLabel /*! * Signal for informing tag label click. * - * @param [in] labelItem This label. + * @param [in] labelItem This label. */ void clicked(TagLabel* labelItem); @@ -51,7 +51,7 @@ class TagLabel : public QLabel /*! * Event handling for mouse release. * - * @param [in] ev The mouse event. + * @param [in] ev The mouse event. */ virtual void mouseReleaseEvent(QMouseEvent *ev) final; diff --git a/common/widgets/tagEditor/TagSelector.h b/common/widgets/tagEditor/TagSelector.h index ce5742b41..ee58eb595 100644 --- a/common/widgets/tagEditor/TagSelector.h +++ b/common/widgets/tagEditor/TagSelector.h @@ -30,8 +30,8 @@ class TagSelector : public TagDisplay /*! * The constructor. * - * @param [in] tagLabel The tag label being edited. - * @param [in] parent The parent widget. + * @param [in] tagLabel The tag label being edited. + * @param [in] parent The parent widget. */ TagSelector(TagLabel* tagLabel, QWidget* parent = 0); @@ -45,7 +45,7 @@ class TagSelector : public TagDisplay /*! * Setup the tag editors. * - * @param [in] nameEditor The name editor for the tag. + * @param [in] nameEditor The name editor for the tag. */ virtual void setupEditors(QWidget* nameEditor); @@ -57,7 +57,7 @@ class TagSelector : public TagDisplay /*! * Get the current name from the name editor. * - * @return The current name of the name editor. + * @return The current name of the name editor. */ virtual QString getNewName() const override final; diff --git a/common/widgets/tagEditor/TagSelectorContainer.h b/common/widgets/tagEditor/TagSelectorContainer.h index 0a1b9d64c..7f5d355bc 100644 --- a/common/widgets/tagEditor/TagSelectorContainer.h +++ b/common/widgets/tagEditor/TagSelectorContainer.h @@ -26,7 +26,7 @@ class TagSelectorContainer : public TagContainer /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ TagSelectorContainer(QWidget* parent); @@ -43,9 +43,9 @@ class TagSelectorContainer : public TagContainer /*! * Construct a tag editor for the selected tag label. * - * @param [in] editedLabel The selected tag label. + * @param [in] editedLabel The selected tag label. * - * @return The created tag editor. + * @return The created tag editor. */ virtual TagDisplay* constructTagEditor(TagLabel* editedLabel) final; }; diff --git a/common/widgets/usageComboBox/usagecombobox.h b/common/widgets/usageComboBox/usagecombobox.h index dcee9db49..ea501ba18 100644 --- a/common/widgets/usageComboBox/usagecombobox.h +++ b/common/widgets/usageComboBox/usagecombobox.h @@ -38,14 +38,14 @@ class UsageComboBox : public QComboBox /*! * Get the currently selected value on the combo box. * - * @return The selected usage value. + * @return The selected usage value. */ General::Usage getCurrentValue() const; /*! * Set the given usage value as the selected value. * - * @param [in] usage The value to select. + * @param [in] usage The value to select. */ void setCurrentValue(General::Usage usage); diff --git a/common/widgets/vlnvDisplayer/vlnvdisplayer.h b/common/widgets/vlnvDisplayer/vlnvdisplayer.h index 7923a940f..0a9013a11 100644 --- a/common/widgets/vlnvDisplayer/vlnvdisplayer.h +++ b/common/widgets/vlnvDisplayer/vlnvdisplayer.h @@ -31,9 +31,9 @@ class VLNVDisplayer : public QGroupBox /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. - * @param [in] vlnv Reference to the vlnv to be displayed - * @param [in] compact A compact VLNV display takes less space. + * @param [in] parent Pointer to the owner of this widget. + * @param [in] vlnv Reference to the vlnv to be displayed + * @param [in] compact A compact VLNV display takes less space. */ VLNVDisplayer(QWidget *parent, VLNV const& vlnv, bool compact = false); @@ -45,14 +45,14 @@ class VLNVDisplayer : public QGroupBox /*! * Set the vlnv to be displayed in the widget. * - * @param [in] vlnv Reference to the VLNV to be displayed + * @param [in] vlnv Reference to the VLNV to be displayed */ void setVLNV(const VLNV& vlnv); /*! * Also display path along with the vlnv in the widget. * - * @param [in] path The path to display + * @param [in] path The path to display */ void setPath(const QString& path); diff --git a/common/widgets/vlnvEditor/VLNVContentMatcher.h b/common/widgets/vlnvEditor/VLNVContentMatcher.h index fd084270d..30497c1b8 100644 --- a/common/widgets/vlnvEditor/VLNVContentMatcher.h +++ b/common/widgets/vlnvEditor/VLNVContentMatcher.h @@ -45,22 +45,22 @@ class VLNVContentMatcher : public ILineContentMatcher /*! * Looks forward for matching contents in the given text. * - * @param [in] text The text. + * @param [in] text The text. * - * @return True, if there is a match. Otherwise false. + * @return True, if there is a match. Otherwise false. */ bool lookForwardMatch(QString const& text); /*! * Fills the content assist with content based on the given text. * - * @param [in] text The text. - * @param [in] assist The content assist to fill with content. - * @param [out] startIndex The start index of the selection to which the content applies. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. + * @param [in] text The text. + * @param [in] assist The content assist to fill with content. + * @param [out] startIndex The start index of the selection to which the content applies. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. * - * @return True, if content was found; otherwise false. + * @return True, if content was found; otherwise false. */ bool fillWithContent(QString const& text, LineContentAssistWidget& assist, int& startIndex, QString& toolTipText, int& toolTipIndex); @@ -74,10 +74,10 @@ class VLNVContentMatcher : public ILineContentMatcher * Enumerates matches based on the string. If the content assist is specified, the matching * contents is also added to it. * - * @param [in] text The text to which to match content. - * @param [in] assist The content assist to fill with content. Can be null. + * @param [in] text The text to which to match content. + * @param [in] assist The content assist to fill with content. Can be null. * - * @return True, if there was content found; otherwise false. + * @return True, if there was content found; otherwise false. */ bool enumerateMatches(QString const& text, LineContentAssistWidget* assist) const; diff --git a/common/widgets/vlnvEditor/VLNVDataTree.h b/common/widgets/vlnvEditor/VLNVDataTree.h index 8898258bd..8dca4c6e1 100644 --- a/common/widgets/vlnvEditor/VLNVDataTree.h +++ b/common/widgets/vlnvEditor/VLNVDataTree.h @@ -57,7 +57,7 @@ class VLNVDataNode /*! * Returns the child with the given name or null if not found. * - * @param [in] name The name of the child to search for. + * @param [in] name The name of the child to search for. */ VLNVDataNode* findChild(QString const& name) const; @@ -70,30 +70,30 @@ class VLNVDataNode /*! * Get the number of children the node has. * - * @return The number of children. + * @return The number of children. */ int getChildCount() const; /*! * Sets the VLNV for the node. * - * @param [in] vlnv The vlnv to set. + * @param [in] vlnv The vlnv to set. */ void setVLNV(VLNV const& vlnv); /*! * Adds a child to the node. * - * @param [in] name The name of the child. + * @param [in] name The name of the child. * - * @return The created child node. + * @return The created child node. */ VLNVDataNode* addChild(QString const& name); /*! * Removes the child with the given name. * - * @param [in] name The name of the child. + * @param [in] name The name of the child. */ void removeChild(QString const& name); @@ -138,8 +138,8 @@ class VLNVDataTree : public VLNVDataNode /*! * Updates the tree based on the filters and the given library interface. * - * @param [in] lh The library interface. - * @param [in] type The allowed document types. + * @param [in] lh The library interface. + * @param [in] type The allowed document types. */ void parse(LibraryInterface* lh, QList const& types); @@ -151,39 +151,39 @@ class VLNVDataTree : public VLNVDataNode /*! * Sets the firmness filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] firmness The allowed firmness. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] firmness The allowed firmness. */ void setFirmnessFilter(bool on, KactusAttribute::Firmness firmness = KactusAttribute::TEMPLATE); /*! * Sets the product hierarchy filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] productHier The allowed product hierarchy. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] productHier The allowed product hierarchy. */ void setHierarchyFilter(bool on, KactusAttribute::ProductHierarchy productHier = KactusAttribute::IP); /*! * Sets the implementation filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] implementation The allowed implementation. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] implementation The allowed implementation. */ void setImplementationFilter(bool on, KactusAttribute::Implementation implementation = KactusAttribute::HW); /*! * Sets the IP-XACT revision filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] revision The allowed IP-XACT standard revision. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] revision The allowed IP-XACT standard revision. */ void setRevisionFilter(bool on, Document::Revision revision = Document::Revision::Std22); /*! * Adds an extension to be filtered out from the content search results. * - * @param [in] extension The extension to filter out. + * @param [in] extension The extension to filter out. */ void addExtensionFilter(QString const& extension); @@ -193,8 +193,8 @@ class VLNVDataTree : public VLNVDataNode * Parses the library subtree indicated by the given library item and adds matching names * to the given data node. * - * @param [in] libItem The library item containing the subtree. - * @param [in] node The target data node. + * @param [in] libItem The library item containing the subtree. + * @param [in] node The target data node. */ void parseSubtree(LibraryInterface* lh, LibraryItem const* libItem, VLNVDataNode& node, QList const& types); diff --git a/common/widgets/vlnvEditor/vlnveditor.h b/common/widgets/vlnvEditor/vlnveditor.h index 747fa6818..e036c6476 100644 --- a/common/widgets/vlnvEditor/vlnveditor.h +++ b/common/widgets/vlnvEditor/vlnveditor.h @@ -40,10 +40,10 @@ class VLNVEditor : public QGroupBox /*! * The constructor. * - * @param [in] type The VLNV type which to edit. - * @param [in] libHandler The library handler. - * @param [in] parentWnd The parent window (having a title bar). - * @param [in] parent The parent widget. + * @param [in] type The VLNV type which to edit. + * @param [in] libHandler The library handler. + * @param [in] parentWnd The parent window (having a title bar). + * @param [in] parent The parent widget. */ VLNVEditor(VLNV::IPXactType type, LibraryInterface* libHandler, QWidget* parentWnd = 0, QWidget* parent = 0); @@ -60,24 +60,24 @@ class VLNVEditor : public QGroupBox /*! * Sets the firmness filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] firmness The allowed firmness. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] firmness The allowed firmness. */ void setFirmnessFilter(bool on, KactusAttribute::Firmness firmness = KactusAttribute::TEMPLATE); /*! * Sets the product hierarchy filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] productHier The allowed product hierarchy. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] productHier The allowed product hierarchy. */ void setHierarchyFilter(bool on, KactusAttribute::ProductHierarchy productHier = KactusAttribute::IP); /*! * Sets the implementation filter on/off. * - * @param [in] on If true, the filter is turned on; otherwise it is turned off. - * @param [in] implementation The allowed implementation. + * @param [in] on If true, the filter is turned on; otherwise it is turned off. + * @param [in] implementation The allowed implementation. */ void setImplementationFilter(bool on, KactusAttribute::Implementation implementation = KactusAttribute::HW); @@ -86,7 +86,7 @@ class VLNVEditor : public QGroupBox /*! * Adds a new name extension that will be shown in the dialog. * - * @param [in] extension The extension to add. + * @param [in] extension The extension to add. */ void addNameExtension(QString const& extension); @@ -120,7 +120,7 @@ class VLNVEditor : public QGroupBox /*! * Emitted when a vlnv for abstraction definition is dropped to this editor. * - * @param [in] busDefVLNV The vlnv of the matching bus definition. + * @param [in] busDefVLNV The vlnv of the matching bus definition. */ void setBusDef(const VLNV& busDefVLNV); @@ -128,7 +128,7 @@ class VLNVEditor : public QGroupBox * Emitted when a vlnv for bus definition is dropped to this editor. If there are several matching * abstraction definitions then this is not emitted. * - * @param [in] absDefVLNV Identifies the vlnv of matching abstraction definition. + * @param [in] absDefVLNV Identifies the vlnv of matching abstraction definition. */ void setAbsDef(const VLNV& absDefVLNV); @@ -137,7 +137,7 @@ public slots: /*! * Set the widget to be mandatory or not. The default setting is mandatory on. * - * @param [in] mandatory If true then all 4 vlnv fields are displayed as mandatory fields. + * @param [in] mandatory If true then all 4 vlnv fields are displayed as mandatory fields. */ void setMandatory(bool mandatory); @@ -198,21 +198,21 @@ public slots: /*! * Handler for drop events on drag & drop * - * @param [in] event Pointer to the drop event. + * @param [in] event Pointer to the drop event. */ virtual void dropEvent(QDropEvent* event); /*! * Handler for drag enter events in drag & drop. * - * @param [in] event Pointer to the event. + * @param [in] event Pointer to the event. */ virtual void dragEnterEvent(QDragEnterEvent* event); /*! * Handler for the show event. * - * @param [in] event Pointer to the show event. + * @param [in] event Pointer to the show event. */ virtual void showEvent(QShowEvent* event); @@ -236,7 +236,7 @@ private slots: /*! * Initializes the widgets of the vlnv editor. * - * @param [in] parentWnd The parent window. + * @param [in] parentWnd The parent window. */ void initWidgets(QWidget* parentWnd); diff --git a/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceCounter.h b/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceCounter.h index 68f1b1bb9..69d507fce 100644 --- a/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceCounter.h +++ b/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceCounter.h @@ -30,8 +30,8 @@ class AbsDefParameterReferenceCounter : public ParameterReferenceCounter /*! * The constructor. * - * @param [in] parameterFinder The parameter finder to use. - * @param [in] absDef The abstraction definition whose parameter usage is calculated. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] absDef The abstraction definition whose parameter usage is calculated. */ AbsDefParameterReferenceCounter(QSharedPointer parameterFinder, QSharedPointer absDef); @@ -43,14 +43,14 @@ class AbsDefParameterReferenceCounter : public ParameterReferenceCounter /*! * Set a new abstraction definition. * - * @param [in] absDef The new abstraction definition. + * @param [in] absDef The new abstraction definition. */ void setAbstractionDefinition(QSharedPointer absDef); /*! * Count references to abs def parameters in wire ports. * - * @param [in] parameterID The parameter ID to look for. + * @param [in] parameterID The parameter ID to look for. * * @return The parameter usage count in wire ports. */ @@ -59,7 +59,7 @@ class AbsDefParameterReferenceCounter : public ParameterReferenceCounter /*! * Count references to abs def parameters in transactional ports. * - * @param [in] parameterID The parameter ID to look for. + * @param [in] parameterID The parameter ID to look for. * * @return The parameter usage count in transactional ports. */ @@ -68,8 +68,8 @@ class AbsDefParameterReferenceCounter : public ParameterReferenceCounter /*! * Count references to abs def parameters in a single wire port. * - * @param [in] parameterID The parameter ID to look for. - * @param [in] wirePort The wire port to look into. + * @param [in] parameterID The parameter ID to look for. + * @param [in] wirePort The wire port to look into. * * @return The parameter usage count in the wire port. */ @@ -78,8 +78,8 @@ class AbsDefParameterReferenceCounter : public ParameterReferenceCounter /*! * Count references to abs def parameters in a single transactional port. * - * @param [in] parameterID The parameter ID to look for. - * @param [in] transactional The transactional port to look into. + * @param [in] parameterID The parameter ID to look for. + * @param [in] transactional The transactional port to look into. * * @return The parameter usage count in the transactional port. */ @@ -90,8 +90,8 @@ public slots: /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ virtual void recalculateReferencesToParameters(QStringList const& parameterList, AbstractParameterInterface* parameterInterface) override; diff --git a/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceTree.h b/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceTree.h index bc574720a..59bd08332 100644 --- a/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceTree.h +++ b/editors/AbstractionDefinitionEditor/AbsDefParameterReferenceTree.h @@ -26,9 +26,9 @@ class AbsDefParameterReferenceTree : public ParameterReferenceTree /*! * The constructor. * - * @param [in] absDef The abstraction definition. - * @param [in] referenceCounter The reference counter to use. - * @param [in] expressionFormatter The expression formatter to use. + * @param [in] absDef The abstraction definition. + * @param [in] referenceCounter The reference counter to use. + * @param [in] expressionFormatter The expression formatter to use. */ AbsDefParameterReferenceTree(QSharedPointer absDef, QSharedPointer referenceCounter, @@ -42,7 +42,7 @@ class AbsDefParameterReferenceTree : public ParameterReferenceTree /*! * Set a new abstraction definition. * - * @param [in] absDef The abstraction definition to set. + * @param [in] absDef The abstraction definition to set. */ void setAbsDef(QSharedPointer absDef); diff --git a/editors/AbstractionDefinitionEditor/AbstractionDefinitionEditor.h b/editors/AbstractionDefinitionEditor/AbstractionDefinitionEditor.h index b6282dc99..90e1c3bf1 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionDefinitionEditor.h +++ b/editors/AbstractionDefinitionEditor/AbstractionDefinitionEditor.h @@ -46,10 +46,10 @@ class AbstractionDefinitionEditor : public TabDocument /*! * The constructor. * - * @param [in] parent The owner of this widget. - * @param [in] libHandler The instance that manages library. - * @param [in] busDef The bus definition to edit. - * @param [in] revision Currently active IP-XACT revision. + * @param [in] parent The owner of this widget. + * @param [in] libHandler The instance that manages library. + * @param [in] busDef The bus definition to edit. + * @param [in] revision Currently active IP-XACT revision. */ AbstractionDefinitionEditor(QWidget *parent, LibraryInterface* libHandler, QSharedPointer absDef, Document::Revision revision); @@ -65,7 +65,7 @@ class AbstractionDefinitionEditor : public TabDocument /*! * Get the VLNV that can be used to identify the Bus. * - * @return The VLNV that identifies the Bus. + * @return The VLNV that identifies the Bus. */ VLNV getIdentifyingVLNV() const override; @@ -77,21 +77,21 @@ class AbstractionDefinitionEditor : public TabDocument /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ void setProtection(bool locked) override; /*! * Get the vlnv of the current bus definition. * - * @return VLNV of the bus definition/abstraction definition being edited. + * @return VLNV of the bus definition/abstraction definition being edited. */ VLNV getDocumentVLNV() const override; /*! * Sets the edited abstraction definition. * - * @param [in] absDef The bus definition to set. Must not be NULL. + * @param [in] absDef The bus definition to set. Must not be NULL. */ void setAbsDef(QSharedPointer absDef); @@ -101,9 +101,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); @@ -122,8 +122,8 @@ public slots: /*! * Inform that a port abstraction has been removed. * - * @param [in] portName Name of the removed port abstraction. - * @param [in] mode Mode of the removed port abstraction. + * @param [in] portName Name of the removed port abstraction. + * @param [in] mode Mode of the removed port abstraction. */ void portRemoved(QString const& portName, General::InterfaceMode const mode); @@ -132,7 +132,7 @@ public slots: /*! * Called when the editor is shown. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event); @@ -150,7 +150,7 @@ private slots: /*! * Create interface for accessing port abstractions. * - * @return Interface for accessing port abstractions. + * @return Interface for accessing port abstractions. */ PortAbstractionInterface* createPortAbstractionInterface(); diff --git a/editors/AbstractionDefinitionEditor/AbstractionDefinitionPortsSortFilter.h b/editors/AbstractionDefinitionEditor/AbstractionDefinitionPortsSortFilter.h index 0bf156fc3..9352b87a0 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionDefinitionPortsSortFilter.h +++ b/editors/AbstractionDefinitionEditor/AbstractionDefinitionPortsSortFilter.h @@ -28,7 +28,7 @@ class AbstractionDefinitionPortsSortFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ AbstractionDefinitionPortsSortFilter( PortAbstractionInterface* portInterface, QObject *parent); @@ -41,10 +41,10 @@ class AbstractionDefinitionPortsSortFilter : public QSortFilterProxyModel /*! * Get the data for the specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant contains the data for the item. + * @return QVariant contains the data for the item. */ virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; @@ -53,9 +53,9 @@ class AbstractionDefinitionPortsSortFilter : public QSortFilterProxyModel /*! * Get the background color for the selected index. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return Background color for the selected index. + * @return Background color for the selected index. */ virtual QColor getBackgroundColorForIndex(QModelIndex const& index) const; @@ -70,28 +70,28 @@ class AbstractionDefinitionPortsSortFilter : public QSortFilterProxyModel /*! * Check if the system group column is mandatory for the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the system group is mandatory, false otherwise. + * @return True, if the system group is mandatory, false otherwise. */ bool isSystemGroupMandatory(QModelIndex const& index) const; /*! * Check if the selected signal has an undefined mode. * - * @param [in] index Model index of the selected signal. + * @param [in] index Model index of the selected signal. * - * @return True, if the selected signal has an undefined mode, false otherwise. + * @return True, if the selected signal has an undefined mode, false otherwise. */ bool undefinedMode(QModelIndex const& index) const; /*! * Get the background colour on the previous row of the selected index. * - * @param [in] previousRow The previous row. - * @param [in] index The selected index. + * @param [in] previousRow The previous row. + * @param [in] index The selected index. * - * @return Background colour of the previous row. + * @return Background colour of the previous row. */ QColor getPreviousColor(int const& previousRow, QModelIndex const& index) const; diff --git a/editors/AbstractionDefinitionEditor/AbstractionDefinitionSignalRow.h b/editors/AbstractionDefinitionEditor/AbstractionDefinitionSignalRow.h index 8aea3e103..4a27327d8 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionDefinitionSignalRow.h +++ b/editors/AbstractionDefinitionEditor/AbstractionDefinitionSignalRow.h @@ -46,129 +46,129 @@ class AbstractionDefinitionSignalRow /*! * Comparison of two SignalRows. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if the SignalRows are equal, otherwise false. + * @return True, if the SignalRows are equal, otherwise false. */ bool operator==(AbstractionDefinitionSignalRow const& other) const; /*! * Comparison of two SignalRows. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if the SignalRows are not equal, otherwise false. + * @return True, if the SignalRows are not equal, otherwise false. */ bool operator!=(AbstractionDefinitionSignalRow const& other) const; /*! * Less than comparison of two SignalRows for table ordering. * - * @param [in] other The SignalRow to compare this to. + * @param [in] other The SignalRow to compare this to. * - * @return True, if this precedes other, otherwise false. + * @return True, if this precedes other, otherwise false. */ bool operator<(AbstractionDefinitionSignalRow const& other) const; /*! * Get the current system group of the selected signal. * - * @param [in] signal The selected signal. + * @param [in] signal The selected signal. * - * @return The system group of the selected signal. + * @return The system group of the selected signal. */ QString getSystemGroup() const; /*! * Check if the compared signal is of the same type. * - * @param [in] comparisonSignal The selected comparison signal. + * @param [in] comparisonSignal The selected comparison signal. * - * @return True, if the signals are of the same type, false otherwise. + * @return True, if the signals are of the same type, false otherwise. */ bool comparedSignalIsSameType(AbstractionDefinitionSignalRow const& comparisonSignal) const; /*! * Get the current interface mode. * - * @return The current interface mode. + * @return The current interface mode. */ General::InterfaceMode getMode() const; /*! * Set the interface mode. * - * @param [in] newMode The new interface mode. + * @param [in] newMode The new interface mode. */ void setMode(General::InterfaceMode const& newMode); /*! * Get the port abstraction. * - * @return The port abstraction. + * @return The port abstraction. */ QSharedPointer getPortAbstraction() const; /*! * Set the port abstraction. * - * @param [in] newAbstraction The new port abstraction. + * @param [in] newAbstraction The new port abstraction. */ void setPortAbstraction(QSharedPointer newAbstraction); /*! * Get the wire port. * - * @return The wire port. + * @return The wire port. */ QSharedPointer getWire() const; /*! * Set the wire port. * - * @param[in] newWire The new wire port. + * @param[in] newWire The new wire port. */ void setWire(QSharedPointer newWire); /*! * Get the transactional port. * - * @return The transactional port. + * @return The transactional port. */ QSharedPointer getTransactional() const; /*! * Set the transactional port. * - * @param [in] newTRansactional The new transactional port. + * @param [in] newTRansactional The new transactional port. */ void setTransactional(QSharedPointer newTransactional); /*! * Check if the extend data is locked. * - * @return True, if the extend data is locked, false otherwise. + * @return True, if the extend data is locked, false otherwise. */ bool isExtendDataLocked() const; /*! * Set the lock flag for extend data. * - * @param [in] newLockStatus New extend lock flag. + * @param [in] newLockStatus New extend lock flag. */ void lockExtendData(bool newLockStatus); /*! * Check if the port data is locked. * - * @return True, if the port data is locked, false otherwise. + * @return True, if the port data is locked, false otherwise. */ bool isPortDataLocked() const; /*! * Set the lock flag for port data. * - * @param [in] newLockStatus New port data lock flag. + * @param [in] newLockStatus New port data lock flag. */ void lockPortData(bool newLockStatus); diff --git a/editors/AbstractionDefinitionEditor/AbstractionPortsDelegate.h b/editors/AbstractionDefinitionEditor/AbstractionPortsDelegate.h index 0911ab264..1b3c968b6 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionPortsDelegate.h +++ b/editors/AbstractionDefinitionEditor/AbstractionPortsDelegate.h @@ -35,11 +35,11 @@ class AbstractionPortsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] parametersModel The parameter completer model to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] libraryAccess Interface to the library. - * @param [in] stdRevision The revision of the standard used by the abstraction definition. - * @param [in] parent The owner of this instance + * @param [in] parametersModel The parameter completer model to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] libraryAccess Interface to the library. + * @param [in] stdRevision The revision of the standard used by the abstraction definition. + * @param [in] parent The owner of this instance */ AbstractionPortsDelegate(QAbstractItemModel* parametersModel, QSharedPointer parameterFinder, LibraryInterface* libraryAcces, Document::Revision stdRevision, QObject *parent); @@ -52,11 +52,11 @@ class AbstractionPortsDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -64,33 +64,33 @@ class AbstractionPortsDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Set the bus definition referenced by the edited abstraction definition. * - * @param [in] busDefinition The referenced bus definition. + * @param [in] busDefinition The referenced bus definition. */ void setBusDef(QSharedPointer busDefinition); /*! * Updates the qualifier editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option, const QModelIndex& index) const override; @@ -111,25 +111,25 @@ protected slots: /*! * Get the list of available qualifier values. * - * @return The list of available qualifier values. + * @return The list of available qualifier values. */ virtual QStringList getQualifierList() const; /*! * Check if the editor used in the selected index column is a line editor. * - * @param [in] indexColumn The selected index column. + * @param [in] indexColumn The selected index column. * - * @return True, if the editor used in the selected column is a line editor, false otherwise. + * @return True, if the editor used in the selected column is a line editor, false otherwise. */ virtual bool editorIsLineEditor(int indexColumn) const; /*! * Check if the editor used in the selected index column is a combo box editor. * - * @param [in] indexColumn The selected index column. + * @param [in] indexColumn The selected index column. * - * @return True, if the editor used in the selected column is a combo box editor, false otherwise. + * @return True, if the editor used in the selected column is a combo box editor, false otherwise. */ virtual bool editorIsComboBox(int indexColumn) const; diff --git a/editors/AbstractionDefinitionEditor/AbstractionPortsEditor.h b/editors/AbstractionDefinitionEditor/AbstractionPortsEditor.h index 2ba0b18ef..ebb98cc0c 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionPortsEditor.h +++ b/editors/AbstractionDefinitionEditor/AbstractionPortsEditor.h @@ -44,14 +44,14 @@ class AbstractionPortsEditor : public QWidget /*! * The constructor. * - * @param [in] parametersModel The parameter completer model to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] libraryAccess Interface to the library. - * @param [in] portInterface Interface for accessing port abstractions. - * @param [in] stdRevision The revision of the standard used by the abstraction definition. - * @param [in] portsModel Model for this editor. - * @param [in] type The type of ports the editor is targeted for: wire or transactional. - * @param [in] parent The owner of the editor. + * @param [in] parametersModel The parameter completer model to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] libraryAccess Interface to the library. + * @param [in] portInterface Interface for accessing port abstractions. + * @param [in] stdRevision The revision of the standard used by the abstraction definition. + * @param [in] portsModel Model for this editor. + * @param [in] type The type of ports the editor is targeted for: wire or transactional. + * @param [in] parent The owner of the editor. */ AbstractionPortsEditor(QAbstractItemModel* parametersModel, QSharedPointer parameterFinder, LibraryInterface* libraryAccess, PortAbstractionInterface* portInterface, @@ -71,14 +71,14 @@ class AbstractionPortsEditor : public QWidget /*! * Set the bus definition referenced by the abstraction definition. * - * @param [in] busDefinition The referenced bus definition. + * @param [in] busDefinition The referenced bus definition. */ void setBusDef(QSharedPointer busDefinition); /*! * Setup the editor according to document standard revision. * - * @param [in] revision The standard revision the abstraction definition is using. + * @param [in] revision The standard revision the abstraction definition is using. */ void setStdRevision(Document::Revision revision); @@ -102,22 +102,22 @@ class AbstractionPortsEditor : public QWidget /*! * Inform that a port abstraction has been removed. * - * @param [in] portName Name of the removed port abstraction. - * @param [in] mode Mode of the removed port abstraction. + * @param [in] portName Name of the removed port abstraction. + * @param [in] mode Mode of the removed port abstraction. */ void portRemoved(QString const& portName, General::InterfaceMode const mode); /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); @@ -157,7 +157,7 @@ private slots: /*! * Get a list of the selected indexes. * - * @return List of the selected indexes. + * @return List of the selected indexes. */ QModelIndexList getSelectedIndexes(); diff --git a/editors/AbstractionDefinitionEditor/AbstractionPortsModel.h b/editors/AbstractionDefinitionEditor/AbstractionPortsModel.h index 440a2011e..14a656f40 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionPortsModel.h +++ b/editors/AbstractionDefinitionEditor/AbstractionPortsModel.h @@ -57,12 +57,12 @@ class AbstractionPortsModel : public ReferencingTableModel, public Parameterizab /*! * The constructor. * - * @param [in] parameterFinder The parameter finder to use. - * @param [in] expressionParser The expression parser to use. - * @param [in] libraryAccess Interface to the library. - * @param [in] portInterface The port abstraction interface to use. - * @param [in] extendInterface The port abstraction interface to use for extended abstractions. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] expressionParser The expression parser to use. + * @param [in] libraryAccess Interface to the library. + * @param [in] portInterface The port abstraction interface to use. + * @param [in] extendInterface The port abstraction interface to use for extended abstractions. + * @param [in] parent Pointer to the owner of this model. */ AbstractionPortsModel(QSharedPointer parameterFinder, QSharedPointer expressionParser, LibraryInterface* libraryAccess, @@ -81,67 +81,67 @@ class AbstractionPortsModel : public ReferencingTableModel, public Parameterizab /*! * Get the number of rows an item contains. * - * @param [in] parent This should always be invalid model index. + * @param [in] parent This should always be invalid model index. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the model contains. * - * @param [in] parent This should always be invalid model index. + * @param [in] parent This should always be invalid model index. * - * @return Always returns 9 for invalid model indexes. + * @return Always returns 9 for invalid model indexes. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specifies if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specifies if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant contains the requested data. + * @return QVariant contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for the specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant contains the data for the item. + * @return QVariant contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Save the qualifier data to the IPXACT model. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. */ void setQualifierData(QModelIndex const& index, QVariant const& value); @@ -158,7 +158,7 @@ class AbstractionPortsModel : public ReferencingTableModel, public Parameterizab /*! * Set the bus definition for the model. * - * @param [in] busDefinition The bus definition to set. + * @param [in] busDefinition The bus definition to set. */ void setBusDef(QSharedPointer busDefinition); @@ -179,35 +179,35 @@ public slots: /*! * Adds the master mode for the selected ports. * - * @param [in] indexes Indexes of the selected ports. + * @param [in] indexes Indexes of the selected ports. */ void addMaster(QModelIndexList const& indexes); /*! * Adds the slave mode for the selected ports. * - * @param [in] indexes Indexes of the selected ports. + * @param [in] indexes Indexes of the selected ports. */ void addSlave(QModelIndexList const& indexes); /*! * Adds a system mode for the selected ports. * - * @param [in] indexes Indexes of the selected ports. + * @param [in] indexes Indexes of the selected ports. */ void addSystem(QModelIndexList const& indexes); /*! * Adds all the unconnected system groups for the selected ports. * - * @param [in] indexes Indexes of the selected ports. + * @param [in] indexes Indexes of the selected ports. */ void addAllSystems(QModelIndexList const& indexes); /*! * Remove the item with the given index. * - * @param [in] index The index where to remove the item. + * @param [in] index The index where to remove the item. */ void onRemoveItem(QModelIndex const& index); @@ -226,22 +226,22 @@ public slots: /*! * Sends error message to be printed for the user. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(QString const& msg); /*! * Sends notification to be printed to user. * - * @param [in] msg The notification message. + * @param [in] msg The notification message. */ void noticeMessage(QString const& msg); /*! * Inform that a port abstraction has been removed. * - * @param [in] portName The port name. - * @param [in] mode The interface mode. + * @param [in] portName The port name. + * @param [in] mode The interface mode. */ void portRemoved(QString const& portName, const General::InterfaceMode mode); @@ -250,27 +250,27 @@ public slots: /*! * Check if the given index is locked and cannot be edited. * - * @param [in] index The index to check. + * @param [in] index The index to check. * - * @return True, if the index is locked, otherwise false. + * @return True, if the index is locked, otherwise false. */ bool isLocked(QModelIndex const& index) const; /*! * Check if the given row is from extended abstractions. * - * @param [in] row The row number to check. + * @param [in] row The row number to check. * - * @return True, if the given row is extended, otherwise false. + * @return True, if the given row is extended, otherwise false. */ bool isExtendedRow(int row) const; /*! * Add definitions for extended wire. * - * @param [in] port Name of the port to extend. - * @param [in] mode Mode of the port to extend. - * @param [in] systemGroup System group of the port to extend. + * @param [in] port Name of the port to extend. + * @param [in] mode Mode of the port to extend. + * @param [in] systemGroup System group of the port to extend. * */ void extendWireMode(std::string const& port, General::InterfaceMode mode, @@ -279,9 +279,9 @@ public slots: /*! * Add definitions for extended transcational port. * - * @param [in] port Name of the port to extend. - * @param [in] mode Mode of the port to extend. - * @param [in] systemGroup System group of the port to extend. + * @param [in] port Name of the port to extend. + * @param [in] mode Mode of the port to extend. + * @param [in] systemGroup System group of the port to extend. * */ void extendTransactionalMode(std::string const& port, General::InterfaceMode mode, @@ -290,15 +290,15 @@ public slots: /*! * Send change data signals for all the affected items. * - * @param [in] changedIndexes List of all the changed model indexes. + * @param [in] changedIndexes List of all the changed model indexes. */ void sendDataChangeForAllChangedItems(QModelIndexList changedIndexes); /*! * Create new master or slave signals for the selected ports. * - * @param [in] newSignalMode The new interface mode. - * @param [in] selection Indexes of the selected ports. + * @param [in] newSignalMode The new interface mode. + * @param [in] selection Indexes of the selected ports. */ void createNewSignal(General::InterfaceMode newSignalMode, QModelIndexList const& selection); @@ -307,9 +307,9 @@ public slots: /*! * Get the missing system groups for the selected port. * - * @param [in] signal Signal of the selected port. + * @param [in] signal Signal of the selected port. * - * @return The system groups that have not been connected to the system signals of the selected port. + * @return The system groups that have not been connected to the system signals of the selected port. */ QStringList getMissingSystemGroupsForSignal(int const& signalIndex) const; @@ -317,25 +317,25 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ QVariant expressionOrValueForIndex(QModelIndex const& index) const final; /*! * Get the unformatted expression for a selected index. * - * @param [in] index Index to get the expression of. + * @param [in] index Index to get the expression of. * * @return The unformatted expression. */ @@ -344,35 +344,35 @@ public slots: /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const final; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; /*! * Get the value for the corresponding index. * - * @param [in] index The index whose value is being searched for. + * @param [in] index The index whose value is being searched for. */ QVariant valueForIndex(const QModelIndex& index) const; /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ QVariant formattedExpressionForIndex(QModelIndex const& index) const; diff --git a/editors/AbstractionDefinitionEditor/AbstractionPortsView.h b/editors/AbstractionDefinitionEditor/AbstractionPortsView.h index a31fbeb34..07796d637 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionPortsView.h +++ b/editors/AbstractionDefinitionEditor/AbstractionPortsView.h @@ -32,7 +32,7 @@ class AbstractionPortsView : public EditableTableView /*! * The constructor. * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ AbstractionPortsView(QWidget* parent); @@ -44,7 +44,7 @@ class AbstractionPortsView : public EditableTableView /*! * Get list of currently selected indexes. * - * @return The model indexes of the selected items. + * @return The model indexes of the selected items. */ QModelIndexList selected() const; diff --git a/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsDelegate.h b/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsDelegate.h index c7e6877e5..4126090f5 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsDelegate.h +++ b/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsDelegate.h @@ -27,11 +27,11 @@ class AbstractionTransactionalPortsDelegate : public AbstractionPortsDelegate /*! * The constructor. * - * @param [in] parametersModel The parameter completer model to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] libraryAccess Interface to the library. - * @param [in] stdRevision The standard revision used by the abstraction definition. - * @param [in] parent The owner of this instance + * @param [in] parametersModel The parameter completer model to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] libraryAccess Interface to the library. + * @param [in] stdRevision The standard revision used by the abstraction definition. + * @param [in] parent The owner of this instance */ AbstractionTransactionalPortsDelegate(QAbstractItemModel* parametersModel, QSharedPointer parameterFinder, LibraryInterface* libraryAccess, @@ -45,11 +45,11 @@ class AbstractionTransactionalPortsDelegate : public AbstractionPortsDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -63,9 +63,9 @@ class AbstractionTransactionalPortsDelegate : public AbstractionPortsDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const final; diff --git a/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsSortFilter.h b/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsSortFilter.h index 4d54358a3..97647d2ba 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsSortFilter.h +++ b/editors/AbstractionDefinitionEditor/AbstractionTransactionalPortsSortFilter.h @@ -28,8 +28,8 @@ class AbstractionTransactionalPortsSortFilter : public AbstractionDefinitionPort /*! * The constructor. * - * @param [in] portInterface Interface for accessing port abstractions. - * @param [in] parent Pointer to the owner of this model. + * @param [in] portInterface Interface for accessing port abstractions. + * @param [in] parent Pointer to the owner of this model. */ AbstractionTransactionalPortsSortFilter( PortAbstractionInterface* portInterface, QObject *parent); @@ -44,19 +44,19 @@ class AbstractionTransactionalPortsSortFilter : public AbstractionDefinitionPort /*! * Get the background color for the selected index. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return Background color for the selected index. + * @return Background color for the selected index. */ virtual QColor getBackgroundColorForIndex(QModelIndex const& index) const; /*! * Check if the filter should accept the selected row. * - * @param [in] source_row Row of the selected item. - * @param [in] source_parent Parent index of the item. + * @param [in] source_row Row of the selected item. + * @param [in] source_parent Parent index of the item. * - * @return True, if the row is accepted, false otherwise. + * @return True, if the row is accepted, false otherwise. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override final; @@ -68,9 +68,9 @@ class AbstractionTransactionalPortsSortFilter : public AbstractionDefinitionPort /*! * Check if the indexed row contains a protocol payload. * - * @param [in] index Index of the selected row. + * @param [in] index Index of the selected row. * - * @return True, if the indexed row contains a protocol payload, false otherwise. + * @return True, if the indexed row contains a protocol payload, false otherwise. */ bool indexedRowContainsPayload(QModelIndex const& index) const; }; diff --git a/editors/AbstractionDefinitionEditor/AbstractionWirePortsDelegate.h b/editors/AbstractionDefinitionEditor/AbstractionWirePortsDelegate.h index e5cb32c8f..0850a94ce 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionWirePortsDelegate.h +++ b/editors/AbstractionDefinitionEditor/AbstractionWirePortsDelegate.h @@ -26,11 +26,11 @@ class AbstractionWirePortsDelegate : public AbstractionPortsDelegate /*! * The constructor. * - * @param [in] parametersModel The parameter completer model to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] libraryAccess Interface to the library. - * @param [in] stdRevision The standard revision used by the abstraction definition. - * @param [in] parent The owner of this instance + * @param [in] parametersModel The parameter completer model to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] libraryAccess Interface to the library. + * @param [in] stdRevision The standard revision used by the abstraction definition. + * @param [in] parent The owner of this instance */ AbstractionWirePortsDelegate(QAbstractItemModel* parametersModel, QSharedPointer parameterFinder, LibraryInterface* libraryAccess, Document::Revision stdRevision, QObject *parent); @@ -43,11 +43,11 @@ class AbstractionWirePortsDelegate : public AbstractionPortsDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -61,16 +61,16 @@ class AbstractionWirePortsDelegate : public AbstractionPortsDelegate /*! * Get the list of available qualifier values. * - * @return The list of available qualifier values. + * @return The list of available qualifier values. */ QStringList getQualifierList() const override; /*! * Check if the editor used in the selected index column is a combo box editor. * - * @param [in] indexColumn The selected index column. + * @param [in] indexColumn The selected index column. * - * @return True, if the editor used in the selected column is a combo box editor, false otherwise. + * @return True, if the editor used in the selected column is a combo box editor, false otherwise. */ virtual bool editorIsComboBox(int indexColumn) const; @@ -79,9 +79,9 @@ class AbstractionWirePortsDelegate : public AbstractionPortsDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const final; diff --git a/editors/AbstractionDefinitionEditor/AbstractionWirePortsSortFilter.h b/editors/AbstractionDefinitionEditor/AbstractionWirePortsSortFilter.h index cdd9cd0e2..e3de3e56d 100644 --- a/editors/AbstractionDefinitionEditor/AbstractionWirePortsSortFilter.h +++ b/editors/AbstractionDefinitionEditor/AbstractionWirePortsSortFilter.h @@ -25,7 +25,7 @@ class AbstractionWirePortsSortFilter : public AbstractionDefinitionPortsSortFilt /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. + * @param [in] parent Pointer to the owner of this model. */ AbstractionWirePortsSortFilter(PortAbstractionInterface* portInterface, QObject *parent); @@ -43,10 +43,10 @@ class AbstractionWirePortsSortFilter : public AbstractionDefinitionPortsSortFilt /*! * Check if the filter accepts the selected row. * - * @param [in] source_row The selected row. - * @param [in] source_parent Parent index of the selected row. + * @param [in] source_row The selected row. + * @param [in] source_parent Parent index of the selected row. * - * @return True, if the row is accepted, false otherwise. + * @return True, if the row is accepted, false otherwise. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override final; diff --git a/editors/AbstractionDefinitionEditor/QualifierEditor.h b/editors/AbstractionDefinitionEditor/QualifierEditor.h index 33400ed9e..481b3566a 100644 --- a/editors/AbstractionDefinitionEditor/QualifierEditor.h +++ b/editors/AbstractionDefinitionEditor/QualifierEditor.h @@ -37,8 +37,8 @@ class QualifierEditor : public QFrame /*! * The constructor. * - * @param [in] stdRevision The IP-XACT standard revision in use. - * @param [in] parent The owner of this instance + * @param [in] stdRevision The IP-XACT standard revision in use. + * @param [in] parent The owner of this instance */ QualifierEditor(Document::Revision stdRevision, QWidget *parent); @@ -51,15 +51,15 @@ class QualifierEditor : public QFrame /*! * Setup the qualifier editor. * - * @param [in] qualifierOptions List of all possible qualifiers. + * @param [in] qualifierOptions List of all possible qualifiers. */ void setupEditor(QStringList const& qualifierOptions); /*! * Set the editor data. * - * @param [in] activeQualifiers The qualifiers that should be set checked. - * @param [in] attributes The qualifier attributes to set. + * @param [in] activeQualifiers The qualifiers that should be set checked. + * @param [in] attributes The qualifier attributes to set. */ void setupEditorData(QStringList const& activeQualifiers, QMap const& attributes); @@ -92,7 +92,7 @@ private slots: /*! * Update attribute visibility when qualifier checkbox is toggled. * - * @param [in] isChecked Flag indicating if checkbox was checked or not. + * @param [in] isChecked Flag indicating if checkbox was checked or not. */ void onItemClicked(bool isChecked); @@ -120,15 +120,15 @@ private slots: /*! * Set a single attribute value to the corresponding editor. * - * @param [in] attributeType The attribute to set. - * @param [in] attributeValue The value to set. + * @param [in] attributeType The attribute to set. + * @param [in] attributeValue The value to set. */ void setQualifierAttribute(Qualifier::Attribute attributeType, QString const& attributeValue); /*! * Get the editor for a given attribute. * - * @param [in] attribute The attribute whose editor to look for. + * @param [in] attribute The attribute whose editor to look for. * * @return A pointer to the corresponding editor, or nullptr if invalid attribute type. */ @@ -137,7 +137,7 @@ private slots: /*! * Get the attribute editor for a given qualifier type. * - * @param [in] qualifierType The qualfier type whose attribute editor to get. + * @param [in] qualifierType The qualfier type whose attribute editor to get. * * @return The attribute editor, or nullptr if not found. */ @@ -146,8 +146,8 @@ private slots: /*! * Set the visibility for the attributes of a qualifier, based on if qualifier is set. * - * @param [in] qualifier The qualifier, whose attributes are shown/hidden. - * @param [in] visible Flag indicating if attributes should be shown or hidden. + * @param [in] qualifier The qualifier, whose attributes are shown/hidden. + * @param [in] visible Flag indicating if attributes should be shown or hidden. */ void setQualifierAttributesVisible(Qualifier::Type qualifier, bool visible); @@ -158,7 +158,7 @@ private slots: /*! * Get the attributes for a given qualifier. * - * @param [in] qualifier The qualifier. + * @param [in] qualifier The qualifier. * * @return A list of attributes for a qualifier. */ diff --git a/editors/AbstractionDefinitionEditor/absdefgroup.h b/editors/AbstractionDefinitionEditor/absdefgroup.h index 07c990b0b..55d3d5776 100644 --- a/editors/AbstractionDefinitionEditor/absdefgroup.h +++ b/editors/AbstractionDefinitionEditor/absdefgroup.h @@ -49,15 +49,15 @@ class AbsDefGroup : public QWidget /*! * The constructor. * - * @param [in] revision Currently active IP-XACT revision. - * @param [in] absDef The abstraction definition. - * @param [in] expressionFormatter The expression formatter to use. - * @param [in] expressionParser The expression parser to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] libraryHandler Allows access to the library. - * @param [in] portInterface Interface for accssing port abstractions. - * @param [in] extendInterface Interface for accssing extend port abstractions. - * @param [in] parent The owner of the editor. + * @param [in] revision Currently active IP-XACT revision. + * @param [in] absDef The abstraction definition. + * @param [in] expressionFormatter The expression formatter to use. + * @param [in] expressionParser The expression parser to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] libraryHandler Allows access to the library. + * @param [in] portInterface Interface for accssing port abstractions. + * @param [in] extendInterface Interface for accssing extend port abstractions. + * @param [in] parent The owner of the editor. */ AbsDefGroup(Document::Revision revision, QSharedPointer absDef, QSharedPointer expressionFormatter, QSharedPointer expressionParser, @@ -81,7 +81,7 @@ class AbsDefGroup : public QWidget /*! * Set the abstraction definition for the editor. * - * @param [in] absDef The Abstraction definition to edit. + * @param [in] absDef The Abstraction definition to edit. */ void setAbsDef(QSharedPointer absDef); @@ -106,30 +106,30 @@ class AbsDefGroup : public QWidget /*! * Inform that a port abstraction has been removed. * - * @param [in] portName Name of the removed port abstraction. - * @param [in] mode Mode of the removed port abstraction. + * @param [in] portName Name of the removed port abstraction. + * @param [in] mode Mode of the removed port abstraction. */ void portRemoved(QString const& portName, General::InterfaceMode const mode); /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QStringList const& parameterList, AbstractParameterInterface* parameterInterface); @@ -137,8 +137,8 @@ class AbsDefGroup : public QWidget /*! * Open the reference tree of the parameter with the id. * - * @param [in] id The id of the parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id The id of the parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName); @@ -154,7 +154,7 @@ private slots: /*! * Check if the abstraction definition contains transactional ports. * - * @return True, if the abstraction definition contains any transactional ports. + * @return True, if the abstraction definition contains any transactional ports. */ bool abstractionContainsTransactionalPorts() const; @@ -166,7 +166,7 @@ private slots: /*! * Get the extended abstraction definition. * - * @return The extended abstraction definition. + * @return The extended abstraction definition. */ QSharedPointer getExtendedAbstraction() const; @@ -178,7 +178,7 @@ private slots: /*! * Extend the contained signals. * - * @param [in] extendAbstraction The extended abstraction definition. + * @param [in] extendAbstraction The extended abstraction definition. */ void extendSignals(QSharedPointer extendAbstraction); diff --git a/editors/ApiDefinitionEditor/ApiDefinitionEditor.h b/editors/ApiDefinitionEditor/ApiDefinitionEditor.h index 1513c3548..f78c53758 100644 --- a/editors/ApiDefinitionEditor/ApiDefinitionEditor.h +++ b/editors/ApiDefinitionEditor/ApiDefinitionEditor.h @@ -44,9 +44,9 @@ class ApiDefinitionEditor : public TabDocument /*! * Constructor. * - * @param [in] parent The parent widget. - * @param [in] libHandler The library interface. - * @param [in] apiDef The API definition. + * @param [in] parent The parent widget. + * @param [in] libHandler The library interface. + * @param [in] apiDef The API definition. */ ApiDefinitionEditor(QWidget* parent, LibraryInterface* libHandler, QSharedPointer apiDef); @@ -64,7 +64,7 @@ class ApiDefinitionEditor : public TabDocument /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); @@ -82,9 +82,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); diff --git a/editors/ApiDefinitionEditor/ApiFunctionEditor.h b/editors/ApiDefinitionEditor/ApiFunctionEditor.h index 2ef74698d..f3e241b9c 100644 --- a/editors/ApiDefinitionEditor/ApiFunctionEditor.h +++ b/editors/ApiDefinitionEditor/ApiFunctionEditor.h @@ -39,7 +39,7 @@ class ApiFunctionEditor : public QGroupBox /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ApiFunctionEditor(QWidget* parent); @@ -56,14 +56,14 @@ class ApiFunctionEditor : public QGroupBox /*! * Sets the linked COM definition. * - * @param [in] comDefinition The COM definition to set. + * @param [in] comDefinition The COM definition to set. */ void setComDefinition(QSharedPointer comDefinition); /*! * Updates the data types suggestions list. * - * @param [in] dataTypes The list of custom data types. + * @param [in] dataTypes The list of custom data types. */ void updateDataTypes(QStringList const& dataTypes); diff --git a/editors/ApiDefinitionEditor/ApiFunctionModel.h b/editors/ApiDefinitionEditor/ApiFunctionModel.h index f782b74ec..f35886aa0 100644 --- a/editors/ApiDefinitionEditor/ApiFunctionModel.h +++ b/editors/ApiDefinitionEditor/ApiFunctionModel.h @@ -33,7 +33,7 @@ class ApiFunctionModel : public QAbstractListModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ApiFunctionModel(QObject *parent = 0); @@ -45,45 +45,45 @@ class ApiFunctionModel : public QAbstractListModel /*! * Restores the model from an API definition. * - * @param [in] apiDef The source API definition. + * @param [in] apiDef The source API definition. */ void restore(ApiDefinition const& apiDef); /*! * Saves the changes to an API definition. * - * @param [in,out] apiDef The destination API definition. + * @param [in,out] apiDef The destination API definition. */ void save(ApiDefinition& apiDef); /*! * Returns the API function at the given index. * - * @param [in] index The index. + * @param [in] index The index. */ QSharedPointer getFunction(QModelIndex const& index); /*! * Returns the number of rows in this model. * - * @param [in] parent ModelIndex of the item that's rowCount is requested. + * @param [in] parent ModelIndex of the item that's rowCount is requested. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Returns the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the header of the list. * - * @param [in] section Specifies the column for which the header is requested. - * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. - * @param [in] role Specifies what kind of header data is requested. + * @param [in] section Specifies the column for which the header is requested. + * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. + * @param [in] role Specifies what kind of header data is requested. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; @@ -91,28 +91,28 @@ class ApiFunctionModel : public QAbstractListModel /*! * Saves the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Replace an item text in the list. * - * @param [in] index ModelIndex of the item that is to be replaced. - * @param [in] newText The new text for the given item. + * @param [in] index ModelIndex of the item that is to be replaced. + * @param [in] newText The new text for the given item. */ virtual void replace(QModelIndex& index, const QString newText); @@ -121,22 +121,22 @@ public slots: /*! * Removes the specified item from the model. * - * @param [in] index The model index of the item to remove. + * @param [in] index The model index of the item to remove. */ virtual void remove(const QModelIndex& index); /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void addItem(const QModelIndex& index); /*! * Move item to another position. * - * @param [in] originalPos Identifies the item that should be moved. - * @param [in] newPos The new position the item should be moved to. + * @param [in] originalPos Identifies the item that should be moved. + * @param [in] newPos The new position the item should be moved to. */ virtual void moveItem(const QModelIndex& originalPos, const QModelIndex& newPos); diff --git a/editors/ApiDefinitionEditor/ApiFunctionParameterDelegate.h b/editors/ApiDefinitionEditor/ApiFunctionParameterDelegate.h index 5e4914d5d..ab4ecdee5 100644 --- a/editors/ApiDefinitionEditor/ApiFunctionParameterDelegate.h +++ b/editors/ApiDefinitionEditor/ApiFunctionParameterDelegate.h @@ -27,7 +27,7 @@ class ApiFunctionParameterDelegate : public QStyledItemDelegate /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ApiFunctionParameterDelegate(QObject* parent = 0); @@ -39,14 +39,14 @@ class ApiFunctionParameterDelegate : public QStyledItemDelegate /*! * Sets the linked COM definition. * - * @param [in] comDefinition The COM definition to set. + * @param [in] comDefinition The COM definition to set. */ void setComDefinition(QSharedPointer comDefinition); /*! * Adds the given data types to the list of parameter type suggestions. * - * @param [in] dataTypes The list of data types to add. + * @param [in] dataTypes The list of data types to add. */ void updateDataTypes(QStringList const& dataTypes); @@ -58,11 +58,11 @@ class ApiFunctionParameterDelegate : public QStyledItemDelegate /*! * Creates a new editor for the given item. * - * @param [in] parent The parent widget. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent The parent widget. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -70,17 +70,17 @@ class ApiFunctionParameterDelegate : public QStyledItemDelegate /*! * Sets the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Saves the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ApiDefinitionEditor/ApiFunctionParameterModel.h b/editors/ApiDefinitionEditor/ApiFunctionParameterModel.h index 6351aeb37..022f3e3b4 100644 --- a/editors/ApiDefinitionEditor/ApiFunctionParameterModel.h +++ b/editors/ApiDefinitionEditor/ApiFunctionParameterModel.h @@ -32,7 +32,7 @@ class ApiFunctionParameterModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ApiFunctionParameterModel(QObject *parent); @@ -44,48 +44,48 @@ class ApiFunctionParameterModel : public QAbstractTableModel /*! * Sets the edited API function. * - * @param [in] function The function to edit. + * @param [in] function The function to edit. */ void setFunction(QSharedPointer function); /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Always returns API_FUNC_PARAM_COL_COUNT. + * @return Always returns API_FUNC_PARAM_COL_COUNT. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the header data. + * @return QVariant containing the header data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; @@ -93,27 +93,27 @@ class ApiFunctionParameterModel : public QAbstractTableModel /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Item flags that define how object can be handled. + * @return Item flags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Returns the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Checks whether the model is in valid state or not. * - * @return True if all items in model are valid. + * @return True if all items in model are valid. */ bool isValid() const; diff --git a/editors/BusDefinitionEditor/BusDefinitionEditor.h b/editors/BusDefinitionEditor/BusDefinitionEditor.h index fc43e937f..5d80bb6cc 100644 --- a/editors/BusDefinitionEditor/BusDefinitionEditor.h +++ b/editors/BusDefinitionEditor/BusDefinitionEditor.h @@ -43,9 +43,9 @@ class BusDefinitionEditor : public TabDocument /*! * The constructor. * - * @param [in] parent The owner of this widget. - * @param [in] libHandler The instance that manages library. - * @param [in] busDef The bus definition to edit. + * @param [in] parent The owner of this widget. + * @param [in] libHandler The instance that manages library. + * @param [in] busDef The bus definition to edit. */ BusDefinitionEditor(QWidget *parent, LibraryInterface* libHandler, QSharedPointer busDef); @@ -61,7 +61,7 @@ class BusDefinitionEditor : public TabDocument /*! * Get the VLNV that can be used to identify the Bus. * - * @return The VLNV that identifies the Bus. + * @return The VLNV that identifies the Bus. */ VLNV getIdentifyingVLNV() const override; @@ -73,21 +73,21 @@ class BusDefinitionEditor : public TabDocument /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ void setProtection(bool locked) override; /*! * Get the vlnv of the current bus definition. * - * @return VLNV of the bus definition/abstraction definition being edited. + * @return VLNV of the bus definition/abstraction definition being edited. */ VLNV getDocumentVLNV() const override; /*! * Sets the edited bus definition. * - * @param [in] busDef The bus definition to set. Must not be NULL. + * @param [in] busDef The bus definition to set. Must not be NULL. */ void setBusDef(QSharedPointer busDef); @@ -97,9 +97,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); @@ -118,8 +118,8 @@ public slots: /*! * Inform that a port abstraction has been removed. * - * @param [in] portName Name of the removed port abstraction. - * @param [in] mode Mode of the removed port abstraction. + * @param [in] portName Name of the removed port abstraction. + * @param [in] mode Mode of the removed port abstraction. */ void portRemoved(QString const& portName, General::InterfaceMode const mode); @@ -128,7 +128,7 @@ public slots: /*! * Called when the editor is shown. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event); diff --git a/editors/BusDefinitionEditor/BusDefinitionParameterReferenceTree.h b/editors/BusDefinitionEditor/BusDefinitionParameterReferenceTree.h index 0732787ea..580705bc7 100644 --- a/editors/BusDefinitionEditor/BusDefinitionParameterReferenceTree.h +++ b/editors/BusDefinitionEditor/BusDefinitionParameterReferenceTree.h @@ -26,10 +26,10 @@ class BusDefinitionParameterReferenceTree : public ParameterReferenceTree /*! * The constructor. * - * @param [in] busDef The bus definition whose references to display. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] referenceCounter Calculator for parameter references. - * @param [in] parent The parent widget. + * @param [in] busDef The bus definition whose references to display. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] referenceCounter Calculator for parameter references. + * @param [in] parent The parent widget. */ BusDefinitionParameterReferenceTree(QSharedPointer busDef, QSharedPointer expressionFormatter, QSharedPointer referenceCounter, QWidget* parent = nullptr); diff --git a/editors/BusDefinitionEditor/SystemGroupListEditor.h b/editors/BusDefinitionEditor/SystemGroupListEditor.h index 37c7c019c..93b3aee6b 100644 --- a/editors/BusDefinitionEditor/SystemGroupListEditor.h +++ b/editors/BusDefinitionEditor/SystemGroupListEditor.h @@ -30,8 +30,8 @@ class SystemGroupListEditor : public QListWidget /*! * The constructor. * - * @param [in] library Interface to the library. - * @param [in] parent The owner of this widget. + * @param [in] library Interface to the library. + * @param [in] parent The owner of this widget. */ SystemGroupListEditor(LibraryInterface* library, QWidget *parent); @@ -43,7 +43,7 @@ class SystemGroupListEditor : public QListWidget /*! * Set the bus definition that is being edited. * - * @param [in] busDefinition The bus definition + * @param [in] busDefinition The bus definition */ void setItems(QSharedPointer busDefinition); @@ -59,14 +59,14 @@ class SystemGroupListEditor : public QListWidget /*! * Handles the context menu events. * - * @param [in] event The current context menu event. + * @param [in] event The current context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event); /*! * Handles the double click events. * - * @param [in] event The current double click event. + * @param [in] event The current double click event. */ virtual void mouseDoubleClickEvent(QMouseEvent *event); @@ -90,9 +90,9 @@ private slots: /*! * Get the system group names from the extended bus definitions. * - * @param [in] busDefinition The selected bus definition. + * @param [in] busDefinition The selected bus definition. * - * @return List of the extended bus definition system group names. + * @return List of the extended bus definition system group names. */ QStringList getExtendedSystemGroupNames(QSharedPointer busDefinition) const; diff --git a/editors/BusDefinitionEditor/busdefgroup.h b/editors/BusDefinitionEditor/busdefgroup.h index c12674f95..5bc8428cc 100644 --- a/editors/BusDefinitionEditor/busdefgroup.h +++ b/editors/BusDefinitionEditor/busdefgroup.h @@ -47,10 +47,10 @@ class BusDefGroup : public QWidget /*! * The constructor. * - * @param [in] libraryHandler Interface to the library. - * @param [in] expressionFormatter The expression formatter to use. - * @param [in] parameterFinder The parameter finder to use. - * @param [in] parent The owner of this widget. + * @param [in] libraryHandler Interface to the library. + * @param [in] expressionFormatter The expression formatter to use. + * @param [in] parameterFinder The parameter finder to use. + * @param [in] parent The owner of this widget. */ BusDefGroup(LibraryInterface* libraryHandler, QSharedPointer expressionFormatter, QSharedPointer parameterFinder, QWidget *parent); @@ -63,7 +63,7 @@ class BusDefGroup : public QWidget /*! * Set the bus definition that is being edited. * - * @param [in] busDef The bus definition + * @param [in] busDef The bus definition */ void setBusDef(QSharedPointer busDef); @@ -77,22 +77,22 @@ class BusDefGroup : public QWidget /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QStringList const& parameterList, AbstractParameterInterface* parameterInterface); @@ -100,8 +100,8 @@ class BusDefGroup : public QWidget /*! * Open the reference tree of the parameter with the id. * - * @param [in] id The id of the parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id The id of the parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName); @@ -160,16 +160,16 @@ private slots: /*! * Get the extended bus definition for the selected bus definition. * - * @param [in] busDefinition The selected bus definition. + * @param [in] busDefinition The selected bus definition. * - * @return The extended bus definition. + * @return The extended bus definition. */ QSharedPointer getExtendedBus(QSharedPointer busDefinition) const; /*! * Lock editors according to the selected extended bus definition. * - * @param [in] extendedBus The selected extended bus definition. + * @param [in] extendedBus The selected extended bus definition. */ void extendBusDefinition(QSharedPointer extendedBus); diff --git a/editors/CSourceEditor/CSourceContentMatcher.h b/editors/CSourceEditor/CSourceContentMatcher.h index 7a129e25d..bc56f9d2b 100644 --- a/editors/CSourceEditor/CSourceContentMatcher.h +++ b/editors/CSourceEditor/CSourceContentMatcher.h @@ -42,43 +42,43 @@ class CSourceContentMatcher : public ITextContentMatcher /*! * Sets the component that owns this content matcher. * - * @param [in] component The component to set. + * @param [in] component The component to set. */ void setOwner(QSharedPointer component); /*! * Adds a source API definition for content matching. * - * @param [in] apiDef The API definition to add. + * @param [in] apiDef The API definition to add. */ void addSourceApiDefinition(QSharedPointer apiDef); /*! * Adds a source COM definition for content matching. * - * @param [in] comDef The COM definition to add. + * @param [in] comDef The COM definition to add. */ void addSourceComDefinition(QSharedPointer comDef); /*! * Looks forward for matching contents in the given text. * - * @param [in] text The text. + * @param [in] text The text. * - * @return True, if there is a match. Otherwise false. + * @return True, if there is a match. Otherwise false. */ bool lookForwardMatch(QString const& text); /*! * Fills the content assist with content based on the given text. * - * @param [in] text The text. - * @param [in] assist The content assist to fill with content. - * @param [out] startIndex The start index of the selection to which the content applies. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. + * @param [in] text The text. + * @param [in] assist The content assist to fill with content. + * @param [out] startIndex The start index of the selection to which the content applies. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The index which specifies there start position for the tool tip hint. * - * @return The content state (what kind of content was detected). + * @return The content state (what kind of content was detected). */ bool fillWithContent(QString const& text, TextContentAssistWidget& assist, int& startIndex, QString& toolTipText, int& toolTipIndex); @@ -119,14 +119,14 @@ class CSourceContentMatcher : public ITextContentMatcher /*! * Searches for matches in the given text. * - * @param [in] text The text to search. - * @param [in] func A function that is executed for each match. Can be null. - * @param [out] startIndex The start index of the part of the text to which the matches apply. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The cursor position in the text to indicate correct + * @param [in] text The text to search. + * @param [in] func A function that is executed for each match. Can be null. + * @param [out] startIndex The start index of the part of the text to which the matches apply. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The cursor position in the text to indicate correct * placement for the tool tip hint. * - * @return The content state (what kind of content was detected). + * @return The content state (what kind of content was detected). */ MatchType enumerateMatches(QString const& text, MatchExecFunc func, int& startIndex, QString* toolTipText, int& toolTipIndex); @@ -134,27 +134,27 @@ class CSourceContentMatcher : public ITextContentMatcher /*! * Enumerates matching names (function or type) in the given text. * - * @param [in] text The text to search. - * @param [in] func A function that is executed for each match. Can be null. - * @param [out] startIndex The start index of the part of the text to which the matches apply. - * @param [out] exactMatch If true, there was an exact match. Otherwise false. + * @param [in] text The text to search. + * @param [in] func A function that is executed for each match. Can be null. + * @param [out] startIndex The start index of the part of the text to which the matches apply. + * @param [out] exactMatch If true, there was an exact match. Otherwise false. * - * @return The number of matches found. + * @return The number of matches found. */ int enumerateNames(QString const &text, MatchExecFunc func, int &startIndex, bool& exactMatch); /*! * Enumerates matching function parameters in the given text. * - * @param [in] text The text to search. - * @param [in] func A function that is executed for each match. Can be null. - * @param [out] startIndex The start index of the part of the text to which the matches apply. - * @param [out] exactMatch If true, there was an exact match. Otherwise false. - * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. - * @param [out] toolTipIndex The cursor position in the text to indicate correct + * @param [in] text The text to search. + * @param [in] func A function that is executed for each match. Can be null. + * @param [out] startIndex The start index of the part of the text to which the matches apply. + * @param [out] exactMatch If true, there was an exact match. Otherwise false. + * @param [out] toolTipText The tool tip hint text. Empty if no tool tip available. + * @param [out] toolTipIndex The cursor position in the text to indicate correct * placement for the tool tip hint. * - * @return The number of matches found. + * @return The number of matches found. * * @remarks Assumes that there is valid function call up to the cursor. */ @@ -164,28 +164,28 @@ class CSourceContentMatcher : public ITextContentMatcher /*! * Adds the given match to the content assist. * - * @param [in] assist The content assist. - * @param [in] match The match to add. - * @param [in] type The icon for the match. + * @param [in] assist The content assist. + * @param [in] match The match to add. + * @param [in] type The icon for the match. */ static void addMatchToAssist(TextContentAssistWidget& assist, QString const& match, QIcon const& icon); /*! * Extracts parameter names to a list from a parameter list string. * - * @param [in] paramsListStr The parameter list string. - * @param [out] params The extracted parameter names. + * @param [in] paramsListStr The parameter list string. + * @param [out] params The extracted parameter names. */ static void extractParams(QString const& paramsListStr, QStringList& params); /*! * Tries to match all available content to the parameter. * - * @param [in] apiFuncDesc The API function corresponding to the function name. - * @param [in] params The previous parameters for the function. - * @param [in] word The partial content of the parameter to match. - * @param [in] func The match execution function. - * @param [in,out] count The accumulated number of matches. + * @param [in] apiFuncDesc The API function corresponding to the function name. + * @param [in] params The previous parameters for the function. + * @param [in] word The partial content of the parameter to match. + * @param [in] func The match execution function. + * @param [in,out] count The accumulated number of matches. */ void tryMatchParam(ApiFunction const* apiFuncDesc, QStringList const& params, QString const& word, MatchExecFunc func, int& count); @@ -193,13 +193,13 @@ class CSourceContentMatcher : public ITextContentMatcher /*! * Tries to match an identifier to the regular expression. * - * @param [in] identifier The identifier. - * @param [in] type The identifier's MCAPI content type. - * @param [in] exp The regular expression to use for matching. - * @param [in] func The match execution function. - * @param [in/out] count The accumulated number of matches. + * @param [in] identifier The identifier. + * @param [in] type The identifier's MCAPI content type. + * @param [in] exp The regular expression to use for matching. + * @param [in] func The match execution function. + * @param [in/out] count The accumulated number of matches. * - * @return True, if the identifier matched with the regular expression. Otherwise false. + * @return True, if the identifier matched with the regular expression. Otherwise false. */ bool tryMatchIdentifier(QString const& identifier, MCAPIContentType type, QRegularExpression& exp, MatchExecFunc func, int& count); diff --git a/editors/CSourceEditor/CSourceHighlight.h b/editors/CSourceEditor/CSourceHighlight.h index eacb61a61..3c39a1fec 100644 --- a/editors/CSourceEditor/CSourceHighlight.h +++ b/editors/CSourceEditor/CSourceHighlight.h @@ -34,21 +34,21 @@ class CSourceHighlight: public SourceHighlightStyle /*! * Get the language specific keywords. * - * @return The language keywords. + * @return The language keywords. */ virtual QStringList keywords() const; /*! * Get the language specific preprocessor directives. * - * @return The preprocessor directives. + * @return The preprocessor directives. */ virtual QStringList preprocessorDirectives() const; /*! * Apply other language specific rules to highlighting. * - * @param [in] highlighter The highlighter to apply the rules to. + * @param [in] highlighter The highlighter to apply the rules to. */ virtual void applyLanguageSpecificRules(LanguageHighlighter* highlighter) const; diff --git a/editors/CSourceEditor/CSourceHighlighter.h b/editors/CSourceEditor/CSourceHighlighter.h index 2e8bce85e..1b4097854 100644 --- a/editors/CSourceEditor/CSourceHighlighter.h +++ b/editors/CSourceEditor/CSourceHighlighter.h @@ -36,7 +36,7 @@ class CSourceHighlighter : public LanguageHighlighter /*! * Constructor. * - * @param [in] parent The parent text document. + * @param [in] parent The parent text document. */ CSourceHighlighter(QTextDocument* parent); @@ -48,7 +48,7 @@ class CSourceHighlighter : public LanguageHighlighter /*! * Registers data types and functions from the given API definition for syntax highlight. * - * @param [in] apiDef The API definition. + * @param [in] apiDef The API definition. */ void registerAPI(QSharedPointer apiDef); diff --git a/editors/CSourceEditor/CSourceTextEdit.h b/editors/CSourceEditor/CSourceTextEdit.h index 8bad520e4..db405e1ff 100644 --- a/editors/CSourceEditor/CSourceTextEdit.h +++ b/editors/CSourceEditor/CSourceTextEdit.h @@ -27,8 +27,8 @@ class CSourceTextEdit : public AssistedTextEdit /*! * Constructor. * - * @param [in] mainWnd The program main window. Must not be null. - * @param [in] parent The parent widget. Can be null. + * @param [in] mainWnd The program main window. Must not be null. + * @param [in] parent The parent widget. Can be null. */ CSourceTextEdit(QWidget* mainWnd, QWidget* parent = 0); diff --git a/editors/CSourceEditor/CSourceWidget.h b/editors/CSourceEditor/CSourceWidget.h index d4dbcd95c..7d2fb3a42 100644 --- a/editors/CSourceEditor/CSourceWidget.h +++ b/editors/CSourceEditor/CSourceWidget.h @@ -35,11 +35,11 @@ class CSourceWidget : public TabDocument /*! * Constructor. * - * @param [in] sourceFile The name of the source file in the file system. - * @param [in] ownerComponent The component who "owns" the source file that will be edited. - * @param [in] libInterface The library interface. - * @param [in] mainWnd The main window. - * @param [in] parent The parent widget. + * @param [in] sourceFile The name of the source file in the file system. + * @param [in] ownerComponent The component who "owns" the source file that will be edited. + * @param [in] libInterface The library interface. + * @param [in] mainWnd The main window. + * @param [in] parent The parent widget. * * @remarks The file is assumed to exist in the file system. */ diff --git a/editors/CatalogEditor/CatalogEditor.h b/editors/CatalogEditor/CatalogEditor.h index dce44f351..7eee1b77a 100644 --- a/editors/CatalogEditor/CatalogEditor.h +++ b/editors/CatalogEditor/CatalogEditor.h @@ -36,9 +36,9 @@ class CatalogEditor : public TabDocument /*! * Constructor. * - * @param [in] library The library of available IP-XACT documents. - * @param [in] catalog The catalog to edit. - * @param [in] parent The parent widget. + * @param [in] library The library of available IP-XACT documents. + * @param [in] catalog The catalog to edit. + * @param [in] parent The parent widget. */ CatalogEditor(LibraryInterface* libHandler, QSharedPointer catalog, QWidget* parent); @@ -49,7 +49,7 @@ class CatalogEditor : public TabDocument /*! Get the VLNV that can be used to identify the catalog. * - * @return The VLNV of the catalog. + * @return The VLNV of the catalog. */ virtual VLNV getIdentifyingVLNV() const; @@ -66,7 +66,7 @@ class CatalogEditor : public TabDocument /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); @@ -82,9 +82,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); diff --git a/editors/CatalogEditor/CatalogFileDelegate.h b/editors/CatalogEditor/CatalogFileDelegate.h index ace61063d..7b77ac886 100644 --- a/editors/CatalogEditor/CatalogFileDelegate.h +++ b/editors/CatalogEditor/CatalogFileDelegate.h @@ -34,8 +34,8 @@ class CatalogFileDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] library The library of available IP-XACT documents. - * @param [in] parent The parent of this delegate. + * @param [in] library The library of available IP-XACT documents. + * @param [in] parent The parent of this delegate. */ CatalogFileDelegate(LibraryInterface* library, QObject *parent); @@ -52,20 +52,20 @@ class CatalogFileDelegate : public QStyledItemDelegate /*! * Paint the memory maps. * - * @param [in] painter The used painter. - * @param [in] option Available style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option Available style options. + * @param [in] index The current index. */ virtual void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * Creates an editor for the given index. * - * @param [in] parent The parent widget for the editor. - * @param [in] option Format options for the editor. - * @param [in] index The index whose content to edit in the editor. + * @param [in] parent The parent widget for the editor. + * @param [in] option Format options for the editor. + * @param [in] index The index whose content to edit in the editor. * - * @return Editor for the index. + * @return Editor for the index. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -79,7 +79,7 @@ class CatalogFileDelegate : public QStyledItemDelegate /*! * Updates the suggested items in the editor for the given index. * - * @param [in] index The index whose content to suggest. + * @param [in] index The index whose content to suggest. */ void updateSuggestedItems(QModelIndex const& index) const; diff --git a/editors/CatalogEditor/CatalogFileFilter.h b/editors/CatalogEditor/CatalogFileFilter.h index 95afa41d1..2c5c41fa1 100644 --- a/editors/CatalogEditor/CatalogFileFilter.h +++ b/editors/CatalogEditor/CatalogFileFilter.h @@ -31,8 +31,8 @@ class CatalogFileFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] docRevision The standard revision of the document. - * @param [in] parent The parent object. + * @param [in] docRevision The standard revision of the document. + * @param [in] parent The parent object. */ CatalogFileFilter(Document::Revision docRevision, QObject *parent = 0); @@ -65,10 +65,10 @@ public slots: /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override; diff --git a/editors/CatalogEditor/CatalogFileModel.h b/editors/CatalogEditor/CatalogFileModel.h index d34fbb2de..47bea3348 100644 --- a/editors/CatalogEditor/CatalogFileModel.h +++ b/editors/CatalogEditor/CatalogFileModel.h @@ -36,8 +36,8 @@ class CatalogFileModel : public QAbstractItemModel /*! * The constructor. * - * @param [in] library The library of available IP-XACT documents. - * @param [in] parent The parent object. + * @param [in] library The library of available IP-XACT documents. + * @param [in] parent The parent object. */ CatalogFileModel(LibraryInterface* library, QObject *parent); @@ -49,118 +49,118 @@ class CatalogFileModel : public QAbstractItemModel /*! * Sets the protection against changes. * - * @param [in] locked Lock against changes or not. + * @param [in] locked Lock against changes or not. */ void setProtection(bool locked); /*! * Refreshes the model content from the given catalog. * - * @param [in] catalog The catalog whose files to display. + * @param [in] catalog The catalog whose files to display. */ void refresh(QSharedPointer catalog); /*! * Returns the number of columns in this model. * - * @param [in] parent Model index identifying the item whose column count is requested. + * @param [in] parent Model index identifying the item whose column count is requested. * - * @return The number of columns. + * @return The number of columns. */ virtual int columnCount(QModelIndex const& parent = QModelIndex() ) const; /*! * Returns the number of rows an item has. * - * @param [in] parent Model index identifying the item whose row count is wanted. + * @param [in] parent Model index identifying the item whose row count is wanted. * - * @return The number of rows the item has. + * @return The number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ virtual QModelIndex index(int row, int column, QModelIndex const& parent = QModelIndex()) const; /*! * Get the model index of the parent of the object * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelIndex that identifies the parent of the given object. + * @return QModelIndex that identifies the parent of the given object. */ virtual QModelIndex parent(QModelIndex const& child) const; /*! * Return header data for the given header column. * - * @param [in] section The index of the header column. - * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. - * @param [in] role The role of the data. + * @param [in] section The index of the header column. + * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. + * @param [in] role The role of the data. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data associated with given object. * - * @param [in] index Model index that identifies the object that's data is wanted. - * @param [in] role Specifies the type of data wanted. + * @param [in] index Model index that identifies the object that's data is wanted. + * @param [in] role Specifies the type of data wanted. * - * @return QVariant Containing the requested data. + * @return QVariant Containing the requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True, if data was successfully set, otherwise false. + * @return True, if data was successfully set, otherwise false. */ virtual bool setData(QModelIndex const& index, const QVariant &value, int role /* = Qt::EditRole */); /*! * Get the flags that identify possible methods for given object. * - * @param [in] index Model index identifying the object that's flags are requested. + * @param [in] index Model index identifying the object that's flags are requested. * - * @return Qt::ItemFlags that specify how the object can be handled. + * @return Qt::ItemFlags that specify how the object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ QStringList mimeTypes() const; /*! * Get the supported drop actions. * - * @return The supported drop actions. + * @return The supported drop actions. */ virtual Qt::DropActions supportedDropActions() const; /*! * Drop the mime data. * - * @param [in] data The actual data. - * @param [in] action The used drop action. - * @param [in] row The selected row. - * @param [in] column The selected column. - * @param [in] parent Parent index of the new data. + * @param [in] data The actual data. + * @param [in] action The used drop action. + * @param [in] row The selected row. + * @param [in] column The selected column. + * @param [in] parent Parent index of the new data. */ virtual bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -207,25 +207,25 @@ public slots: /*! * Adds the given file to correct category in the model. * - * @param [in] fileToAdd The file to add. + * @param [in] fileToAdd The file to add. */ void addFile(QSharedPointer fileToAdd); /*! * Checks if the given VLNV is already contained in the catalog. * - * @param [in] vlnv The VLNV to find. + * @param [in] vlnv The VLNV to find. * - * @return True, if the VLNV is already in the catalog, otherwise false. + * @return True, if the VLNV is already in the catalog, otherwise false. */ bool contains(VLNV const& vlnv) const; /*! * Checks if the given path is valid. * - * @param [in] path The path to check. + * @param [in] path The path to check. * - * @return True, if the path is valid, otherwise false. + * @return True, if the path is valid, otherwise false. */ bool isValidPath(QString const& path) const; diff --git a/editors/CatalogEditor/CatalogFileView.h b/editors/CatalogEditor/CatalogFileView.h index 2c9bdfaa9..d1e3dc810 100644 --- a/editors/CatalogEditor/CatalogFileView.h +++ b/editors/CatalogEditor/CatalogFileView.h @@ -33,9 +33,9 @@ class CatalogFileView : public QTreeView /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] filter The class that does the filtering for the view. - * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] filter The class that does the filtering for the view. + * @param [in] parent The owner of this widget. * */ CatalogFileView(QWidget* parent = 0); @@ -59,15 +59,15 @@ class CatalogFileView : public QTreeView /*! * Draws a row and a separator line under it. * - * @param [in] painter The painter used for the drawing. - * @param [in] option Options for the drawing. - * @param [in] index Index of the item to draw. + * @param [in] painter The painter used for the drawing. + * @param [in] option Options for the drawing. + * @param [in] index Index of the item to draw. */ virtual void drawRow(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Handler for the context menu events. * - * @param [in] event The contextMenuEvent to be handled. + * @param [in] event The contextMenuEvent to be handled. */ virtual void contextMenuEvent(QContextMenuEvent* event); @@ -108,9 +108,9 @@ private slots: /*! * Sorts the given indexes and removes all but one index for each row. * - * @param [in] indexes the index to sort and minimize. + * @param [in] indexes the index to sort and minimize. * - * @return Indexes in sorted order with only one index per row. + * @return Indexes in sorted order with only one index per row. */ QModelIndexList sortAndMinimize(QModelIndexList const& indexes); diff --git a/editors/ComDefinitionEditor/ComDefinitionEditor.h b/editors/ComDefinitionEditor/ComDefinitionEditor.h index 5d46cbf0f..b245668fb 100644 --- a/editors/ComDefinitionEditor/ComDefinitionEditor.h +++ b/editors/ComDefinitionEditor/ComDefinitionEditor.h @@ -45,9 +45,9 @@ class ComDefinitionEditor : public TabDocument /*! * Constructor. * - * @param [in] parent The parent widget. - * @param [in] libHandler The library interface. - * @param [in] comDef The COM definition. + * @param [in] parent The parent widget. + * @param [in] libHandler The library interface. + * @param [in] comDef The COM definition. */ ComDefinitionEditor(QWidget* parent, LibraryInterface* libHandler, QSharedPointer comDef); @@ -62,14 +62,14 @@ class ComDefinitionEditor : public TabDocument /*! Get the VLNV that can be used to identify the COM definition. * - * @return The VLNV of the COM definition + * @return The VLNV of the COM definition */ virtual VLNV getIdentifyingVLNV() const; /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); @@ -87,9 +87,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [out] errorList Error message list for reporting standard violations. + * @param [out] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); diff --git a/editors/ComDefinitionEditor/ComPropertyDelegate.h b/editors/ComDefinitionEditor/ComPropertyDelegate.h index 68af9d4d8..27ce5d8f5 100644 --- a/editors/ComDefinitionEditor/ComPropertyDelegate.h +++ b/editors/ComDefinitionEditor/ComPropertyDelegate.h @@ -25,7 +25,7 @@ class ComPropertyDelegate : public QStyledItemDelegate /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ComPropertyDelegate(QObject* parent = 0); @@ -37,11 +37,11 @@ class ComPropertyDelegate : public QStyledItemDelegate /*! * Creates a new editor for the given item. * - * @param [in] parent The parent widget. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent The parent widget. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -49,17 +49,17 @@ class ComPropertyDelegate : public QStyledItemDelegate /*! * Sets the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Saves the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComDefinitionEditor/ComPropertyEditor.h b/editors/ComDefinitionEditor/ComPropertyEditor.h index 534e075af..226d755bd 100644 --- a/editors/ComDefinitionEditor/ComPropertyEditor.h +++ b/editors/ComDefinitionEditor/ComPropertyEditor.h @@ -30,7 +30,7 @@ class ComPropertyEditor : public QGroupBox /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ComPropertyEditor(QWidget* parent); @@ -42,7 +42,7 @@ class ComPropertyEditor : public QGroupBox /*! * Sets the properties for editing. * - * @param [in] properties The properties. + * @param [in] properties The properties. */ void setProperties(QList< QSharedPointer > const& properties); diff --git a/editors/ComDefinitionEditor/ComPropertyModel.h b/editors/ComDefinitionEditor/ComPropertyModel.h index 5aee1dc95..ff73ca551 100644 --- a/editors/ComDefinitionEditor/ComPropertyModel.h +++ b/editors/ComDefinitionEditor/ComPropertyModel.h @@ -31,7 +31,7 @@ class ComPropertyModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ComPropertyModel(QObject *parent); @@ -43,7 +43,7 @@ class ComPropertyModel : public QAbstractTableModel /*! * Sets the properties for editing. * - * @param [in] properties The list of properties. + * @param [in] properties The list of properties. */ void setProperties(QList< QSharedPointer > properties); @@ -55,41 +55,41 @@ class ComPropertyModel : public QAbstractTableModel /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Always returns PROPERTY_COL_COUNT. + * @return Always returns PROPERTY_COL_COUNT. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the header data. + * @return QVariant containing the header data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; @@ -97,20 +97,20 @@ class ComPropertyModel : public QAbstractTableModel /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Item flags that define how object can be handled. + * @return Item flags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Returns the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); @@ -118,7 +118,7 @@ class ComPropertyModel : public QAbstractTableModel /*! * Checks whether the model is in valid state or not. * - * @return True if all items in model are valid. + * @return True if all items in model are valid. */ bool isValid() const; diff --git a/editors/ComponentEditor/ParameterItemEditor.h b/editors/ComponentEditor/ParameterItemEditor.h index b9c36275d..0464b59e4 100644 --- a/editors/ComponentEditor/ParameterItemEditor.h +++ b/editors/ComponentEditor/ParameterItemEditor.h @@ -29,9 +29,9 @@ class ParameterItemEditor : public ItemEditor /*! * The constructor. * - * @param [in] component Pointer to the component instance that is being edited. - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] component Pointer to the component instance that is being edited. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of this widget. */ ParameterItemEditor(QSharedPointer component, LibraryInterface* handler, QWidget *parent = 0); @@ -50,16 +50,16 @@ class ParameterItemEditor : public ItemEditor /*! * Open the reference tree of the selected parameter. * - * @param [in] id Id of the selected parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id Id of the selected parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName) const; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); diff --git a/editors/ComponentEditor/addressSpaces/SegmentDelegate.h b/editors/ComponentEditor/addressSpaces/SegmentDelegate.h index 7cfe1f6c4..61b90b695 100644 --- a/editors/ComponentEditor/addressSpaces/SegmentDelegate.h +++ b/editors/ComponentEditor/addressSpaces/SegmentDelegate.h @@ -27,9 +27,9 @@ class SegmentDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The parent object. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The parent object. */ SegmentDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject* parent); @@ -46,9 +46,9 @@ class SegmentDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const final; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/AddressSpaceConflictedItem.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/AddressSpaceConflictedItem.h index ecb2ee643..b9753ca7b 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/AddressSpaceConflictedItem.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/AddressSpaceConflictedItem.h @@ -27,10 +27,10 @@ class AddressSpaceConflictedItem : public AddressSpaceGapItem /*! * The constructor. * - * @param [in] addrPos Address alignment. - * @param [in] addressSpaceWidth Address space width. - * @param [in] expressionParser The used expression parser. - * @param [in] parent Pointer to the parent graph item. + * @param [in] addrPos Address alignment. + * @param [in] addressSpaceWidth Address space width. + * @param [in] expressionParser The used expression parser. + * @param [in] parent Pointer to the parent graph item. */ AddressSpaceConflictedItem(VisualizerItem::LabelLayout addrPos, QString const& addressSpaceWidth, diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacegapitem.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacegapitem.h index 5662226e9..0e004d4be 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacegapitem.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacegapitem.h @@ -28,10 +28,10 @@ class AddressSpaceGapItem : public AddressSpaceVisualizationItem /*! * The constructor. * - * @param [in] addrPos Position of the address space. - * @param [in] addressSpaceWidth Width of the address space. - * @param [in] expressionParser The used expression parser. - * @param [in] parent Pointer to the parent graph item. + * @param [in] addrPos Position of the address space. + * @param [in] addressSpaceWidth Width of the address space. + * @param [in] expressionParser The used expression parser. + * @param [in] parent Pointer to the parent graph item. */ AddressSpaceGapItem(VisualizerItem::LabelLayout addrPos, QString const& addressSpaceWidth, @@ -53,22 +53,22 @@ class AddressSpaceGapItem : public AddressSpaceVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item. + * @return int The offset of the item. */ virtual quint64 getOffset() const override final; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; /*! * Set start address for the gap. * - * @param [in] address The address that limits the gap start. - * @param [in] contains If true then the address is contained in the gap, otherwise the gap starts + * @param [in] address The address that limits the gap start. + * @param [in] contains If true then the address is contained in the gap, otherwise the gap starts * from next address. */ void setStartAddress(quint64 address, bool contains = true); @@ -76,8 +76,8 @@ class AddressSpaceGapItem : public AddressSpaceVisualizationItem /*! * Set end address for the gap. * - * @param [in] address The address that limits the gap end. - * @param [in] contains If true then the address is contained in the gap, otherwise the gap ends + * @param [in] address The address that limits the gap end. + * @param [in] contains If true then the address is contained in the gap, otherwise the gap ends * before the specified address. */ void setEndAddress(quint64 address, bool contains = true); @@ -85,14 +85,14 @@ class AddressSpaceGapItem : public AddressSpaceVisualizationItem /*! * Sets the first non-overlapping address to display. * - * @param [in] address The first address to set. + * @param [in] address The first address to set. */ virtual void setOverlappingTop(quint64 const& address) override final; /*! * Sets the last non-overlapping address to display. * - * @param [in] address The last address to set. + * @param [in] address The last address to set. */ virtual void setOverlappingBottom(quint64 const& address) override final; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacescene.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacescene.h index 7605cb07e..2f2b04ffb 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacescene.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacescene.h @@ -36,9 +36,9 @@ class AddressSpaceScene : public MemoryAlignScene /*! * The constructor. * - * @param [in] addrSpace The address space being visualized. - * @param [in] expressionParser The expression parser to use for local memory maps. - * @param [in] parent The owner of the scene. + * @param [in] addrSpace The address space being visualized. + * @param [in] expressionParser The expression parser to use for local memory maps. + * @param [in] parent The owner of the scene. */ AddressSpaceScene(QSharedPointer addrSpace, QSharedPointer expressionParser, @@ -58,14 +58,14 @@ class AddressSpaceScene : public MemoryAlignScene /*! * Get the width of the visualized memory. * - * @return The width of the memory. + * @return The width of the memory. */ QString getWidth() const final; /*! * Get the range of the visualized memory. * - * @return The range of the memory. + * @return The range of the memory. */ QString getRange() const final; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizationitem.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizationitem.h index 201c82451..00e5e13f9 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizationitem.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizationitem.h @@ -38,9 +38,9 @@ class AddressSpaceVisualizationItem : public AddressableItem /*! * The constructor * - * @param [in] addrSpace The address space being visualized. - * @param [in] expressionParser The expression parser to use. - * @param [in] parent The parent graphics item. + * @param [in] addrSpace The address space being visualized. + * @param [in] expressionParser The expression parser to use. + * @param [in] parent The parent graphics item. */ AddressSpaceVisualizationItem(QString const& addressSpaceWidth, QSharedPointer expressionParser, @@ -56,49 +56,49 @@ class AddressSpaceVisualizationItem : public AddressableItem /*! * Get the bit width of the address space. * - * @return The bit width of the address space. + * @return The bit width of the address space. */ virtual int getBitWidth() const; /*! * Set the coordinate that is the bottom y-coordinate for the item. * - * @param [in] yCoordinate The y-coordinate of the bottom. + * @param [in] yCoordinate The y-coordinate of the bottom. */ virtual void setBottomCoordinate(qreal yCoordinate); /*! * Set the height for the item. * - * @param [in] height The height to set. + * @param [in] height The height to set. */ virtual void setHeight(qreal height); /*! * Sets the first non-overlapping address to display. * - * @param [in] The first address to set. + * @param [in] The first address to set. */ virtual void setOverlappingTop(quint64 const& address); /*! * Get the first non-overlapping address of the item. * - * @return The first non-overlapping address or -1 if completely overlapped. + * @return The first non-overlapping address or -1 if completely overlapped. */ virtual quint64 getOverlappingTop(); /*! * Sets the last non-overlapping address to display. * - * @param [in] The last address to set. + * @param [in] The last address to set. */ virtual void setOverlappingBottom(quint64 const& address); /*! * Get the last non-overlapping address of the item. * - * @return The last non-overlapping address or -1 if completely overlapped. + * @return The last non-overlapping address or -1 if completely overlapped. */ virtual quint64 getOverlappingBottom(); @@ -108,7 +108,7 @@ class AddressSpaceVisualizationItem : public AddressableItem /*! * Tells if the item is completely overlapped by other items. * - * @return True, if the item's memory is completely under other memory blocks, otherwise false. + * @return True, if the item's memory is completely under other memory blocks, otherwise false. */ virtual bool isCompletelyOverlapped() const; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizer.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizer.h index b5914ee6a..1a55178f4 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizer.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/addressspacevisualizer.h @@ -35,9 +35,9 @@ class AddressSpaceVisualizer : public ItemVisualizer /*! * The constructor. * - * @param [in] addrSpace The address space being visualized. - * @param [in] expressionParser The expression parser to use. - * @param [in] parent The owner of the visualizer. + * @param [in] addrSpace The address space being visualized. + * @param [in] expressionParser The expression parser to use. + * @param [in] parent The owner of the visualizer. */ AddressSpaceVisualizer(QSharedPointer addrSpace, QSharedPointer expressionParser, @@ -52,14 +52,14 @@ class AddressSpaceVisualizer : public ItemVisualizer /*! * The minimum size hint for the visualizer. * - * @return The minimum size hint. + * @return The minimum size hint. */ virtual QSize minimumSizeHint() const; /*! * The size hint for the visualizer. * - * @return The size hint. + * @return The size hint. */ virtual QSize sizeHint() const; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/localaddrblockgraphitem.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/localaddrblockgraphitem.h index dfe5640fd..1ad61adaf 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/localaddrblockgraphitem.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/localaddrblockgraphitem.h @@ -31,10 +31,10 @@ class LocalAddrBlockGraphItem : public AddressSpaceVisualizationItem /*! * The constructor. * - * @param [in] block The address block being visualized. - * @param [in] addressSpaceWidth The width of the address space. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent graph item. + * @param [in] block The address block being visualized. + * @param [in] addressSpaceWidth The width of the address space. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent graph item. */ LocalAddrBlockGraphItem(QSharedPointer block, QString const& addressSpaceWidth, @@ -56,14 +56,14 @@ class LocalAddrBlockGraphItem : public AddressSpaceVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item. + * @return int The offset of the item. */ virtual quint64 getOffset() const override final; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; diff --git a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/segmentgraphitem.h b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/segmentgraphitem.h index c16b9457f..f35a4392e 100644 --- a/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/segmentgraphitem.h +++ b/editors/ComponentEditor/addressSpaces/addressSpaceVisualizer/segmentgraphitem.h @@ -30,10 +30,10 @@ class SegmentGraphItem : public AddressSpaceVisualizationItem /*! * The constructor. * - * @param [in] segment Pointer to the segment represented by this graph item. - * @param [in] addressSpaceWidth Width of the address space. - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parent Pointer to the parent graph item. + * @param [in] segment Pointer to the segment represented by this graph item. + * @param [in] addressSpaceWidth Width of the address space. + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parent Pointer to the parent graph item. */ SegmentGraphItem(QSharedPointer segment, QString const& addressSpaceWidth, QSharedPointer expressionParser, QGraphicsItem* parent = 0); @@ -53,28 +53,28 @@ class SegmentGraphItem : public AddressSpaceVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item. + * @return int The offset of the item. */ virtual quint64 getOffset() const override final; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; /*! * Sets the first non-overlapping address to display. * - * @param [in] address The first address to set. + * @param [in] address The first address to set. */ virtual void setOverlappingTop(quint64 const& address) override final; /*! * Sets the last non-overlapping address to display. * - * @param [in] address The last address to set. + * @param [in] address The last address to set. */ virtual void setOverlappingBottom(quint64 const& address) override final; diff --git a/editors/ComponentEditor/addressSpaces/addressspaceeditor.h b/editors/ComponentEditor/addressSpaces/addressspaceeditor.h index 0e194b013..16bbf7a3a 100644 --- a/editors/ComponentEditor/addressSpaces/addressspaceeditor.h +++ b/editors/ComponentEditor/addressSpaces/addressspaceeditor.h @@ -42,14 +42,14 @@ class AddressSpaceEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] addrSpace The address space being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser to use. - * @param [in] blockInterface Interface for address blocks. - * @param [in] parent The owner of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] addrSpace The address space being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser to use. + * @param [in] blockInterface Interface for address blocks. + * @param [in] parent The owner of this editor. */ AddressSpaceEditor(QSharedPointer component, LibraryInterface* handler, @@ -73,7 +73,7 @@ class AddressSpaceEditor : public ItemEditor /*! * Assign new address unit bits for address blocks. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); diff --git a/editors/ComponentEditor/addressSpaces/addressspacegeneraleditor.h b/editors/ComponentEditor/addressSpaces/addressspacegeneraleditor.h index 5581926f9..b6cc953b3 100644 --- a/editors/ComponentEditor/addressSpaces/addressspacegeneraleditor.h +++ b/editors/ComponentEditor/addressSpaces/addressspacegeneraleditor.h @@ -36,12 +36,12 @@ class AddressSpaceGeneralEditor : public QGroupBox /*! * The constructor. * - * @param [in] addrSpace The address space being edited. - * @param [in] busInterfaceNames A list of master interface names bound to this address space. - * @param [in] parameterFinder The finder for parameters available in expressions. - * @param [in] expressionParser The expression parser. - * @param [in] docRevision The standard revision in use. - * @param [in] parent The owner of the editor. + * @param [in] addrSpace The address space being edited. + * @param [in] busInterfaceNames A list of master interface names bound to this address space. + * @param [in] parameterFinder The finder for parameters available in expressions. + * @param [in] expressionParser The expression parser. + * @param [in] docRevision The standard revision in use. + * @param [in] parent The owner of the editor. */ AddressSpaceGeneralEditor(QSharedPointer addrSpace, QStringList busInterfaceNames, @@ -60,14 +60,14 @@ class AddressSpaceGeneralEditor : public QGroupBox /*! * Check if the editor is in valid state and can be saved. * - * @return True if everything is ok. + * @return True if everything is ok. */ bool isValid() const; /*! * Read the settings from the address space model to the editor fields. * - * @param [in] masterInterfaceNames A list of master interface names bound to this address space. + * @param [in] masterInterfaceNames A list of master interface names bound to this address space. */ void refresh(QStringList masterInterfaceNames); @@ -81,40 +81,40 @@ class AddressSpaceGeneralEditor : public QGroupBox /*! Emitted when user changes the size of an addressable unit. * - * @param units The new addressable unit size. + * @param units The new addressable unit size. */ void addressableUnitsChanged(int units); /*! Emitted when user changes the width of a row in address space. * - * @param width The new width of a row. + * @param width The new width of a row. */ void widthChanged(int width); /*! Emitted when user changes the range of an address space. * - * @param range The new range as number of addressable units. + * @param range The new range as number of addressable units. */ void rangeChanged(QString const& range); /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString id); /*! * Assign new address unit bits for address blocks. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const&); @@ -142,9 +142,9 @@ private slots: /*! * Formats a given expression to human-readable format. * - * @param [in] expression The expression to format. + * @param [in] expression The expression to format. * - * @return The formatted expression. + * @return The formatted expression. */ QString format(QString const& expression) const; diff --git a/editors/ComponentEditor/addressSpaces/addressspacesdelegate.h b/editors/ComponentEditor/addressSpaces/addressspacesdelegate.h index da1c48858..575e0fc4b 100644 --- a/editors/ComponentEditor/addressSpaces/addressspacesdelegate.h +++ b/editors/ComponentEditor/addressSpaces/addressspacesdelegate.h @@ -29,9 +29,9 @@ class AddressSpacesDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The parent object. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The parent object. */ AddressSpacesDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -44,9 +44,9 @@ class AddressSpacesDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/addressSpaces/addressspaceseditor.h b/editors/ComponentEditor/addressSpaces/addressspaceseditor.h index c36e44f82..463124594 100644 --- a/editors/ComponentEditor/addressSpaces/addressspaceseditor.h +++ b/editors/ComponentEditor/addressSpaces/addressspaceseditor.h @@ -35,12 +35,12 @@ class AddressSpacesEditor : public ItemEditor /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder Finder for parameter names. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser The expression parser to use. - * @param [in] addressSpaceValidator Validator used for address spaces. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder Finder for parameter names. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser The expression parser to use. + * @param [in] addressSpaceValidator Validator used for address spaces. */ AddressSpacesEditor(QSharedPointer component, LibraryInterface* handler, @@ -65,7 +65,7 @@ class AddressSpacesEditor : public ItemEditor /*! * Emitted when address unit bits change on the given row. * - * @param [in] spaceIndex The index of the address space where address unit bits were changed. + * @param [in] spaceIndex The index of the address space where address unit bits were changed. */ void aubChangedOnRow(int spaceIndex) const; diff --git a/editors/ComponentEditor/addressSpaces/addressspacesmodel.h b/editors/ComponentEditor/addressSpaces/addressspacesmodel.h index e0a271ee7..f34bcb8b0 100644 --- a/editors/ComponentEditor/addressSpaces/addressspacesmodel.h +++ b/editors/ComponentEditor/addressSpaces/addressspacesmodel.h @@ -35,11 +35,11 @@ class AddressSpacesModel : public ReferencingTableModel, public ParameterizableT /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] parameterFinder The finder for available parameter names. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] addressSpaceValidator Validator used for address spaces. - * @param [in] parent The owner of the model. + * @param [in] component The component being edited. + * @param [in] parameterFinder The finder for available parameter names. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] addressSpaceValidator Validator used for address spaces. + * @param [in] parent The owner of the model. */ AddressSpacesModel(QSharedPointer component, QSharedPointer parameterFinder, @@ -53,66 +53,66 @@ class AddressSpacesModel : public ReferencingTableModel, public ParameterizableT /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -121,21 +121,21 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -152,21 +152,21 @@ public slots: /*! * Emitted when a new file set is added to the model. * - * @param [in] index The index of the added file set. + * @param [in] index The index of the added file set. */ void addrSpaceAdded(int index); /*! * Emitted when a file set is removed from the model. * - * @param [in] index The index of the remove file set. + * @param [in] index The index of the remove file set. */ void addrSpaceRemoved(int index); /*! * Emitted when address unit bits are changed in an address space. * - * @param [in] addressSpaceindex Index of the target address space. + * @param [in] addressSpaceindex Index of the target address space. */ void aubChangedOnRow(int addressSpaceindex); @@ -175,37 +175,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -214,23 +214,23 @@ public slots: /*! * Decrease the number of references made from a removed address space. * - * @param [in] removedAddressSpace The removed address space. + * @param [in] removedAddressSpace The removed address space. */ void decreaseReferencesWithRemovedAddressSpace(QSharedPointer removedAddressSpace); /*! * Get the names of the contained address blocks. * - * @return The names of the contained address blocks. + * @return The names of the contained address blocks. */ QStringList getCurrentItemNames(); /*! * Increase the number of references made in the copied address space. * - * @param [in] pastedSpace The copied address space. - * @param [in] gatherer Address space expressions gatherer. - * @param [in] referenceCalculator The reference calculator. + * @param [in] pastedSpace The copied address space. + * @param [in] gatherer Address space expressions gatherer. + * @param [in] referenceCalculator The reference calculator. */ void increaseReferencesInPastedAddressSpace(QSharedPointer pastedSpace, AddressSpaceExpressionGatherer& gatherer, ReferenceCalculator& referenceCalculator); diff --git a/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapeditor.h b/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapeditor.h index bb82570c0..f7b4a4e78 100644 --- a/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapeditor.h +++ b/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapeditor.h @@ -40,12 +40,12 @@ class LocalMemoryMapEditor : public QGroupBox /*! * The constructor. * - * @param [in] addressSpace Pointer to the local memory map being edited. - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance managing the library. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] blockInterface Interface for address blocks. - * @param [in] parent Pointer to the owner of the editor. + * @param [in] addressSpace Pointer to the local memory map being edited. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance managing the library. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] blockInterface Interface for address blocks. + * @param [in] parent Pointer to the owner of the editor. */ LocalMemoryMapEditor(QSharedPointer addressSpace, QSharedPointer component, @@ -87,21 +87,21 @@ class LocalMemoryMapEditor : public QGroupBox /*! * Increase the amount of references to a parameter. * - * @param [in] id The id of the parameter. + * @param [in] id The id of the parameter. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter. * - * @param [in] id The id of the parameter. + * @param [in] id The id of the parameter. */ void decreaseReferences(QString id); /*! * Assign the new address unit bits for address blocks. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); diff --git a/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapgraphitem.h b/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapgraphitem.h index aad462bdb..bc909eb96 100644 --- a/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapgraphitem.h +++ b/editors/ComponentEditor/addressSpaces/localMemoryMap/localmemorymapgraphitem.h @@ -29,9 +29,9 @@ class LocalMemoryMapGraphItem : public MemoryMapGraphItem /*! The constructor * - * @param [in] addrSpace The address space that contains the local memory map. - * @param [in] localMemoryMap The local memory map. - * @param [in] parent The owner of the graphics item. + * @param [in] addrSpace The address space that contains the local memory map. + * @param [in] localMemoryMap The local memory map. + * @param [in] parent The owner of the graphics item. * */ LocalMemoryMapGraphItem(QSharedPointer addrSpace, @@ -51,7 +51,7 @@ class LocalMemoryMapGraphItem : public MemoryMapGraphItem /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override final; diff --git a/editors/ComponentEditor/addressSpaces/segmenteditor.h b/editors/ComponentEditor/addressSpaces/segmenteditor.h index dc73870c7..94cf527de 100644 --- a/editors/ComponentEditor/addressSpaces/segmenteditor.h +++ b/editors/ComponentEditor/addressSpaces/segmenteditor.h @@ -37,13 +37,13 @@ class SegmentEditor : public QGroupBox /*! * The constructor * - * @param [in] addrSpace The address space whose segments are edited. - * @param [in] component The component being edited. - * @param [in] componentPath The path to component xml file. - * @param [in] parameterFinder Finder for available parameter names. - * @param [in] expressionParser Parser for expressions. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] addrSpace The address space whose segments are edited. + * @param [in] component The component being edited. + * @param [in] componentPath The path to component xml file. + * @param [in] parameterFinder Finder for available parameter names. + * @param [in] expressionParser Parser for expressions. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] parent Pointer to the owner of this editor. */ SegmentEditor(QSharedPointer addrSpace, QSharedPointer component, @@ -87,14 +87,14 @@ class SegmentEditor : public QGroupBox /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString id); diff --git a/editors/ComponentEditor/addressSpaces/segmentsmodel.h b/editors/ComponentEditor/addressSpaces/segmentsmodel.h index 1733139ca..1121ef081 100644 --- a/editors/ComponentEditor/addressSpaces/segmentsmodel.h +++ b/editors/ComponentEditor/addressSpaces/segmentsmodel.h @@ -34,10 +34,10 @@ class SegmentsModel : public ReferencingTableModel, public ParameterizableTable /*! * The constructor. * - * @param [in] segments The segments being edited. - * @param [in] parameterFinder The finder for available parameter names. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] parent The owner of this model. + * @param [in] segments The segments being edited. + * @param [in] parameterFinder The finder for available parameter names. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] parent The owner of this model. */ SegmentsModel(QSharedPointer > > segments, QSharedPointer parameterFinder, @@ -50,66 +50,66 @@ class SegmentsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed (always 4). + * @return The number of columns to be displayed (always 4). */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -118,21 +118,21 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -146,37 +146,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -214,22 +214,22 @@ public slots: * * If there are no segments defined then 0 is returned. * - * @return The last address contained in a segment. + * @return The last address contained in a segment. */ quint64 getLastSegmentedAddress() const; /*! * Get the names of the contained address blocks. * - * @return The names of the contained address blocks. + * @return The names of the contained address blocks. */ QStringList getCurrentItemNames(); /*! * Increase the number of references made in the copied address space segment. * - * @param [in] pastedSegment The copied address space segment. - * @param [in] referenceCalculator The reference calculator. + * @param [in] pastedSegment The copied address space segment. + * @param [in] referenceCalculator The reference calculator. */ void increaseReferencesInPastedSegment(QSharedPointer pastedSegment, ReferenceCalculator& referenceCalculator); diff --git a/editors/ComponentEditor/busInterfaces/AbstractionTypesDelegate.h b/editors/ComponentEditor/busInterfaces/AbstractionTypesDelegate.h index af6212602..dc8ce3f2c 100644 --- a/editors/ComponentEditor/busInterfaces/AbstractionTypesDelegate.h +++ b/editors/ComponentEditor/busInterfaces/AbstractionTypesDelegate.h @@ -30,10 +30,10 @@ class AbstractionTypesDelegate : public EnumerationEditorConstructorDelegate /*! * The constructor. * - * @param [in] component Component containing the abstraction types. - * @param [in] library VLNV library interface. - * @param [in] parentWindow The main window. - * @param [in] parent The parent object. + * @param [in] component Component containing the abstraction types. + * @param [in] library VLNV library interface. + * @param [in] parentWindow The main window. + * @param [in] parent The parent object. */ AbstractionTypesDelegate(QSharedPointer component, LibraryInterface* library, QWidget* parentWindow, QObject* parent = 0); @@ -50,11 +50,11 @@ class AbstractionTypesDelegate : public EnumerationEditorConstructorDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const final; @@ -62,24 +62,24 @@ class AbstractionTypesDelegate : public EnumerationEditorConstructorDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const final; /*! * Set a new component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void setComponent(QSharedPointer newComponent); @@ -88,43 +88,43 @@ class AbstractionTypesDelegate : public EnumerationEditorConstructorDelegate /*! * Create the VLNV editor for abstraction definition references. * - * @param [in] parent Parent item for the editor. + * @param [in] parent Parent item for the editor. * - * @return The created VLNV editor. + * @return The created VLNV editor. */ QWidget* createVLNVEditor(QWidget* parent) const; /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ bool isEnumerationEditorColumn(QModelIndex const& index) const final; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ QStringList getCurrentSelection(QModelIndex const& index) const final; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ QStringList getAvailableItems() const final; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const final; diff --git a/editors/ComponentEditor/busInterfaces/AbstractionTypesEditor.h b/editors/ComponentEditor/busInterfaces/AbstractionTypesEditor.h index ecfdf30af..edf994fb7 100644 --- a/editors/ComponentEditor/busInterfaces/AbstractionTypesEditor.h +++ b/editors/ComponentEditor/busInterfaces/AbstractionTypesEditor.h @@ -37,11 +37,11 @@ class AbstractionTypesEditor : public QGroupBox /*! * The constructor. * - * @param [in] component Component containing the edited port. - * @param [in] library Interface for the VLNV library. - * @param [in] abstractionTypeInterface Interface for accessing abstraction types. - * @param [in] parentWindow The main window. - * @param [in] parent The owner of the editor. + * @param [in] component Component containing the edited port. + * @param [in] library Interface for the VLNV library. + * @param [in] abstractionTypeInterface Interface for accessing abstraction types. + * @param [in] parentWindow The main window. + * @param [in] parent The owner of the editor. */ AbstractionTypesEditor(QSharedPointer component, LibraryInterface* library, @@ -61,7 +61,7 @@ class AbstractionTypesEditor : public QGroupBox /*! * Set a new component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void setComponent(QSharedPointer newComponent); @@ -73,7 +73,7 @@ class AbstractionTypesEditor : public QGroupBox /*! * Add a new abstraction definition referencing the selected VLNV to the bus interface. * - * @param [in] newAbstraction The selected VLNV. + * @param [in] newAbstraction The selected VLNV. */ void addNewAbstraction(VLNV const& newAbstraction); diff --git a/editors/ComponentEditor/busInterfaces/AbstractionTypesModel.h b/editors/ComponentEditor/busInterfaces/AbstractionTypesModel.h index b26ecebe6..f2417bf28 100644 --- a/editors/ComponentEditor/busInterfaces/AbstractionTypesModel.h +++ b/editors/ComponentEditor/busInterfaces/AbstractionTypesModel.h @@ -39,9 +39,9 @@ class AbstractionTypesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] abstractionInterface Interface for accessing abstraction types. - * @param [in] component The conaining component. - * @param [in] parent Pointer to the owner of this model. + * @param [in] abstractionInterface Interface for accessing abstraction types. + * @param [in] component The conaining component. + * @param [in] parent Pointer to the owner of this model. */ AbstractionTypesModel(AbstractionTypeInterface* abstractionInterface, QSharedPointer component, LibraryInterface* library, QObject* parent); @@ -54,59 +54,59 @@ class AbstractionTypesModel : public QAbstractTableModel /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Always returns 2. + * @return Always returns 2. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted. - * @param [in] orientation Only Qt::Horizontal is supported. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation Only Qt::Horizontal is supported. + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified. - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified. + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; @@ -118,27 +118,27 @@ class AbstractionTypesModel : public QAbstractTableModel /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ bool dropMimeData(QMimeData const* data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -146,7 +146,7 @@ class AbstractionTypesModel : public QAbstractTableModel /*! * Add a new abstraction type referencing the selected abstraction definition VLNV. * - * @param [in] newAbstractionVLNV The selected abstraction definition VLNV. + * @param [in] newAbstractionVLNV The selected abstraction definition VLNV. */ void addNewAbstractionTypeWithVLNV(VLNV const& newAbstractionVLNV); @@ -160,14 +160,14 @@ public slots: /*! * Handles the addition of new abstraction types. * - * @param [in] index Index of the new abstraction type. + * @param [in] index Index of the new abstraction type. */ virtual void onAddItem(QModelIndex const& index); /*! * Handles the removal of abstraction types. * - * @param [in] index Identifies the abstraction type that should be removed. + * @param [in] index Identifies the abstraction type that should be removed. */ virtual void onRemoveItem(QModelIndex const& index); @@ -202,26 +202,26 @@ public slots: /*! * Get the color for the indexed abstraction type. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Black for valid index, red for invalid index. + * @return Black for valid index, red for invalid index. */ QVariant blackForValidRedForInvalid(QModelIndex const& index) const; /*! * Validate the indexed abstraction type. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the indexed abstraction type is valid, false otherwise. + * @return True, if the indexed abstraction type is valid, false otherwise. */ bool validateIndex(QModelIndex const& index) const; /*! * Set a new abstraction reference to the selected abstraction type. * - * @param [in] abstractionIndex Index of the selected abstraction type. - * @param [in] newVLNV VLNV of the new abstraction reference. + * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] newVLNV VLNV of the new abstraction reference. */ void setVLNVForAbstraction(int const& abstractionIndex, VLNV const& newVLNV); diff --git a/editors/ComponentEditor/busInterfaces/businterfaceeditor.h b/editors/ComponentEditor/busInterfaces/businterfaceeditor.h index 8e2b3577b..6147fdcf4 100644 --- a/editors/ComponentEditor/busInterfaces/businterfaceeditor.h +++ b/editors/ComponentEditor/busInterfaces/businterfaceeditor.h @@ -44,16 +44,16 @@ class BusInterfaceEditor : public ParameterItemEditor /*! * The constructor. * - * @param [in] libHandler The library handler instance. - * @param [in] component The component being edited. - * @param [in] busif The bus interface being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of this container. - * @param [in] parentWnd The parent window. + * @param [in] libHandler The library handler instance. + * @param [in] component The component being edited. + * @param [in] busif The bus interface being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of this container. + * @param [in] parentWnd The parent window. */ BusInterfaceEditor(LibraryInterface* libHandler, QSharedPointer component, @@ -74,7 +74,7 @@ class BusInterfaceEditor : public ParameterItemEditor /*! * Sets the protection state of the editor. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); diff --git a/editors/ComponentEditor/busInterfaces/businterfacesdelegate.h b/editors/ComponentEditor/busInterfaces/businterfacesdelegate.h index 59a77f113..7303ae3a4 100644 --- a/editors/ComponentEditor/busInterfaces/businterfacesdelegate.h +++ b/editors/ComponentEditor/busInterfaces/businterfacesdelegate.h @@ -29,7 +29,7 @@ class BusInterfacesDelegate : public MultilineDescriptionDelegate /*! The constructor * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ BusInterfacesDelegate(Document::Revision docRevision, QObject *parent); @@ -42,28 +42,28 @@ class BusInterfacesDelegate : public MultilineDescriptionDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/busInterfaces/businterfaceseditor.h b/editors/ComponentEditor/busInterfaces/businterfaceseditor.h index a8bb69d75..33e8b52c6 100644 --- a/editors/ComponentEditor/busInterfaces/businterfaceseditor.h +++ b/editors/ComponentEditor/busInterfaces/businterfaceseditor.h @@ -51,11 +51,11 @@ class BusInterfacesEditor : public ItemEditor /*! * The constructor. * - * @param [in] handler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of this editor. + * @param [in] handler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of this editor. */ BusInterfacesEditor(LibraryInterface* handler, QSharedPointer component, diff --git a/editors/ComponentEditor/busInterfaces/businterfacesmodel.h b/editors/ComponentEditor/busInterfaces/businterfacesmodel.h index 6d75bbc77..e1032cb50 100644 --- a/editors/ComponentEditor/busInterfaces/businterfacesmodel.h +++ b/editors/ComponentEditor/busInterfaces/businterfacesmodel.h @@ -34,11 +34,11 @@ class BusInterfacesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] libHandler The instance that manages the library. - * @param [in] component The containing component. - * @param [in] parameterFinder The parameter finder. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this model. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The containing component. + * @param [in] parameterFinder The parameter finder. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this model. */ BusInterfacesModel(LibraryInterface* libHandler, QSharedPointer component, QSharedPointer parameterFinder, BusInterfaceInterface* busInterface, QObject *parent); @@ -51,86 +51,86 @@ class BusInterfacesModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ bool dropMimeData(QMimeData const* data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -140,29 +140,29 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); /*! * Move item from the original position to new position. * - * @param [in] originalPos The index identifying the item to move. - * @param [in] newPos The index identifying the position of the item after the move. + * @param [in] originalPos The index identifying the item to move. + * @param [in] newPos The index identifying the position of the item after the move. */ virtual void onMoveItem( QModelIndex const& originalPos, QModelIndex const& newPos ); /*! * Handle the bus interface copying. * - * @param [in] indexList List of indexes to be copied. + * @param [in] indexList List of indexes to be copied. */ void onCopyRows(QModelIndexList indexList); @@ -181,36 +181,36 @@ public slots: /*! * Emitted when a new bus interface is added to the model. * - * @param [in] index The index of the added bus interface. + * @param [in] index The index of the added bus interface. */ void busifAdded(int index); /*! * Emitted when a bus interface is removed from the model. * - * @param [in] index The index of the bus interface to remove. + * @param [in] index The index of the bus interface to remove. */ void busifRemoved(int index); /*! * Emitted when a bus interface is moved from one position to another. * - * @param [in] source The row number of the bus interface before the move. - * @param [in] target The row number of the bus interface after the move. + * @param [in] source The row number of the bus interface before the move. + * @param [in] target The row number of the bus interface after the move. */ void busIfMoved(int source, int target); /*! * Increase the number of references made to the specified parameter. * - * @param [in] id Id of the parameter whose reference count is increased. + * @param [in] id Id of the parameter whose reference count is increased. */ void increaseReferences(QString id); /*! * Decrease the number of references made to the specified parameter. * - * @param [in] id Id of the parameter whose reference count is decreased. + * @param [in] id Id of the parameter whose reference count is decreased. */ void decreaseReferences(QString id); @@ -228,23 +228,23 @@ public slots: /*! * Remove references from the expressions contained within the removed bus interface. * - * @param [in] busInterfaceIndex The index of the removed bus interface. + * @param [in] busInterfaceIndex The index of the removed bus interface. */ void removeReferencesFromExpressions(int busInterfaceIndex); /*! * Increase the number of references made in the selected bus interface. * - * @param [in] registerName Name of the selected bus interface. + * @param [in] registerName Name of the selected bus interface. */ void increaseReferencesInPastedBus(QString const& busName); /*! * Calculates the parameters used in the selected bus interface. * - * @param [in] registerName Name of the selected bus interface. + * @param [in] registerName Name of the selected bus interface. * - * @return A map containing pairs of referenced ids and the number of references made to them. + * @return A map containing pairs of referenced ids and the number of references made to them. */ QMap getReferencedParameters(QString const& busName) const; diff --git a/editors/ComponentEditor/busInterfaces/general/InitiatorModeEditor.h b/editors/ComponentEditor/busInterfaces/general/InitiatorModeEditor.h index 96d71dc3b..2092b96dc 100644 --- a/editors/ComponentEditor/busInterfaces/general/InitiatorModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/InitiatorModeEditor.h @@ -41,12 +41,12 @@ class InitiatorModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this editor. */ InitiatorModeEditor( BusInterfaceInterface* busInterface, @@ -65,7 +65,7 @@ class InitiatorModeEditor : public ModeEditorBase /*! Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -76,7 +76,7 @@ class InitiatorModeEditor : public ModeEditorBase /*! Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -93,14 +93,14 @@ class InitiatorModeEditor : public ModeEditorBase /*! * Increase the number of references to the given parameter. * - * @param [in] id The id of the target parameter. + * @param [in] id The id of the target parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references to the given parameter. * - * @param [in] id The id of the target parameter. + * @param [in] id The id of the target parameter. */ void decreaseReferences(QString const& id); @@ -109,7 +109,7 @@ private slots: /*! * Handler for changes in address space reference. * - * @param [in] addrSpaceName The name of the referenced address space. + * @param [in] addrSpaceName The name of the referenced address space. */ void onAddressSpaceChange(QString const& addrSpaceName); diff --git a/editors/ComponentEditor/busInterfaces/general/MasterModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MasterModeEditor.h index a3dd32dcc..66d026c65 100644 --- a/editors/ComponentEditor/busInterfaces/general/MasterModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MasterModeEditor.h @@ -41,12 +41,12 @@ class MasterModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bud interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bud interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this editor. */ MasterModeEditor( BusInterfaceInterface* busInterface, @@ -65,7 +65,7 @@ class MasterModeEditor : public ModeEditorBase /*! Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -76,7 +76,7 @@ class MasterModeEditor : public ModeEditorBase /*! Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -93,14 +93,14 @@ class MasterModeEditor : public ModeEditorBase /*! * Increase the number of references to the given parameter. * - * @param [in] id The id of the target parameter. + * @param [in] id The id of the target parameter. */ void increaseReferences(QString id); /*! * Decrease the number of references to the given parameter. * - * @param [in] id The id of the target parameter. + * @param [in] id The id of the target parameter. */ void decreaseReferences(QString id); @@ -109,7 +109,7 @@ private slots: /*! * Handler for changes in address space reference. * - * @param [in] addrSpaceName The name of the referenced address space. + * @param [in] addrSpaceName The name of the referenced address space. */ void onAddressSpaceChange(QString const& addrSpaceName); diff --git a/editors/ComponentEditor/busInterfaces/general/MirroredInitiatorModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MirroredInitiatorModeEditor.h index 0e0a6f718..d93f02b04 100644 --- a/editors/ComponentEditor/busInterfaces/general/MirroredInitiatorModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MirroredInitiatorModeEditor.h @@ -27,8 +27,8 @@ class MirroredInitiatorModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent Parent widget of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent Parent widget of this editor. */ MirroredInitiatorModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, QWidget* parent); @@ -46,7 +46,7 @@ class MirroredInitiatorModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -58,7 +58,7 @@ class MirroredInitiatorModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; diff --git a/editors/ComponentEditor/busInterfaces/general/MirroredMasterModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MirroredMasterModeEditor.h index b3af4f961..2afdbd747 100644 --- a/editors/ComponentEditor/busInterfaces/general/MirroredMasterModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MirroredMasterModeEditor.h @@ -27,8 +27,8 @@ class MirroredMasterModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent Parent widget of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent Parent widget of this editor. */ MirroredMasterModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, QWidget* parent); @@ -46,7 +46,7 @@ class MirroredMasterModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -58,7 +58,7 @@ class MirroredMasterModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; diff --git a/editors/ComponentEditor/busInterfaces/general/MirroredSlaveModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MirroredSlaveModeEditor.h index 28351cd86..9dee19c0a 100644 --- a/editors/ComponentEditor/busInterfaces/general/MirroredSlaveModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MirroredSlaveModeEditor.h @@ -38,11 +38,11 @@ class MirroredSlaveModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this editor. */ MirroredSlaveModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, @@ -62,7 +62,7 @@ class MirroredSlaveModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -75,7 +75,7 @@ class MirroredSlaveModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor. * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -106,14 +106,14 @@ private slots: /*! * Increase the number of references in the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references in the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/busInterfaces/general/MirroredTargetModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MirroredTargetModeEditor.h index 2ae53204f..22f201795 100644 --- a/editors/ComponentEditor/busInterfaces/general/MirroredTargetModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MirroredTargetModeEditor.h @@ -38,11 +38,11 @@ class MirroredTargetModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this editor. */ MirroredTargetModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, @@ -62,7 +62,7 @@ class MirroredTargetModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -75,7 +75,7 @@ class MirroredTargetModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor. * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -106,14 +106,14 @@ private slots: /*! * Increase the number of references in the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references in the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/busInterfaces/general/ModeEditorBase.h b/editors/ComponentEditor/busInterfaces/general/ModeEditorBase.h index c11e58a49..0d121fb95 100644 --- a/editors/ComponentEditor/busInterfaces/general/ModeEditorBase.h +++ b/editors/ComponentEditor/busInterfaces/general/ModeEditorBase.h @@ -33,10 +33,10 @@ class ModeEditorBase : public QGroupBox /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] title The title for the group box - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] title The title for the group box + * @param [in] parent The owner of this editor. */ ModeEditorBase(BusInterfaceInterface* busInterface, std::string const& busName, QString const& title, QWidget* parent); @@ -54,7 +54,7 @@ class ModeEditorBase : public QGroupBox /*! * Check for the validity of the mode specific items. * - * @return True if item is valid. + * @return True if item is valid. */ virtual bool isValid() const = 0; @@ -66,7 +66,7 @@ class ModeEditorBase : public QGroupBox /*! * Get the interface mode of the editor. * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ virtual General::InterfaceMode getInterfaceMode() const = 0; @@ -78,7 +78,7 @@ class ModeEditorBase : public QGroupBox /*! * Change the name of the edited bus interface. * - * @param [in] newName New name of the bus interface. + * @param [in] newName New name of the bus interface. */ void changeName(std::string const& newName); diff --git a/editors/ComponentEditor/busInterfaces/general/MonitorModeEditor.h b/editors/ComponentEditor/busInterfaces/general/MonitorModeEditor.h index 143ea9fca..aa536305c 100644 --- a/editors/ComponentEditor/busInterfaces/general/MonitorModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/MonitorModeEditor.h @@ -40,10 +40,10 @@ class MonitorModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] libHandler The library handler instance. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] libHandler The library handler instance. + * @param [in] parent The owner of this editor. * */ MonitorModeEditor(BusInterfaceInterface* busInterface, @@ -67,7 +67,7 @@ class MonitorModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -79,7 +79,7 @@ class MonitorModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor. * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -93,14 +93,14 @@ private slots: /*! * Handles the monitor interface mode change. * - * @param [in] mode New interface mode. + * @param [in] mode New interface mode. */ void onInterfaceModeChange(General::InterfaceMode mode); /*! * Handler for monitor system group changes. * - * @param [in] groupName New system group. + * @param [in] groupName New system group. */ void onSystemGroupChange(QString const& groupName); diff --git a/editors/ComponentEditor/busInterfaces/general/SlaveModeEditor.h b/editors/ComponentEditor/busInterfaces/general/SlaveModeEditor.h index 5547fc024..bfff48028 100644 --- a/editors/ComponentEditor/busInterfaces/general/SlaveModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/SlaveModeEditor.h @@ -40,10 +40,10 @@ class SlaveModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] revision Currently active IP-XACT revision. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] revision Currently active IP-XACT revision. + * @param [in] parent The owner of this editor. */ SlaveModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, Document::Revision revision, QWidget* parent); @@ -60,7 +60,7 @@ class SlaveModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -72,7 +72,7 @@ class SlaveModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -86,21 +86,21 @@ private slots: /*! * Handler for changes in the memory map reference. * - * @param [in] newMemoryMapName The name of the selected memory map. + * @param [in] newMemoryMapName The name of the selected memory map. */ void onMemoryMapChange(QString const& newMemoryMapName); /*! * Handler for selecting the memory map. * - * @param [in] checked True, if the memory map was selected. + * @param [in] checked True, if the memory map was selected. */ void onMemoryMapSelected(bool checked); /*! * Handler for selecting the transparent bridges. * - * @param [in] checked True, if the transparent bridges was selected. + * @param [in] checked True, if the transparent bridges was selected. */ void onTransparentBridgeSelected(bool checked); diff --git a/editors/ComponentEditor/busInterfaces/general/SystemModeEditor.h b/editors/ComponentEditor/busInterfaces/general/SystemModeEditor.h index 0ecc0d8ef..f7b16d5e5 100644 --- a/editors/ComponentEditor/busInterfaces/general/SystemModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/SystemModeEditor.h @@ -35,10 +35,10 @@ class SystemModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] libHandler The library handler instance. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] libHandler The library handler instance. + * @param [in] parent The owner of this editor. */ SystemModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, @@ -57,7 +57,7 @@ class SystemModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -69,7 +69,7 @@ class SystemModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -83,7 +83,7 @@ private slots: /*! * Handler for changes in system group selector. * - * @param [in] newGroup New system group. + * @param [in] newGroup New system group. */ void onGroupChange(QString const& newGroup); diff --git a/editors/ComponentEditor/busInterfaces/general/TargetModeEditor.h b/editors/ComponentEditor/busInterfaces/general/TargetModeEditor.h index 8dda46831..1e04989a9 100644 --- a/editors/ComponentEditor/busInterfaces/general/TargetModeEditor.h +++ b/editors/ComponentEditor/busInterfaces/general/TargetModeEditor.h @@ -40,10 +40,10 @@ class TargetModeEditor : public ModeEditorBase /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] revision Currently active IP-XACT revision. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] revision Currently active IP-XACT revision. + * @param [in] parent The owner of this editor. */ TargetModeEditor(BusInterfaceInterface* busInterface, std::string const& busName, Document::Revision revision, QWidget* parent); @@ -60,7 +60,7 @@ class TargetModeEditor : public ModeEditorBase /*! * Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ bool isValid() const final; @@ -72,7 +72,7 @@ class TargetModeEditor : public ModeEditorBase /*! * Get the interface mode of the editor * - * @return General::InterfaceMode Specifies the interface mode. + * @return General::InterfaceMode Specifies the interface mode. */ General::InterfaceMode getInterfaceMode() const final; @@ -86,21 +86,21 @@ private slots: /*! * Handler for changes in the memory map reference. * - * @param [in] newMemoryMapName The name of the selected memory map. + * @param [in] newMemoryMapName The name of the selected memory map. */ void onMemoryMapChange(QString const& newMemoryMapName); /*! * Handler for selecting the memory map. * - * @param [in] checked True, if the memory map was selected. + * @param [in] checked True, if the memory map was selected. */ void onMemoryMapSelected(bool checked); /*! * Handler for selecting the transparent bridges. * - * @param [in] checked True, if the transparent bridges was selected. + * @param [in] checked True, if the transparent bridges was selected. */ void onTransparentBridgeSelected(bool checked); diff --git a/editors/ComponentEditor/busInterfaces/general/bridgesdelegate.h b/editors/ComponentEditor/busInterfaces/general/bridgesdelegate.h index f3d670f5c..945d47c60 100644 --- a/editors/ComponentEditor/busInterfaces/general/bridgesdelegate.h +++ b/editors/ComponentEditor/busInterfaces/general/bridgesdelegate.h @@ -32,9 +32,9 @@ class BridgesDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] revision Currently active IP-XACT revision. - * @param [in] parent The owner of this delegate. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] revision Currently active IP-XACT revision. + * @param [in] parent The owner of this delegate. */ BridgesDelegate(BusInterfaceInterface* busInterface, Document::Revision revision, QObject* parent); @@ -51,11 +51,11 @@ class BridgesDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const final; @@ -63,17 +63,17 @@ class BridgesDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const final; diff --git a/editors/ComponentEditor/busInterfaces/general/bridgeseditor.h b/editors/ComponentEditor/busInterfaces/general/bridgeseditor.h index 5ad5dcac1..79280f426 100644 --- a/editors/ComponentEditor/busInterfaces/general/bridgeseditor.h +++ b/editors/ComponentEditor/busInterfaces/general/bridgeseditor.h @@ -43,10 +43,10 @@ class BridgesEditor : public QGroupBox /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] bridges The bridges to edit in the editor. - * @param [in] currentRevision Currently active IP-XACT revision. - * @param [in] parent The parent of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] bridges The bridges to edit in the editor. + * @param [in] currentRevision Currently active IP-XACT revision. + * @param [in] parent The parent of this editor. */ BridgesEditor(BusInterfaceInterface* busInterface, QSharedPointer > > bridges, @@ -66,7 +66,7 @@ class BridgesEditor : public QGroupBox /*! * Setup the bridges for the editor. * - * @param [in] newBridges The new bridges. + * @param [in] newBridges The new bridges. */ void setupBridges(QSharedPointer > > newBridges); diff --git a/editors/ComponentEditor/busInterfaces/general/bridgesmodel.h b/editors/ComponentEditor/busInterfaces/general/bridgesmodel.h index de45e0f6c..e73e6625a 100644 --- a/editors/ComponentEditor/busInterfaces/general/bridgesmodel.h +++ b/editors/ComponentEditor/busInterfaces/general/bridgesmodel.h @@ -31,8 +31,8 @@ class BridgesModel : public QAbstractTableModel /*! * The constructor * - * @param [in] bridgeInterface Interface for accessing transparent bridges. - * @param [in] parent The parent of this model. + * @param [in] bridgeInterface Interface for accessing transparent bridges. + * @param [in] parent The parent of this model. */ BridgesModel(TransparentBridgeInterface* bridgeInterface, QObject *parent); @@ -44,59 +44,59 @@ class BridgesModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -109,13 +109,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); diff --git a/editors/ComponentEditor/busInterfaces/general/busifgeneraldetails.h b/editors/ComponentEditor/busInterfaces/general/busifgeneraldetails.h index f4f623a1d..d5f0ffd4e 100644 --- a/editors/ComponentEditor/busInterfaces/general/busifgeneraldetails.h +++ b/editors/ComponentEditor/busInterfaces/general/busifgeneraldetails.h @@ -39,10 +39,10 @@ class BusIfGeneralDetails : public QGroupBox /*! * The constructor * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the bus interface being edited. - * @param [in] docRevision The IP-XACT version to comply to. - * @param [in] parent The owner of this editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the bus interface being edited. + * @param [in] docRevision The IP-XACT version to comply to. + * @param [in] parent The owner of this editor. */ BusIfGeneralDetails(BusInterfaceInterface* busInterface, std::string const& busName, Document::Revision docRevision, QSharedPointer finder, @@ -62,7 +62,7 @@ class BusIfGeneralDetails : public QGroupBox /*! Check for the validity of the edited item. * - * @return True if item is valid. + * @return True if item is valid. */ virtual bool isValid() const; @@ -74,7 +74,7 @@ class BusIfGeneralDetails : public QGroupBox /*! * Change the name of the bus interface being edited. * - * @param [in] newName The new bus interface name. + * @param [in] newName The new bus interface name. */ void changeName(std::string const& newName); diff --git a/editors/ComponentEditor/busInterfaces/general/busifgeneraltab.h b/editors/ComponentEditor/busInterfaces/general/busifgeneraltab.h index 23fb7e74c..ea8b2c771 100644 --- a/editors/ComponentEditor/busInterfaces/general/busifgeneraltab.h +++ b/editors/ComponentEditor/busInterfaces/general/busifgeneraltab.h @@ -46,16 +46,16 @@ class BusIfGeneralTab : public QWidget /*! * The constructor. * - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] busif Pointer to the bus interface being edited. - * @param [in] component Pointer to the component being edited. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] parent Pointer to the owner of this editor. - * @param [in] parentWnd Pointer to the parent window. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] busif Pointer to the bus interface being edited. + * @param [in] component Pointer to the component being edited. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] parent Pointer to the owner of this editor. + * @param [in] parentWnd Pointer to the parent window. */ BusIfGeneralTab(LibraryInterface* libHandler, QSharedPointer busif, @@ -79,14 +79,14 @@ class BusIfGeneralTab : public QWidget /*! * Get the currently set bus type. * - * @return VLNV that is set for the current bus type. + * @return VLNV that is set for the current bus type. */ VLNV getBusType() const; /*! * Locks/unlocks the VLNV selection for bus definition and abstraction definition. * - * @param [in] locked The lock to set. + * @param [in] locked The lock to set. */ void setBusTypesLock( bool locked ); @@ -115,30 +115,30 @@ class BusIfGeneralTab : public QWidget /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); /*! * Open the reference tree of the parameter corresponding to the ID. * - * @param [in] ID The ID of the selected parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] ID The ID of the selected parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName) const; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); @@ -146,7 +146,7 @@ class BusIfGeneralTab : public QWidget /*! * Inform of the name change in the edited bus interface. * - * @param [in] newName New name of the bus interface. + * @param [in] newName New name of the bus interface. */ void nameChanged(std::string const& newName); @@ -179,14 +179,14 @@ private slots: /*! * Set the bus type for the bus interface. * - * @param [in] busDefVLNV The vlnv identifying the bus type. + * @param [in] busDefVLNV The vlnv identifying the bus type. */ void onSetBusType(const VLNV& busDefVLNV); /*! * Set the abstraction type for the bus interface. * - * @param [in] absDefVLNV The vlnv identifying the abstraction definition. + * @param [in] absDefVLNV The vlnv identifying the abstraction definition. */ void onSetAbsType(const VLNV& absDefVLNV); diff --git a/editors/ComponentEditor/busInterfaces/general/interfacemodestack.h b/editors/ComponentEditor/busInterfaces/general/interfacemodestack.h index 115242cb7..ee276489a 100644 --- a/editors/ComponentEditor/busInterfaces/general/interfacemodestack.h +++ b/editors/ComponentEditor/busInterfaces/general/interfacemodestack.h @@ -48,13 +48,13 @@ class InterfaceModeStack : public QStackedWidget /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] handler The instance that manages the library. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this stack. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] handler The instance that manages the library. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this stack. */ InterfaceModeStack(BusInterfaceInterface* busInterface, std::string const& busName, @@ -77,7 +77,7 @@ class InterfaceModeStack : public QStackedWidget /*! * Change the name of the edited bus interface. * - * @param [in] newName New name of the edited bus interface. + * @param [in] newName New name of the edited bus interface. */ void nameChanged(std::string const& newName); @@ -86,7 +86,7 @@ public slots: /*! * Select the correct editor for the given interface mode. * - * @param [in] mode The mode for the bus interface. + * @param [in] mode The mode for the bus interface. */ void setMode(General::InterfaceMode mode); @@ -100,14 +100,14 @@ public slots: /*! * Increase the number of references made to the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references made to the selected parameter. * - * @param [in] id The id of the selected parameter. + * @param [in] id The id of the selected parameter. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/busInterfaces/portmaps/BusInterfacePortMapTab.h b/editors/ComponentEditor/busInterfaces/portmaps/BusInterfacePortMapTab.h index 25b0168e0..92761a7ad 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/BusInterfacePortMapTab.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/BusInterfacePortMapTab.h @@ -58,14 +58,14 @@ class BusInterfacePortMapTab : public QWidget /*! * The constructor * - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] busName Name of the edited bus interface. - * @param [in] expressionParser The used expression parser. - * @param [in] finder The used parameter finder. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of the editor. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] busName Name of the edited bus interface. + * @param [in] expressionParser The used expression parser. + * @param [in] finder The used parameter finder. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of the editor. */ BusInterfacePortMapTab(LibraryInterface* libHandler, QSharedPointer component, @@ -89,14 +89,14 @@ class BusInterfacePortMapTab : public QWidget /*! * Set the abstraction type that defines the logical signals to use. * - * @param [in] abstractionIndex Index of the selected abstraction type. + * @param [in] abstractionIndex Index of the selected abstraction type. */ virtual void setAbsType(int const& abstractionIndex); /*! * Sets a subset of component ports to be visible in the physical port list. * - * @param [in] ports List of port names to show. + * @param [in] ports List of port names to show. */ virtual void setPhysicalPorts(QStringList const& ports); @@ -110,7 +110,7 @@ public slots: /*! * Handle the change in the name of the edited bus interface. * - * @param [in] newName New name of the edited bus interface. + * @param [in] newName New name of the edited bus interface. */ void changeBusName(std::string const& newName); @@ -128,21 +128,21 @@ public slots: /*! * Emitted when a help page should be changed in the context help window. * - * @param [in] url URL of the help page. + * @param [in] url URL of the help page. */ void helpUrlRequested(QString const& url); /*! * Emitted when the selected parameter is referenced. Increases the number of references. * - * @param [in] id The ID of the referenced parameter. + * @param [in] id The ID of the referenced parameter. */ void increaseReferences(QString id); /*! * Emitted when the selected parameter is referenced. Decreases the number of references. * - * @param [in] id The ID of the referenced parameter. + * @param [in] id The ID of the referenced parameter. */ void decreaseReferences(QString id); @@ -156,21 +156,21 @@ private slots: /*! * Handles the filtering of a connected port. * - * @param [in] portName The name of the connected port. + * @param [in] portName The name of the connected port. */ void onPortConnected(QString const& portName); /*! * Handles the filtering of a disconnected port. * - * @param [in] portName The name of the disconnected port. + * @param [in] portName The name of the disconnected port. */ void onPortDisconnected(QString const& portName); /*! * Handles the filtering by the selected direction. * - * @param [in] newDirection The selected direction. + * @param [in] newDirection The selected direction. */ void onDirectionFilterChanged(QString const& newDirection); diff --git a/editors/ComponentEditor/busInterfaces/portmaps/JaroWinklerAlgorithm.h b/editors/ComponentEditor/busInterfaces/portmaps/JaroWinklerAlgorithm.h index 6a91de513..0a1c51e02 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/JaroWinklerAlgorithm.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/JaroWinklerAlgorithm.h @@ -22,21 +22,21 @@ namespace JaroWinklerAlgorithm /*! * Calculate a Jaro distance for two strings. * - * @param [in] firstString The first string in comparison. - * @param [in] secondString The second string in comparison. + * @param [in] firstString The first string in comparison. + * @param [in] secondString The second string in comparison. * - * @return The similarity metric between the two strings on a scale of 0 to 1.0 where 1.0 is exact match. + * @return The similarity metric between the two strings on a scale of 0 to 1.0 where 1.0 is exact match. */ double calculateJaroDistance(QString const& firstString, QString const& secondString); /*! * Calculate a Jaro-Winkler distance for two strings. Favors strings with similar prefixes. * - * @param [in] firstString The first string in comparison. - * @param [in] secondString The second string in comparison. - * @param [in] winklerScalingFactor The scaling factor for prefix. Should not exceed 0.25. + * @param [in] firstString The first string in comparison. + * @param [in] secondString The second string in comparison. + * @param [in] winklerScalingFactor The scaling factor for prefix. Should not exceed 0.25. * - * @return The similarity metric between the two strings on a scale of 0 to 1.0. + * @return The similarity metric between the two strings on a scale of 0 to 1.0. */ double calculateJaroWinklerDistance(QString const& firstString, QString const& secondString, double winklerScalingFactor = 0.1); @@ -46,32 +46,32 @@ namespace JaroWinklerAlgorithm /*! * Get the matching characters from the selected strings. * - * @param [in] searched The string whose characters are searched in the reference. - * @param [in] reference The string whose characters are matched. + * @param [in] searched The string whose characters are searched in the reference. + * @param [in] reference The string whose characters are matched. * - * @return The matching characters. + * @return The matching characters. */ QString findMatchingCharacters(QString const& searched, QString const& reference); /*! * Get the number of transpositions from the matched strings. * - * @param [in] firstMatch The first string. - * @param [in] secondMatch The second string. + * @param [in] firstMatch The first string. + * @param [in] secondMatch The second string. * - * @return The number of character movements required to make the selected strings equal. + * @return The number of character movements required to make the selected strings equal. */ int getTranspositions(QString const& firstMatch, QString const& secondMatch); /*! * Calculate the Winkler distance from the Jaro distance. * - * @param [in] firstString The first string in comparison. - * @param [in] secondString The second string in comparison. - * @param [in] jaroDistance The calculated Jaro distance. - * @param [in] scalingFactor The scaling factor for the prefix. Should not exceed 0.25. + * @param [in] firstString The first string in comparison. + * @param [in] secondString The second string in comparison. + * @param [in] jaroDistance The calculated Jaro distance. + * @param [in] scalingFactor The scaling factor for the prefix. Should not exceed 0.25. * - * @return The similarity between two strings, weighted by the length of the prefix and scaling factor. + * @return The similarity between two strings, weighted by the length of the prefix and scaling factor. */ double calculateWinklerDistance(QString const& firstString, QString const& secondString, double jaroDistance, double scalingFactor); @@ -79,10 +79,10 @@ namespace JaroWinklerAlgorithm /*! * Finds the number of characters in a common prefix for two strings. * - * @param [in] firstString The first string. - * @param [in] secondString The second string. + * @param [in] firstString The first string. + * @param [in] secondString The second string. * - * @return The number of common characters in the beginning of the strings. + * @return The number of common characters in the beginning of the strings. */ int findCommonPrefixLength(QString const& firstString, QString const& secondString); }; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableModel.h b/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableModel.h index 4972014a0..e78af3e3b 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableModel.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableModel.h @@ -34,8 +34,8 @@ class PhysicalPortMappingTableModel : public PortMappingTableModel /*! * The constructor. * - * @param [in] portInterface Interface for accessing ports. - * @param [in] parent The owner of this model. + * @param [in] portInterface Interface for accessing ports. + * @param [in] parent The owner of this model. */ PhysicalPortMappingTableModel(PortsInterface* portInterface, QObject *parent); @@ -52,20 +52,20 @@ class PhysicalPortMappingTableModel : public PortMappingTableModel /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * a hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return The requested data. + * @return The requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableView.h b/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableView.h index d7792ea47..0ebe009b3 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableView.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PhysicalPortMappingTableView.h @@ -28,7 +28,7 @@ class PhysicalPortMappingTableView : public PortMappingTableView /*! * The constructor. * - * @param [in] parent The owner of this view. + * @param [in] parent The owner of this view. */ PhysicalPortMappingTableView(QWidget *parent); @@ -42,7 +42,7 @@ public slots: /*! * Handles changes in the name filter by selecting the best matching port from the list. * - * @param [in] portName Name given in filter. + * @param [in] portName Name given in filter. */ virtual void onFilterNameChanged(QString const& portName); @@ -51,21 +51,21 @@ public slots: /* * Handler for drop events on drag & drop. * - * @param [in] event Pointer to the event object. + * @param [in] event Pointer to the event object. */ virtual void dropEvent(QDropEvent* event); /*! * Handler for mouse move events. * - * @param [in] event Pointer to the event object. + * @param [in] event Pointer to the event object. */ void mouseMoveEvent(QMouseEvent* event); /*! * Handler for mouse press events. * - * @param [in] event Pointer to the event object. + * @param [in] event Pointer to the event object. */ void mousePressEvent(QMouseEvent* event); diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortListSortProxyModel.h b/editors/ComponentEditor/busInterfaces/portmaps/PortListSortProxyModel.h index d7e284c9b..be2e464df 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortListSortProxyModel.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortListSortProxyModel.h @@ -53,10 +53,10 @@ class PortListSortProxyModel : public QSortFilterProxyModel /*! * Constructor. * - * @param [in] abstractionIndex Index of the containing abstraction type. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] abstractionInterface Interface for accessing abstraction types. - * @param [in] parent The parent object. + * @param [in] abstractionIndex Index of the containing abstraction type. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] abstractionInterface Interface for accessing abstraction types. + * @param [in] parent The parent object. */ PortListSortProxyModel(int const& abstractionIndex, PortMapInterface* portMapInterface, @@ -71,28 +71,28 @@ class PortListSortProxyModel : public QSortFilterProxyModel /*! * Gets the filter for direction of the ports. * - * @return The accepted direction. + * @return The accepted direction. */ DirectionFilter filterDirection() const; /*! * Gets the filter for hiding connected ports. * - * @return True, if ports are hidden, otherwise false. + * @return True, if ports are hidden, otherwise false. */ bool filterHideConnected() const; /*! * Gets the filter for allowed port names. * - * @return The allowed port names. + * @return The allowed port names. */ QStringList filterPortNames() const; /*! * Setup a new abstraction type for sorting. * - * @param [in] newAbstractionIndex Index of the selected abstraction type. + * @param [in] newAbstractionIndex Index of the selected abstraction type. */ void setNewAbstractionType(int const& newAbstractionIndex); @@ -101,35 +101,35 @@ public slots: /*! * Sets the filter for port name(s). * - * @param [in] portName The allowed port name. + * @param [in] portName The allowed port name. */ virtual void setFilterPortName(QString const& portName); /*! * Sets the filter for port names. * - * @param [in] ports Allowed port names. + * @param [in] ports Allowed port names. */ virtual void setFilterPorts( QStringList const& ports ); /*! * Sets the filter for in-direction. * - * @param [in] enabled If true, filter using in-direction. + * @param [in] enabled If true, filter using in-direction. */ virtual void setFilterInDirection(bool enabled); /*! * Sets the filter for out-direction. * - * @param [in] filterOutDirection If true, filter using out-direction. + * @param [in] filterOutDirection If true, filter using out-direction. */ virtual void setFilterOutDirection(bool filterOutDirection); /*! * Sets to show or hide already connected ports. * - * @param [in] hide True, if ports are hidden, otherwise false. + * @param [in] hide True, if ports are hidden, otherwise false. */ virtual void setFilterHideConnected(bool hide = true); @@ -141,21 +141,21 @@ public slots: /*! * Called to update filtering when a port has been connected in a port map. * - * @param [in] portName The name of the connected port. + * @param [in] portName The name of the connected port. */ virtual void onPortConnected(QString const& portName); /*! * Called to update filtering when a port has been disconnected from all port maps. * - * @param [in] portName The name of the disconnected port. + * @param [in] portName The name of the disconnected port. */ virtual void onPortDisconnected(QString const& portName); /*! * Called to change the filtered port type. * - * @param [in] newVisibleType The new visible port type. + * @param [in] newVisibleType The new visible port type. */ virtual void onChangeFilteredType(QString const& newVisibleType); @@ -164,20 +164,20 @@ public slots: /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const override; /*! * Implementation of the column filtering. * - * @param [in] source_column The column to check for filtering. - * @param [in] source_parent Parent index of the row. + * @param [in] source_column The column to check for filtering. + * @param [in] source_parent Parent index of the row. * - * @return True, if the column passes the filters, otherwise false. + * @return True, if the column passes the filters, otherwise false. */ virtual bool filterAcceptsColumn(int source_column, const QModelIndex &source_parent) const override; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapAutoConnector.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapAutoConnector.h index b3817cd45..4acf6d648 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapAutoConnector.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapAutoConnector.h @@ -44,8 +44,8 @@ class PortMapAutoConnector : public QObject /*! * The constructor. * - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of this object. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of this object. */ PortMapAutoConnector(PortMapInterface* portMapInterface, QObject* parent); @@ -65,14 +65,14 @@ public slots: /*! * Handler for selective automatic connection. * - * @param [in] logicalSignals The selected logical signals to be connected. + * @param [in] logicalSignals The selected logical signals to be connected. */ void onAutoConnectLogicalSignals(QStringList const& logicalSignals); /*! * Sets a prefix for matching physical names to logical ports. * - * @param [in] prefix The prefix to set. + * @param [in] prefix The prefix to set. */ void setPrefix(QString const& prefix); @@ -81,7 +81,7 @@ public slots: /*! * Inform of a new port map. * - * @param [in] physicalPorts List of the best matching physical ports. + * @param [in] physicalPorts List of the best matching physical ports. */ void portMapsAutoConnected(QVector physicalPorts); @@ -104,17 +104,17 @@ public slots: /*! * Connect the selected logical signals. * - * @param [in] logicalPorts List of the selected logical signals. + * @param [in] logicalPorts List of the selected logical signals. */ void connectSelectedLogicalPorts(QStringList const& logicalPorts); /*! * Get the possible physical ports for the selected logical port. * - * @param [in] logicalPort The selected logical port. - * @param [in] logicalInterface Interface for accessing logical ports. + * @param [in] logicalPort The selected logical port. + * @param [in] logicalInterface Interface for accessing logical ports. * - * @return The possible physical ports combined with weights. + * @return The possible physical ports combined with weights. */ QMultiMap getWeightedPhysicalPorts(std::string const& logicalPort, PortAbstractionInterface* logicalInterface) const; @@ -123,11 +123,11 @@ public slots: * Get the best matching physical port. If another logical signal has the same port with a better value, it * is ignored. * - * @param [in] logicalPort The selected logical port. - * @param [in] logicalIndex Index of the logical port. - * @param [in] possiblePairings A list of the possible logical-physical pairings. + * @param [in] logicalPort The selected logical port. + * @param [in] logicalIndex Index of the logical port. + * @param [in] possiblePairings A list of the possible logical-physical pairings. * - * @return Name of the best matching physical port. + * @return Name of the best matching physical port. */ QString getBestMatchingPhysicalPort(int logicalIndex, QList const& possiblePairings) const; @@ -135,38 +135,38 @@ public slots: /*! * Get a list of possible weighted ports by the direction of the given logical direction. * - * @param [in] direction Direction of the selected logical port. + * @param [in] direction Direction of the selected logical port. * - * @return A list of weighted physical ports with a suitable direction to the logical port. + * @return A list of weighted physical ports with a suitable direction to the logical port. */ QMap getPortsByDirection(DirectionTypes::Direction logicalDirection) const; /*! * Get a list of physical ports weighted by the width of the logical port. * - * @param [in] logicalWidth The width of the selected logical port. - * @param [in] portList Names of the available weighted physical ports. + * @param [in] logicalWidth The width of the selected logical port. + * @param [in] portList Names of the available weighted physical ports. * - * @return A list of physical ports weighted by suitability to logical width. + * @return A list of physical ports weighted by suitability to logical width. */ QMap getPortsByLogicalWidth(double logicalWidth, QMap portList) const; /*! * Get a list of physical ports weighted by the name of the logical port. * - * @param [in] logicalName The name of the logical port. - * @param [in] portList A list of available weighted physical ports. + * @param [in] logicalName The name of the logical port. + * @param [in] portList A list of available weighted physical ports. * - * @return A list of physical ports weighted by the name of the logical port. + * @return A list of physical ports weighted by the name of the logical port. */ QMap weightPortsByLogicalName(QString const& logicalName, QMap portList) const; /*! * Reorder the ports according to their weights. * - * @param [in] portList A list of weighter physical ports. + * @param [in] portList A list of weighter physical ports. * - * @return A list of port names reordered according to the weights. + * @return A list of port names reordered according to the weights. */ QStringList reorderPortsToWeight(QMap portList) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapDelegate.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapDelegate.h index 9c66b92ba..c139c6c3d 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapDelegate.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapDelegate.h @@ -33,10 +33,10 @@ class PortMapDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] finder The parameter finder. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of this delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] finder The parameter finder. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of this delegate. */ PortMapDelegate(QAbstractItemModel* completionModel, QSharedPointer finder, @@ -51,25 +51,25 @@ class PortMapDelegate : public ExpressionDelegate /*! * Set a new bus interface mode. * - * @param [in] newMode The new bus interface mode. + * @param [in] newMode The new bus interface mode. */ void setBusMode(General::InterfaceMode newMode); /*! * Set a new system group. * - * @param [in] newSystemGroup The new system group. + * @param [in] newSystemGroup The new system group. */ void setSystemGroup(QString const& newSystemGroup); /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -77,35 +77,35 @@ class PortMapDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index The index of the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index The index of the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index The index of the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index The index of the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; /*! * Paint the memory maps. * - * @param [in] painter The used painter. - * @param [in] option Available style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option Available style options. + * @param [in] index The current index. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -115,26 +115,26 @@ class PortMapDelegate : public ExpressionDelegate /*! * Column for the description. * - * @return -1. Port maps do not have a description column. + * @return -1. Port maps do not have a description column. */ virtual int descriptionColumn() const; /*! * Check if the selected column accepts expressions. * - * @param [in] column The selected column. + * @param [in] column The selected column. * - * @return True, if the column accepts expressions, otherwise false. + * @return True, if the column accepts expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * The editor events. * - * @param [in] event The event itself. - * @param [in] model The used item model. - * @param [in] option The style options. - * @param [in] index The current model index. + * @param [in] event The event itself. + * @param [in] model The used item model. + * @param [in] option The style options. + * @param [in] index The current model index. */ virtual bool editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index); @@ -148,14 +148,14 @@ class PortMapDelegate : public ExpressionDelegate /*! * Set direction icons for the physical port selector. * - * @param [in] portSelector The port selector. + * @param [in] portSelector The port selector. */ void setPhysicalPortDirectionIcons(QStringList const& physicalPortNames, QComboBox* portSelector) const; /*! * Set direction icons for the logical port selector. * - * @param [in] portSelector The port selector. + * @param [in] portSelector The port selector. */ void setLogicalPortDirectionIcons(QStringList const& physicalPortNames, QComboBox* portSelector) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapHeaderView.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapHeaderView.h index 18de0fa68..bb9bd7310 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapHeaderView.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapHeaderView.h @@ -24,8 +24,8 @@ class PortMapHeaderView : public QHeaderView /*! * The constructor. * - * @param [in] orientation The headers orientation. - * @param [in] parent The parent of the header. + * @param [in] orientation The headers orientation. + * @param [in] parent The parent of the header. */ PortMapHeaderView(Qt::Orientation orientation, QWidget* parent = 0); @@ -39,9 +39,9 @@ class PortMapHeaderView : public QHeaderView /*! * The re-implemented paint section. * - * @param [in] painter The given painter. - * @param [in] rect The given rectangle. - * @param [in] logicalIndex Specifies the section. + * @param [in] painter The given painter. + * @param [in] rect The given rectangle. + * @param [in] logicalIndex Specifies the section. */ virtual void paintSection(QPainter *painter, const QRect &rect, int logicalIndex) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapModel.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapModel.h index 8e5d161d4..05e187af1 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapModel.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapModel.h @@ -29,9 +29,9 @@ class PortMapModel : public ReferencingTableModel, ParameterizableTable /*! * The constructor. * - * @param [in] parameterFinder The used parameter finder. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of this model. + * @param [in] parameterFinder The used parameter finder. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of this model. */ PortMapModel(QSharedPointer parameterFinder, PortMapInterface* portMapInterface, QObject* parent); @@ -55,84 +55,84 @@ class PortMapModel : public ReferencingTableModel, ParameterizableTable /*! * Returns the number of columns in this model. * - * @param [in] parent Model index identifying the item whose column count is requested. + * @param [in] parent Model index identifying the item whose column count is requested. * - * @return The number of columns. + * @return The number of columns. */ virtual int columnCount(const QModelIndex & parent = QModelIndex() ) const; /*! * Returns the number of rows an item has. * - * @param [in] parent Model index identifying the item whose row count is wanted. + * @param [in] parent Model index identifying the item whose row count is wanted. * - * @return The number of rows the item has. + * @return The number of rows the item has. */ virtual int rowCount(const QModelIndex &parent = QModelIndex()) const; /*! * Return header data for the given header column. * - * @param [in] section The index of the header column. - * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. - * @param [in] role The role of the data. + * @param [in] section The index of the header column. + * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. + * @param [in] role The role of the data. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data associated with given object. * - * @param [in] index Model index that identifies the object that's data is wanted. - * @param [in] role Specifies the type of data wanted. + * @param [in] index Model index that identifies the object that's data is wanted. + * @param [in] role Specifies the type of data wanted. * - * @return QVariant Containing the requested data. + * @return QVariant Containing the requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True, if data was successfully set, otherwise false. + * @return True, if data was successfully set, otherwise false. */ virtual bool setData(const QModelIndex &index, const QVariant &value, int role /* = Qt::EditRole */); /*! * Get the flags that identify possible methods for given object. * - * @param [in] index Model index identifying the object that's flags are requested. + * @param [in] index Model index identifying the object that's flags are requested. * - * @return Qt::ItemFlags that specify how the object can be handled. + * @return Qt::ItemFlags that specify how the object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ QStringList mimeTypes() const; /*! * Get the supported drop actions. * - * @return The supported drop actions. + * @return The supported drop actions. */ virtual Qt::DropActions supportedDropActions() const; /*! * Drop the mime data. * - * @param [in] data The actual data. - * @param [in] action The used drop action. - * @param [in] row The selected row. - * @param [in] column The selected column. - * @param [in] parent Parent index of the new data. + * @param [in] data The actual data. + * @param [in] action The used drop action. + * @param [in] row The selected row. + * @param [in] column The selected column. + * @param [in] parent Parent index of the new data. */ virtual bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent); @@ -142,14 +142,14 @@ public slots: /*! * Handler for adding a new port map. * - * @param [in] itemIndex The index of the new port. + * @param [in] itemIndex The index of the new port. */ void onAddPortMap(QModelIndex const& itemIndex); /*! * Handler for removing a port map. * - * @param [in] itemIndex The index of the removed port. + * @param [in] itemIndex The index of the removed port. */ void onRemovePortMap(QModelIndex const& itemIndex); @@ -161,7 +161,7 @@ public slots: /*! * Add a port map to the correct parent item. * - * @param [in] physicalPorts The weighted physical ports. + * @param [in] physicalPorts The weighted physical ports. */ void onAddAutoConnectedPortMaps(QVector physicalPorts); @@ -175,14 +175,14 @@ public slots: /*! * Emitted when a port is connected. * - * @param [in] portName The name of the connected port. + * @param [in] portName The name of the connected port. */ void portConnected(QString const& portName); /*! * Emitted when a port is disconnected. * - * @param [in] portName The name of the disconnected port. + * @param [in] portName The name of the disconnected port. */ void portDisconnected(QString const& portName); @@ -191,37 +191,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const override final; @@ -234,42 +234,42 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Get the value for the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Check if an index is valid. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the selected index is valid, otherwise false. + * @return True, if the selected index is valid, otherwise false. */ bool indexIsValid(QModelIndex const& index) const; /*! * Emit a port connection signal. * - * @param [in] oldName The old name of the port. - * @param [in] newName The new name of the port. + * @param [in] oldName The old name of the port. + * @param [in] newName The new name of the port. */ void sendPortConnectionSignal(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapSortFilter.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapSortFilter.h index 238d0dd2e..1215150d9 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapSortFilter.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapSortFilter.h @@ -28,8 +28,8 @@ class PortMapSortFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent Pointer to the owner of this model. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent Pointer to the owner of this model. */ PortMapSortFilter(PortMapInterface* portMapInterface, QObject *parent); @@ -41,10 +41,10 @@ class PortMapSortFilter : public QSortFilterProxyModel /*! * Get the data for the specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant contains the data for the item. + * @return QVariant contains the data for the item. */ virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; @@ -53,9 +53,9 @@ class PortMapSortFilter : public QSortFilterProxyModel /*! * Get the background color for the selected index. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return Background color for the selected index. + * @return Background color for the selected index. */ virtual QColor getBackgroundColorForIndex(QModelIndex const& index) const; @@ -67,10 +67,10 @@ class PortMapSortFilter : public QSortFilterProxyModel /*! * Get the background colour on the previous row of the selected index. * - * @param [in] previousRow The previous row. - * @param [in] index The selected index. + * @param [in] previousRow The previous row. + * @param [in] index The selected index. * - * @return Background colour of the previous row. + * @return Background colour of the previous row. */ QColor getPreviousColor(int const& previousRow, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMapView.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMapView.h index e1644e2f5..3bcc36beb 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMapView.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMapView.h @@ -28,8 +28,8 @@ class PortMapView : public EditableTableView /*! * The constructor. * - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The parent widget. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The parent widget. */ PortMapView(PortMapInterface* portMapInterface, QWidget* parent); @@ -43,14 +43,14 @@ class PortMapView : public EditableTableView /*! * Handler for context menu events. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event) override final; /*! * Handler for drag enter events * - * @param [in] event The event object. + * @param [in] event The event object. */ virtual void dragEnterEvent(QDragEnterEvent* event) override final; @@ -59,7 +59,7 @@ class PortMapView : public EditableTableView /*! * Automatically create port maps for the selected logical signals. * - * @param [in] logicalSignals The selected logical signals. + * @param [in] logicalSignals The selected logical signals. */ void autoConnecteLogicalSignals(QStringList const& logicalSignals); diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableModel.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableModel.h index 066a7d824..ad37ef980 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableModel.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableModel.h @@ -27,7 +27,7 @@ class PortMappingTableModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent The owner of this model + * @param [in] parent The owner of this model */ PortMappingTableModel(QObject *parent); @@ -39,39 +39,39 @@ class PortMappingTableModel : public QAbstractTableModel /*! * Get the number of columns in the model * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * a hierarchical model. * - * @return Always returns 3 + * @return Always returns 3 */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the headers * - * @param [in] section The column that's header is wanted. - * @param [in] orientation The orientation of the header data. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation The orientation of the header data. + * @param [in] role Specified the type of data that is wanted. * - * @return The header data for the given section. + * @return The header data for the given section. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return The requested data. + * @return The requested data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const = 0; /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableView.h b/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableView.h index b27a5b6e8..e2ae85ae8 100644 --- a/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableView.h +++ b/editors/ComponentEditor/busInterfaces/portmaps/PortMappingTableView.h @@ -30,7 +30,7 @@ class PortMappingTableView : public QTableView /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ PortMappingTableView(QWidget *parent); @@ -42,7 +42,7 @@ class PortMappingTableView : public QTableView /*! * Get names of the currently selected ports. * - * @return QStringList containing the names of the ports that are selected. + * @return QStringList containing the names of the ports that are selected. */ QStringList getSelectedPorts(); @@ -65,28 +65,28 @@ class PortMappingTableView : public QTableView /*! * Handler for drag enter events. * - * @param [in] event The event object. + * @param [in] event The event object. */ virtual void dragEnterEvent(QDragEnterEvent* event); /*! * Handler for drag move events on drag & drop. * - * @param [in] e The event object. + * @param [in] e The event object. */ virtual void dragMoveEvent(QDragMoveEvent* e); /*! * Handler for mouse move events. * - * @param [in] event The event object. + * @param [in] event The event object. */ virtual void mouseMoveEvent(QMouseEvent* event); /*! * Handler for mouse press events. * - * @param [in] event The event object. + * @param [in] event The event object. */ virtual void mousePressEvent(QMouseEvent* event); diff --git a/editors/ComponentEditor/channels/channelsdelegate.h b/editors/ComponentEditor/channels/channelsdelegate.h index b43876317..cea508e49 100644 --- a/editors/ComponentEditor/channels/channelsdelegate.h +++ b/editors/ComponentEditor/channels/channelsdelegate.h @@ -32,8 +32,8 @@ class ChannelsDelegate : public EnumerationEditorConstructorDelegate /*! The constructor * - * @param [in] component The component being edited. - * @param [in] parent The owner of this delegate. + * @param [in] component The component being edited. + * @param [in] parent The owner of this delegate. */ ChannelsDelegate(QSharedPointer component, QObject *parent); @@ -42,28 +42,28 @@ class ChannelsDelegate : public EnumerationEditorConstructorDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, @@ -78,34 +78,34 @@ class ChannelsDelegate : public EnumerationEditorConstructorDelegate /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ virtual bool isEnumerationEditorColumn(QModelIndex const& index) const override final; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ virtual QStringList getCurrentSelection(QModelIndex const& index) const override final; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ virtual QStringList getAvailableItems() const override final; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ virtual void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const override final; diff --git a/editors/ComponentEditor/channels/channelseditor.h b/editors/ComponentEditor/channels/channelseditor.h index 64af65184..8e2b26f65 100644 --- a/editors/ComponentEditor/channels/channelseditor.h +++ b/editors/ComponentEditor/channels/channelseditor.h @@ -36,10 +36,10 @@ class ChannelsEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator for channel elements. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator for channel elements. + * @param [in] parent The parent of this editor. */ ChannelsEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer validator, QWidget* parent = nullptr); diff --git a/editors/ComponentEditor/channels/channelsmodel.h b/editors/ComponentEditor/channels/channelsmodel.h index 49568db6e..93c4ddf2d 100644 --- a/editors/ComponentEditor/channels/channelsmodel.h +++ b/editors/ComponentEditor/channels/channelsmodel.h @@ -29,9 +29,9 @@ class ChannelsModel : public QAbstractTableModel /*! The constructor * - * @param [in] channels The channels being edited. - * @param [in] validator The validator for channel elements. - * @param [in] parent The owner of this model. + * @param [in] channels The channels being edited. + * @param [in] validator The validator for channel elements. + * @param [in] parent The owner of this model. */ ChannelsModel(QSharedPointer > > channels, QSharedPointer validator, QObject *parent); @@ -45,54 +45,54 @@ class ChannelsModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -101,14 +101,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ virtual void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. * */ virtual void onRemoveItem(QModelIndex const& index); @@ -120,14 +120,14 @@ public slots: /*! Emitted when a new channel is added to the model. * - * @param [in] index The index of the added channel. + * @param [in] index The index of the added channel. * */ void channelAdded(int index); /*! Emitted when a channel is removed from the model. * - * @param [in] index The index of the channel to remove. + * @param [in] index The index of the channel to remove. * */ void channelRemoved(int index); diff --git a/editors/ComponentEditor/choices/ChoicesEditor.h b/editors/ComponentEditor/choices/ChoicesEditor.h index 85c428422..829bb8b0f 100644 --- a/editors/ComponentEditor/choices/ChoicesEditor.h +++ b/editors/ComponentEditor/choices/ChoicesEditor.h @@ -37,11 +37,11 @@ class ChoicesEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component whose choices to edit. - * @param [in] validator The validator used for choices. - * @param [in] parent The parent widget. + * @param [in] component The component whose choices to edit. + * @param [in] validator The validator used for choices. + * @param [in] parent The parent widget. * - * @return . + * @return . */ ChoicesEditor(QSharedPointer component, QSharedPointer validator, QWidget* parent = 0); @@ -53,7 +53,7 @@ class ChoicesEditor : public ItemEditor /*! Check for the validity of the choices. * - * @return True, if all the choices are valid, otherwise false. + * @return True, if all the choices are valid, otherwise false. */ virtual bool isValid() const; @@ -67,7 +67,7 @@ public slots: /*! * Called when the choise list is emptied or is no longer empty. * - * @param [in] isEmpty Indicates if the list was emptied or no longer empty. + * @param [in] isEmpty Indicates if the list was emptied or no longer empty. */ void onChoiceListEmpty(bool isEmpty); @@ -83,7 +83,7 @@ private slots: /*! * Called when a choice has been selected. * - * @param [in] newIndex Index of the selected choice. + * @param [in] newIndex Index of the selected choice. */ void selectionChoiceChanged(QModelIndex const& newIndex); diff --git a/editors/ComponentEditor/choices/ChoicesModel.h b/editors/ComponentEditor/choices/ChoicesModel.h index 07f501a2e..8c493d5c6 100644 --- a/editors/ComponentEditor/choices/ChoicesModel.h +++ b/editors/ComponentEditor/choices/ChoicesModel.h @@ -33,9 +33,9 @@ class ChoicesModel : public QAbstractListModel /*! * Constructor. * - * @param [in] choices List of the available choices. - * @param [in] validator Validator for choices. - * @param [in] parent The parent object. + * @param [in] choices List of the available choices. + * @param [in] validator Validator for choices. + * @param [in] parent The parent object. */ ChoicesModel(QSharedPointer > > choices, QSharedPointer validator, @@ -49,66 +49,66 @@ class ChoicesModel : public QAbstractListModel /*! * Validate the choices. * - * @return True, if the choices are valid, false otherwise. + * @return True, if the choices are valid, false otherwise. */ bool validate() const; /*! * Returns the choice at the given index. * - * @param [in] index The selected index. + * @param [in] index The selected index. */ QSharedPointer getChoice(QModelIndex const& index) const; /*! * Returns the number of rows in this model. * - * @param [in] parent ModelIndex of the item that's rowCount is requested. + * @param [in] parent ModelIndex of the item that's rowCount is requested. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Returns the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the header of the list. * - * @param [in] section Specifies the column for which the header is requested. - * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. - * @param [in] role Specifies what kind of header data is requested. + * @param [in] section Specifies the column for which the header is requested. + * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. + * @param [in] role Specifies what kind of header data is requested. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Saves the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Replace an item text in the list. * - * @param [in] index ModelIndex of the item that is to be replaced. - * @param [in] newText The new text for the given item. + * @param [in] index ModelIndex of the item that is to be replaced. + * @param [in] newText The new text for the given item. */ virtual void replace(QModelIndex& index, const QString newText); @@ -117,22 +117,22 @@ public slots: /*! * Removes the specified item from the model. * - * @param [in] index The model index of the item to remove. + * @param [in] index The model index of the item to remove. */ virtual void remove(const QModelIndex& index); /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void addItem(const QModelIndex& index); /*! * Move item to another position. * - * @param [in] originalPos Identifies the item that should be moved. - * @param [in] newPos The new position the item should be moved to. + * @param [in] originalPos Identifies the item that should be moved. + * @param [in] newPos The new position the item should be moved to. */ virtual void moveItem(const QModelIndex& originalPos, const QModelIndex& newPos); @@ -146,7 +146,7 @@ public slots: /*! * Emitted when the choice list empties or is no longer empty * - * @param [in] isEmpty Indicates if list was emptied or not. + * @param [in] isEmpty Indicates if list was emptied or not. */ void choicesEmpty(bool isEmpty); diff --git a/editors/ComponentEditor/choices/EnumerationModel.h b/editors/ComponentEditor/choices/EnumerationModel.h index 60fa40731..5f64cd42a 100644 --- a/editors/ComponentEditor/choices/EnumerationModel.h +++ b/editors/ComponentEditor/choices/EnumerationModel.h @@ -31,7 +31,7 @@ class EnumerationModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ EnumerationModel(QObject* parent = 0); @@ -43,59 +43,59 @@ class EnumerationModel : public QAbstractTableModel /*! * Returns the amount of columns in the model. * - * @param [in] parent If given, the row count of the children of the given parent is returned. + * @param [in] parent If given, the row count of the children of the given parent is returned. * - * @return The amount of columns. + * @return The amount of columns. */ int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the amount of columns in the model. * - * @param [in] parent If given, the column count of the children of the given parent is returned. + * @param [in] parent If given, the column count of the children of the given parent is returned. * - * @return The amount of columns. + * @return The amount of columns. */ int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Fetches the data for appropriate role at given index. * - * @param [in] index The index of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] index The index of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The requested data. + * @return The requested data. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Retrieves the header data for given column (used) or row (not used). * - * @param [in] section The row or column from which the index is retrieved. - * @param [in] orientation Whether the header is vertical or horizontal. - * @param [in] role The role for which the header is retrieved. + * @param [in] section The row or column from which the index is retrieved. + * @param [in] orientation Whether the header is vertical or horizontal. + * @param [in] role The role for which the header is retrieved. * - * @return The header data. + * @return The header data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Sets the data at given index. * - * @param [in] index The index at which the data is set. - * @param [in] value The new value being set. - * @param [in] role The role for which the data is set. + * @param [in] index The index at which the data is set. + * @param [in] value The new value being set. + * @param [in] role The role for which the data is set. * - * @return True, if data was set successfully, otherwise false. + * @return True, if data was set successfully, otherwise false. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Returns the flags for an object at given index. * - * @param [in] index The index of the object queried. + * @param [in] index The index of the object queried. * - * @return The relevant flags. + * @return The relevant flags. */ Qt::ItemFlags flags(QModelIndex const& index) const; @@ -111,7 +111,7 @@ public slots: /*! * Setup the available enumerations. * - * @param [in] newEnumerations The new enumerations. + * @param [in] newEnumerations The new enumerations. */ void setupEnumerations(QSharedPointer > > newEnumerations); @@ -123,14 +123,14 @@ public slots: /*! * Called when a new enumeration should be added to the model. * - * @param [in] index The index to add the enumeration to. + * @param [in] index The index to add the enumeration to. */ void onAddItem(QModelIndex const& index); /*! * Called when an enumeration should be removed from the model. * - * @param [in] index The index to remove the enumeration from. + * @param [in] index The index to remove the enumeration from. */ void onRemoveItem(QModelIndex const& index); @@ -144,48 +144,48 @@ public slots: /*! * Checks if the given index is not valid and outside the model. * - * @param [in] index The model index to check. + * @param [in] index The model index to check. * - * @return True, if the index is invalid, otherwise false. + * @return True, if the index is invalid, otherwise false. */ bool isNotValidIndex(QModelIndex const& index) const; /*! * Gets the data in the enumeration column. * - * @param [in] row The row of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] row The row of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The data in enumeration column for the given row and role. + * @return The data in enumeration column for the given row and role. */ QVariant getEnumerationColumnData(int row, int role) const; /*! * Gets the foreground color for the given enumeration. * - * @param [in] enumeration The enumeration for which the foreground color is fetched. + * @param [in] enumeration The enumeration for which the foreground color is fetched. * - * @return The foreground color for the enumeration cells. + * @return The foreground color for the enumeration cells. */ QVariant getForegroundColorForEnumeration(QSharedPointer enumeration) const; /*! * Gets the data in the text column. * - * @param [in] row The row of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] row The row of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The data in text column for the given row and role. + * @return The data in text column for the given row and role. */ QVariant getTextColumnData(int row, int role) const; /*! * Gets the data in the help column. * - * @param [in] row The row of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] row The row of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The data in help column for the given row and role. + * @return The data in help column for the given row and role. */ QVariant getHelpColumnData(int row, int role) const; diff --git a/editors/ComponentEditor/common/AbstractParameterModel.h b/editors/ComponentEditor/common/AbstractParameterModel.h index 8d7fa8934..7abfa4fbc 100644 --- a/editors/ComponentEditor/common/AbstractParameterModel.h +++ b/editors/ComponentEditor/common/AbstractParameterModel.h @@ -33,10 +33,10 @@ class AbstractParameterModel : public ReferencingTableModel, public Parameteriza /*! * The constructor. * - * @param [in] parameterInterface Interface for accessing parameters. - * @param [in] expressionParser Expression parser for configurable elements. - * @param [in] parameterFinder Pointer to the instance for finding parameters. - * @param [in] parent The parent object. + * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] expressionParser Expression parser for configurable elements. + * @param [in] parameterFinder Pointer to the instance for finding parameters. + * @param [in] parent The parent object. */ AbstractParameterModel(AbstractParameterInterface* parameterInterface, QSharedPointer expressionParser, @@ -50,50 +50,50 @@ class AbstractParameterModel : public ReferencingTableModel, public Parameteriza /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted. * - * @return The data for the given index. + * @return The data for the given index. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted. - * @param [in] orientation The orientation of the header data. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation The orientation of the header data. + * @param [in] role Specified the type of data that is wanted. * - * @return The header data for the given section. + * @return The header data for the given section. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True, if data was successfully set, otherwise false. + * @return True, if data was successfully set, otherwise false. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole ); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; @@ -102,21 +102,21 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void onAddItem(QModelIndex const& index) = 0; /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ virtual void onRemoveItem(QModelIndex const& index) = 0; /*! * Handles calculation of references to the indexed parameters. * - * @param [in] indexes The selected indexes. + * @param [in] indexes The selected indexes. */ virtual void onGetParametersMachingIndexes(QModelIndexList indexes); @@ -140,8 +140,8 @@ public slots: /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); @@ -151,168 +151,168 @@ public slots: /*! * Get the interface for accessing parameters. * - * @return Interface for accessing parameters. + * @return Interface for accessing parameters. */ AbstractParameterInterface* getInterface() const; /*! * Gets the column for name. * - * @return The column for editing name selection. + * @return The column for editing name selection. */ virtual int nameColumn() const = 0; /*! * Gets the column for display name. * - * @return The column for editing display name selection. + * @return The column for editing display name selection. */ virtual int displayNameColumn() const = 0; /*! * Gets the column for value type. * - * @return The column for editing type selection. + * @return The column for editing type selection. */ virtual int typeColumn() const = 0; /*! * Gets the column for the left value of bit width vector. * - * @return The column for editing the left value of the bit width vector. + * @return The column for editing the left value of the bit width vector. */ virtual int bitWidthLeftColumn() const = 0; /*! * Gets the column for the right value of bit width vector. * - * @return The column for editing the right value of the bit width vector. + * @return The column for editing the right value of the bit width vector. */ virtual int bitWidthRightColumn() const = 0; /*! * Gets the column for minimum value. * - * @return The column for editing the minimum value. + * @return The column for editing the minimum value. */ virtual int minimumColumn() const = 0; /*! * Gets the column for maximum value. * - * @return The column for editing the maximum value. + * @return The column for editing the maximum value. */ virtual int maximumColumn() const = 0; /*! * Gets the column for choices. * - * @return The column for editing choice selection. + * @return The column for editing choice selection. */ virtual int choiceColumn() const = 0; /*! * Gets the column for values. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int valueColumn() const = 0; /*! * Gets the column for resolve. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int resolveColumn() const = 0; /*! * Gets the column for array left. * - * @return The column for editing array left side. + * @return The column for editing array left side. */ virtual int arrayLeftColumn() const = 0; /*! * Gets the column for array right. * - * @return The column for editing array right side. + * @return The column for editing array right side. */ virtual int arrayRightColumn() const = 0; /*! * Gets the column for description. * - * @return The column for editing description. + * @return The column for editing description. */ virtual int descriptionColumn() const = 0; /*! * Gets the column index for parameter id. * - * @return The column index for parameter id. + * @return The column index for parameter id. */ virtual int idColumn() const = 0; /*! * Gets the column index for usage count. * - * @return The column index for usage count. + * @return The column index for usage count. */ virtual int usageCountColumn() const = 0; /*! * Checks if the given column is mandatory. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the column is mandatory, otherwise false. + * @return True, if the column is mandatory, otherwise false. */ virtual bool isMandatoryColumn(int column) const; /*! * Validates the data in a parameter corresponding to a given column. * - * @param [in] column The column whose data to validate. - * @param [in] parameter The parameter whose data to validate. + * @param [in] column The column whose data to validate. + * @param [in] parameter The parameter whose data to validate. * - * @return True, if the data in the parameter is valid, otherwise false. + * @return True, if the data in the parameter is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Gets all the references to id from the register on the selected row. * - * @param [in] row The row of the selected register. - * @param [in] valueID The id of the target parameter. + * @param [in] row The row of the selected register. + * @param [in] valueID The id of the target parameter. * - * @return The amount of references made to the selected parameter. + * @return The amount of references made to the selected parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; /*! * Check if a parameter at row can be removed. * - * @param [in] row The row of the parameter. + * @param [in] row The row of the parameter. * - * @return True if the parameter can be removed, false otherwise. + * @return True if the parameter can be removed, false otherwise. */ bool canRemoveRow(int const& row) const; @@ -327,36 +327,36 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index whose data to get. + * @param [in] index The index whose data to get. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Gets the background color for the given index. * - * @param [in] index The index whose background color to get. + * @param [in] index The index whose background color to get. * - * @return The color for the background. + * @return The color for the background. */ QVariant backgroundColorForIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/common/ConfigurableElementFinder.h b/editors/ComponentEditor/common/ConfigurableElementFinder.h index f1a376c5f..6be9f7b7d 100644 --- a/editors/ComponentEditor/common/ConfigurableElementFinder.h +++ b/editors/ComponentEditor/common/ConfigurableElementFinder.h @@ -46,64 +46,64 @@ class ConfigurableElementFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. * - * @return The parameter with the selected ID. + * @return The parameter with the selected ID. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const final; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; /*! * Gets all of the ids of parameters in the list. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the list. * - * @return The number of parameters in the list. + * @return The number of parameters in the list. */ int getNumberOfParameters() const final; /*! * Set the configurable element list. * - * @param [in] newElementList List containing the configurable elements. + * @param [in] newElementList List containing the configurable elements. */ void setConfigurableElementList(QList > newElementList); /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; @@ -112,9 +112,9 @@ class ConfigurableElementFinder : public ParameterFinder /*! * Get the configurable element referenced the selected parameter ID. * - * @param [in] id ID of the selected parameter reference. + * @param [in] id ID of the selected parameter reference. * - * @return Configurable element containing the selected parameter reference. + * @return Configurable element containing the selected parameter reference. */ QSharedPointer getElementForID(QStringView id) const; diff --git a/editors/ComponentEditor/common/DesignConfigurationInstantiationParameterFinder.h b/editors/ComponentEditor/common/DesignConfigurationInstantiationParameterFinder.h index e6a014354..a02a52837 100644 --- a/editors/ComponentEditor/common/DesignConfigurationInstantiationParameterFinder.h +++ b/editors/ComponentEditor/common/DesignConfigurationInstantiationParameterFinder.h @@ -28,7 +28,7 @@ class DesignConfigurationInstantiationParameterFinder : public ParameterFinder /*! * Constructor. * - * @param [in] designConfigurationInstantiation The element which parameters are being searched for. + * @param [in] designConfigurationInstantiation The element which parameters are being searched for. */ explicit DesignConfigurationInstantiationParameterFinder (QSharedPointer designConfigurationInstantiation); @@ -48,48 +48,48 @@ class DesignConfigurationInstantiationParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const final; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; /*! * Gets all of the ids of design configuration instantiation parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of design configuration instantiation in the component. * - * @return The number of design configuration instantiation in the component. + * @return The number of design configuration instantiation in the component. */ int getNumberOfParameters() const final; @@ -102,7 +102,7 @@ class DesignConfigurationInstantiationParameterFinder : public ParameterFinder /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; diff --git a/editors/ComponentEditor/common/EnumerationEditorConstructorDelegate.h b/editors/ComponentEditor/common/EnumerationEditorConstructorDelegate.h index 5844b6080..3a151a2fc 100644 --- a/editors/ComponentEditor/common/EnumerationEditorConstructorDelegate.h +++ b/editors/ComponentEditor/common/EnumerationEditorConstructorDelegate.h @@ -34,14 +34,14 @@ class EnumerationEditorConstructorDelegate : public QStyledItemDelegate /*! * The constructor * - * @param [in] parent The owner of this delegate. + * @param [in] parent The owner of this delegate. */ EnumerationEditorConstructorDelegate(QObject* parent); /*! * Set the flag for hiding the check all enumerations check box. * - * @param [in] newValue The new flag. + * @param [in] newValue The new flag. */ void setHideCheckAll(bool newValue); @@ -53,37 +53,37 @@ class EnumerationEditorConstructorDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -93,9 +93,9 @@ class EnumerationEditorConstructorDelegate : public QStyledItemDelegate * Repositions the editor if there is not enough space under the default position. The editor is then resized * to use the available space. * - * @param [in] editor The editor to reposition. - * @param [in] option The style options for the editor. - * @param [in] index The current index. + * @param [in] editor The editor to reposition. + * @param [in] option The style options for the editor. + * @param [in] index The current index. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -122,41 +122,41 @@ private slots: /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ virtual bool isEnumerationEditorColumn(QModelIndex const& index) const = 0; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ virtual QStringList getCurrentSelection(QModelIndex const& index) const = 0; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ virtual QStringList getAvailableItems() const = 0; /*! * Get the list of exclusive enumerations. * - * @return List of the exclusvie enumerations. + * @return List of the exclusvie enumerations. */ virtual QStringList getExclusiveItems() const; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ virtual void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const = 0; diff --git a/editors/ComponentEditor/common/ExpressionDelegate.h b/editors/ComponentEditor/common/ExpressionDelegate.h index 99acaa706..e23a094e4 100644 --- a/editors/ComponentEditor/common/ExpressionDelegate.h +++ b/editors/ComponentEditor/common/ExpressionDelegate.h @@ -33,9 +33,9 @@ class ExpressionDelegate : public MultilineDescriptionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The parent object. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The parent object. */ ExpressionDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject* parent); @@ -76,14 +76,14 @@ class ExpressionDelegate : public MultilineDescriptionDelegate /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); @@ -92,34 +92,34 @@ class ExpressionDelegate : public MultilineDescriptionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const = 0; /*! * Gets the parameter finder used in expressions. * - * @return The parameter finder. + * @return The parameter finder. */ QSharedPointer getParameterFinder() const; /*! * Creates an editor for expressions. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return An editor for expressions. + * @return An editor for expressions. */ ExpressionEditor* createExpressionEditor(QWidget* parent) const; /*! * Creates a line editor for expressions. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return A line editor for expressions. + * @return A line editor for expressions. */ ExpressionLineEditor* createExpressionLineEditor(QWidget* parent) const; diff --git a/editors/ComponentEditor/common/ExpressionEditor.h b/editors/ComponentEditor/common/ExpressionEditor.h index fc7ae0d61..c337ebcdd 100644 --- a/editors/ComponentEditor/common/ExpressionEditor.h +++ b/editors/ComponentEditor/common/ExpressionEditor.h @@ -45,14 +45,14 @@ class ExpressionEditor : public QTextEdit, public MasterExpressionEditor /*! * Sets a completer whose selection will be appended to the text. * - * @param [in] completer The completer to set. + * @param [in] completer The completer to set. */ void setAppendingCompleter(QCompleter* completer) final; /*! * Sets the expression in the editor. * - * @param [in] expression The expression to set. + * @param [in] expression The expression to set. */ void setExpression(QString const& expression) final; @@ -61,49 +61,49 @@ class ExpressionEditor : public QTextEdit, public MasterExpressionEditor /*! * Captures the context menu event and accepts it. * - * @param [in] menuEvent The event for context menu. + * @param [in] menuEvent The event for context menu. */ void contextMenuEvent(QContextMenuEvent* menuEvent) override; /*! * Captures the mouse press event and finishes editing the current word. * - * @param [in] mouseEvent The event representing user input. + * @param [in] mouseEvent The event representing user input. */ void mousePressEvent(QMouseEvent* mouseEvent) override; /*! * Captures the user input and edits the underlying expression accordingly. * - * @param [in] keyEvent The event representing the user input. + * @param [in] keyEvent The event representing the user input. */ void keyPressEvent(QKeyEvent* keyEvent) override; /*! * Selects the text when the editor is opened. * - * @param [in] focusEvent The event representing the focus change. + * @param [in] focusEvent The event representing the focus change. */ void focusInEvent(QFocusEvent* focusEvent) override; /*! * Captures the mouse move and sets/clears notSelectingText flag according to mouse press. * - * @param [in] mouseEvent The mouse event representing the mouse movement and button press. + * @param [in] mouseEvent The mouse event representing the mouse movement and button press. */ void mouseMoveEvent(QMouseEvent* mouseEvent) override; /*! * Clears notSelectingText flag when the mouse button is released. * - * @param [in] mouseEvent The event representing the mouse button release. + * @param [in] mouseEvent The event representing the mouse button release. */ void mouseReleaseEvent(QMouseEvent* mouseEvent) override; /*! * Emits a signal informing of the ending of editing the expression. * - * @param [in] event The event representing the changing of focus. + * @param [in] event The event representing the changing of focus. */ void focusOutEvent(QFocusEvent *event) override; @@ -112,14 +112,14 @@ class ExpressionEditor : public QTextEdit, public MasterExpressionEditor /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void increaseReference(QString const& parameterId); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void decreaseReference(QString const& parameterId); @@ -133,7 +133,7 @@ private slots: /*! * Called when a word completion has been selected. Replaces the word under the cursor with the selection. * - * @param [in] word The selected word. + * @param [in] word The selected word. */ void complete(QModelIndex const& index); @@ -150,8 +150,8 @@ private slots: /*! * Inserts a given word into the text using the given cursor. * - * @param [in] word The word to insert into the text. - * @param [in] cursor The cursor to use to insert the text. + * @param [in] word The word to insert into the text. + * @param [in] cursor The cursor to use to insert the text. */ void insertWord(QString const& word, QTextCursor& cursor); @@ -168,70 +168,70 @@ private slots: /*! * Check if a selection exists. * - * @return True, if a selection exists, false otherwise. + * @return True, if a selection exists, false otherwise. */ bool hasSelection() final; /*! * Let the parent widget handle the key press event. * - * @param [in] keyEvent The selected key press event. + * @param [in] keyEvent The selected key press event. */ void handleParentKeyPressEvent(QKeyEvent* keyEvent) final; /*! * Decrease references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ void handleReferenceDecrease(QString const& referenceItem) final; /*! * Increase references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ void handleReferenceIncrease(QString const& referenceItem) final; /*! * Set the completed parameter name for the editor. * - * @param [in] parameterName The completed parameter name. + * @param [in] parameterName The completed parameter name. */ void setCompletedParameterName(QString const& parameterName) final; /*! * Get the current cursor position. * - * @return The position of the cursor. + * @return The position of the cursor. */ int getCursorPosition() const final; /*! * Get the current text of the editor. * - * @return The current text. + * @return The current text. */ QString getCurrentText() const final; /*! * Get the selected text. * - * @return The selected text. + * @return The selected text. */ QString getSelectedText() const final; /*! * Count the length of the first word in the current selection. * - * @return Length of the first word in the selection. + * @return Length of the first word in the selection. */ int getSelectionFirstWord() const final; /*! * Count the length of the last word in the current selection. * - * @return Length of the last word in the selection. + * @return Length of the last word in the selection. */ int getSelectionLastWord() const final; diff --git a/editors/ComponentEditor/common/ExpressionLineEditor.h b/editors/ComponentEditor/common/ExpressionLineEditor.h index 4a6d145c3..dc129b2bf 100644 --- a/editors/ComponentEditor/common/ExpressionLineEditor.h +++ b/editors/ComponentEditor/common/ExpressionLineEditor.h @@ -30,8 +30,8 @@ class ExpressionLineEditor : public QLineEdit, public MasterExpressionEditor /*! * The constructor. * - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The parent widget. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The parent widget. */ ExpressionLineEditor(QSharedPointer parameterFinder, QWidget* parent = 0); @@ -47,14 +47,14 @@ class ExpressionLineEditor : public QLineEdit, public MasterExpressionEditor /*! * Sets a completer whose selection will be appended to the text. * - * @param [in] completer The completer to set. + * @param [in] completer The completer to set. */ void setAppendingCompleter(QCompleter* completer) final; /*! * Sets the expression in the editor. * - * @param [in] expression The expression to set. + * @param [in] expression The expression to set. */ void setExpression(QString const& expression) final; @@ -63,49 +63,49 @@ class ExpressionLineEditor : public QLineEdit, public MasterExpressionEditor /*! * Captures the context menu event and accepts it. * - * @param [in] menuEvent The event for context menu. + * @param [in] menuEvent The event for context menu. */ void contextMenuEvent(QContextMenuEvent* menuEvent) final; /*! * Captures the mouse press event and finishes editing the current word. * - * @param [in] mouseEvent The event representing user input. + * @param [in] mouseEvent The event representing user input. */ void mousePressEvent(QMouseEvent* mouseEvent) final; /*! * Captures the user input and edits the underlying expression accordingly. * - * @param [in] keyEvent The event representing the user input. + * @param [in] keyEvent The event representing the user input. */ void keyPressEvent(QKeyEvent* keyEvent) final; /*! * Selects the text when the editor is opened. * - * @param [in] focusEvent The event representing the focus change. + * @param [in] focusEvent The event representing the focus change. */ void focusInEvent(QFocusEvent* focusEvent) final; /*! * Captures the mouse move and sets/clears notSelectingText flag according to mouse press. * - * @param [in] mouseEvent The mouse event representing the mouse movement and button press. + * @param [in] mouseEvent The mouse event representing the mouse movement and button press. */ void mouseMoveEvent(QMouseEvent* mouseEvent) final; /*! * Clears notSelectingText flag when the mouse button is released. * - * @param [in] mouseEvent The event representing the mouse button release. + * @param [in] mouseEvent The event representing the mouse button release. */ void mouseReleaseEvent(QMouseEvent* mouseEvent) final; /*! * Emits a signal informing of the ending of editing the expression. * - * @param [in] event The event representing the changing of focus. + * @param [in] event The event representing the changing of focus. */ void focusOutEvent(QFocusEvent *event) final; @@ -114,14 +114,14 @@ class ExpressionLineEditor : public QLineEdit, public MasterExpressionEditor /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void increaseReference(QString const& parameterId); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void decreaseReference(QString const& parameterId); @@ -130,7 +130,7 @@ private slots: /*! * Called when a word completion has been selected. Replaces the word under the cursor with the selection. * - * @param [in] word The selected word. + * @param [in] word The selected word. */ void complete(QModelIndex const& index); @@ -138,8 +138,8 @@ private slots: * Called when the cursor position changes. If a different word is under the new position, it is suggested * for new completion. * - * @param [in] oldPosition Old position of the cursor. - * @param [in] newPosition New position of the cursor. + * @param [in] oldPosition Old position of the cursor. + * @param [in] newPosition New position of the cursor. */ void updateCompletions(int oldPosition, int newPosition); @@ -158,70 +158,70 @@ private slots: /*! * Check if a selection exists. * - * @return True, if a selection exists, false otherwise. + * @return True, if a selection exists, false otherwise. */ bool hasSelection() final; /*! * Let the parent widget handle the key press event. * - * @param [in] keyEvent The selected key press event. + * @param [in] keyEvent The selected key press event. */ void handleParentKeyPressEvent(QKeyEvent* keyEvent) final; /*! * Decrease references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ void handleReferenceDecrease(QString const& referenceItem) final; /*! * Increase references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ void handleReferenceIncrease(QString const& referenceItem) final; /*! * Set the completed parameter name for the editor. * - * @param [in] parameterName The completed parameter name. + * @param [in] parameterName The completed parameter name. */ void setCompletedParameterName(QString const& parameterName) final; /*! * Get the current cursor position. * - * @return The position of the cursor. + * @return The position of the cursor. */ int getCursorPosition() const final; /*! * Get the current text of the editor. * - * @return The current text. + * @return The current text. */ QString getCurrentText() const final; /*! * Get the selected text. * - * @return The selected text. + * @return The selected text. */ QString getSelectedText() const final; /*! * Count the length of the first word in the current selection. * - * @return Length of the first word in the selection. + * @return Length of the first word in the selection. */ int getSelectionFirstWord() const final; /*! * Count the length of the last word in the current selection. * - * @return Length of the last word in the selection. + * @return Length of the last word in the selection. */ int getSelectionLastWord() const final; diff --git a/editors/ComponentEditor/common/FloatingModeReferenceEditor.h b/editors/ComponentEditor/common/FloatingModeReferenceEditor.h index b23996b01..c5d42fe3e 100644 --- a/editors/ComponentEditor/common/FloatingModeReferenceEditor.h +++ b/editors/ComponentEditor/common/FloatingModeReferenceEditor.h @@ -25,8 +25,8 @@ class FloatingModeReferenceEditor : public QFrame /*! * The constructor. * - * @param [in] model The mode reference interface to use. - * @param [in] parent The parent widget. + * @param [in] model The mode reference interface to use. + * @param [in] parent The parent widget. */ FloatingModeReferenceEditor(ModeReferenceInterface* modeRefInterface, QWidget* parent); diff --git a/editors/ComponentEditor/common/InstantiationConfigurableElementEditor.h b/editors/ComponentEditor/common/InstantiationConfigurableElementEditor.h index 8b355e7a9..576f32954 100644 --- a/editors/ComponentEditor/common/InstantiationConfigurableElementEditor.h +++ b/editors/ComponentEditor/common/InstantiationConfigurableElementEditor.h @@ -41,14 +41,14 @@ class InstantiationConfigurableElementEditor : public ConfigurableElementEditor /*! * The constructor. * - * @param [in] elementFinder The finder for the configurable element values. - * @param [in] parameterFinder The finder for configurable elements and top parameters. - * @param [in] elementFormatter Formats referencing expressions in configurable elements. - * @param [in] parameterFormatter Formats referencing expressions in component instance. - * @param [in] elementParser Solves expressions in configurable elements. - * @param [in] parameterParser Solves expressions in default values (component instance). - * @param [in] completionModel The completion model for selecting parameter references. - * @param [in] parent The parent widget. + * @param [in] elementFinder The finder for the configurable element values. + * @param [in] parameterFinder The finder for configurable elements and top parameters. + * @param [in] elementFormatter Formats referencing expressions in configurable elements. + * @param [in] parameterFormatter Formats referencing expressions in component instance. + * @param [in] elementParser Solves expressions in configurable elements. + * @param [in] parameterParser Solves expressions in default values (component instance). + * @param [in] completionModel The completion model for selecting parameter references. + * @param [in] parent The parent widget. */ InstantiationConfigurableElementEditor( QSharedPointer elementFinder, @@ -66,9 +66,9 @@ class InstantiationConfigurableElementEditor : public ConfigurableElementEditor /*! * Setup the configurable element values for the model. * - * @param [in] containerName Name of the item containing the parameters. - * @param [in] parameters List of the selected parameters. - * @param [in] storedElements List of the stored configurable element values. + * @param [in] containerName Name of the item containing the parameters. + * @param [in] parameters List of the selected parameters. + * @param [in] storedElements List of the stored configurable element values. */ void setParameters(QString const& containerName, QSharedPointer > > parameters, Document::Revision docRevision, diff --git a/editors/ComponentEditor/common/MasterExpressionEditor.h b/editors/ComponentEditor/common/MasterExpressionEditor.h index 893f89f5a..ad4dd2033 100644 --- a/editors/ComponentEditor/common/MasterExpressionEditor.h +++ b/editors/ComponentEditor/common/MasterExpressionEditor.h @@ -46,28 +46,28 @@ class MasterExpressionEditor /*! * Sets a completer whose selection will be appended to the text. * - * @param [in] completer The completer to set. + * @param [in] completer The completer to set. */ virtual void setAppendingCompleter(QCompleter* completer); /*! * Gets the completer for the widget. * - * @return The completer of the widget. + * @return The completer of the widget. */ QCompleter* completer() const; /*! * Gets the underlying expression in the editor. * - * @return The expression in the editor. + * @return The expression in the editor. */ QString getExpression() const; /*! * Sets the expression in the editor. * - * @param [in] expression The expression to set. + * @param [in] expression The expression to set. */ virtual void setExpression(QString const& expression); @@ -79,7 +79,7 @@ class MasterExpressionEditor /*! * Set the reserved words. * - * @param [in] newReservations A list of the new reserved words. + * @param [in] newReservations A list of the new reserved words. */ void setReservedWords(QStringList newReservations); @@ -89,103 +89,103 @@ class MasterExpressionEditor /*! * Captures the user input and edits the underlying expression accordingly. * - * @param [in] keyEvent The event representing the user input. + * @param [in] keyEvent The event representing the user input. */ void handleKeyPressEvent(QKeyEvent* keyEvent); /*! * Captures the mouse move and sets/clears notSelectingText flag according to mouse press. * - * @param [in] mouseEvent The mouse event representing the mouse movement and button press. + * @param [in] mouseEvent The mouse event representing the mouse movement and button press. */ void handleMouseMoveEvent(QMouseEvent* mouseEvent); /*! * Clears notSelectingText flag when the mouse button is released. * - * @param [in] mouseEvent The event representing the mouse button release. + * @param [in] mouseEvent The event representing the mouse button release. */ void handleMouseReleaseEvent(); /*! * Emits a signal informing of the ending of editing the expression. * - * @param [in] event The event representing the changing of focus. + * @param [in] event The event representing the changing of focus. */ void updateCompleteWords(); /*! * Called when a word completion has been selected. Replaces the word under the cursor with the selection. * - * @param [in] word The selected word. + * @param [in] word The selected word. */ void complete(QModelIndex const& index); /*! * Gives a format for a given text color. * - * @param [in] textColor The name of the color in the format. + * @param [in] textColor The name of the color in the format. * - * @return The format for the given color. + * @return The format for the given color. */ QTextCharFormat colorFormat(Qt::GlobalColor textColor) const; /*! * Replaces a word in a given index with another. * - * @param [in] n The index of the word to replace i.e 1 for second word in a sentence. - * @param [in] oldText The text to replace the word in. - * @param [in] after The word used to replace the old word. + * @param [in] n The index of the word to replace i.e 1 for second word in a sentence. + * @param [in] oldText The text to replace the word in. + * @param [in] after The word used to replace the old word. * - * @return A text where the nth word has been replaced. + * @return A text where the nth word has been replaced. */ QString replaceNthWordWith(int n, QString const& oldText, QString const& after) const; /*! * Gives the index of the word currently under the cursor. * - * @return The index of the word. + * @return The index of the word. */ int currentWordIndex() const; /*! * Checks if a given text is a reference to a parameter. * - * @param [in] text The text to check. + * @param [in] text The text to check. * - * @return True, if the text is a reference, otherwise false. + * @return True, if the text is a reference, otherwise false. */ bool isReference(QString const& text) const; /*! * Find the name for the parameter with the selected ID. * - * @param [in] parameterID The selected parameter ID. + * @param [in] parameterID The selected parameter ID. * - * @return Name of the selected parameter. + * @return Name of the selected parameter. */ QString getNameForParameterID(QString const& parameterID) const; /*! * Get the list of reserved words. * - * @return The list of reserved words. + * @return The list of reserved words. */ QStringList getReservedWords() const; /*! * Checks if a given word is a constant value. * - * @param [in] word The word to check. + * @param [in] word The word to check. * - * @return True, if the word is a constant, otherwise false. + * @return True, if the word is a constant, otherwise false. */ static bool wordIsConstant(QString const& word); /*! * Checks if a given word is a math function. * - * @param [in] word The word to check. + * @param [in] word The word to check. * * @return True, if the word is a math function, otherwise false. */ @@ -194,7 +194,7 @@ class MasterExpressionEditor /*! * Finds the index for the start of the current word. * - * @return The index for the start of the current word. + * @return The index for the start of the current word. */ int startOfCurrentWord() const; @@ -207,70 +207,70 @@ class MasterExpressionEditor /*! * Check if a selection exists. * - * @return True, if a selection exists, false otherwise. + * @return True, if a selection exists, false otherwise. */ virtual bool hasSelection() = 0; /*! * Let the parent widget handle the key press event. * - * @param [in] keyEvent The selected key press event. + * @param [in] keyEvent The selected key press event. */ virtual void handleParentKeyPressEvent(QKeyEvent* keyEvent) = 0; /*! * Decrease references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ virtual void handleReferenceDecrease(QString const& referenceItem) = 0; /*! * Increase references made to the selected ID. * - * @param [in] referenceItem ID of the selected item. + * @param [in] referenceItem ID of the selected item. */ virtual void handleReferenceIncrease(QString const& referenceItem) = 0; /*! * Set the completed parameter name for the editor. * - * @param [in] parameterName The completed parameter name. + * @param [in] parameterName The completed parameter name. */ virtual void setCompletedParameterName(QString const& parameterName) = 0; /*! * Get the current cursor position. * - * @return The position of the cursor. + * @return The position of the cursor. */ virtual int getCursorPosition() const = 0; /*! * Get the current text of the editor. * - * @return The current text. + * @return The current text. */ virtual QString getCurrentText() const = 0; /*! * Get the selected text. * - * @return The selected text. + * @return The selected text. */ virtual QString getSelectedText() const = 0; /*! * Count the length of the first word in the current selection. * - * @return Length of the first word in the selection. + * @return Length of the first word in the selection. */ virtual int getSelectionFirstWord() const = 0; /*! * Count the length of the last word in the current selection. * - * @return Length of the last word in the selection. + * @return Length of the last word in the selection. */ virtual int getSelectionLastWord() const = 0; @@ -284,16 +284,16 @@ class MasterExpressionEditor /*! * Checks if the editing would change text in the middle of a referencing term. * - * @return True, if the edit position is in the middle of a referencing term, otherwise false. + * @return True, if the edit position is in the middle of a referencing term, otherwise false. */ bool editingMiddleOfReference() const; /*! * Checks if the given key event will remove the last character in a word. * - * @param [in] keyEvent The key event to check. + * @param [in] keyEvent The key event to check. * - * @return True, if the event will remove the last character, otherwise false. + * @return True, if the event will remove the last character, otherwise false. */ bool removesLastCharacterOfWord(QKeyEvent* keyEvent) const; @@ -305,9 +305,9 @@ class MasterExpressionEditor /*! * Checks if the given key event will remove an operator before the cursor. * - * @param [in] keyEvent The key event to check. + * @param [in] keyEvent The key event to check. * - * @return True, if the event will remove an operator, otherwise false. + * @return True, if the event will remove an operator, otherwise false. */ bool removesOperatorBeforeWord(QKeyEvent* keyEvent) const; @@ -319,9 +319,9 @@ class MasterExpressionEditor /*! * Checks if the given key event will remove an operator after the cursor. * - * @param [in] keyEvent The key event to check. + * @param [in] keyEvent The key event to check. * - * @return True, if the event will remove an operator, otherwise false. + * @return True, if the event will remove an operator, otherwise false. */ bool removesOperatorAfterCursor(QKeyEvent* keyEvent) const; @@ -333,48 +333,48 @@ class MasterExpressionEditor /*! * Finds the word currently under cursor. * - * @return The word under cursor. + * @return The word under cursor. */ QString currentWord() const; /*! * Finds the index for the end of the current word. * - * @return The index for the end of the current word. + * @return The index for the end of the current word. */ int endOfCurrentWord() const; /*! * Finds the length of the current word. * - * @return The length of the current word. + * @return The length of the current word. */ int currentWordLength() const; /*! * Finds the nth word in a text. * - * @param [in] n The word index to find. - * @param [in] text The text to search in. + * @param [in] n The word index to find. + * @param [in] text The text to search in. * - * @return The nth word in a text. + * @return The nth word in a text. */ QString nthWordIn(int n, QString const& text) const; /*! * Finds the character index of the beginning of nth word in a text. * - * @param [in] n The word to search. - * @param [in] text The text to search the word in. + * @param [in] n The word to search. + * @param [in] text The text to search the word in. * - * @return The index at the beginning of the nth word. + * @return The index at the beginning of the nth word. */ int indexOfNthWord(int n, QString const& text) const; /*! * Checks if the current word is unambiguous name of a parameter. * - * @return True, if the word is unambiguous parameter name, otherwise false. + * @return True, if the word is unambiguous parameter name, otherwise false. */ bool currentWordIsUniqueParameterName() const; @@ -391,67 +391,67 @@ class MasterExpressionEditor /*! * Checks if the given text is a word delimiter. * - * @param [in] text The text to check. + * @param [in] text The text to check. * - * @return True, if the text is a word delimiter, otherwise false. + * @return True, if the text is a word delimiter, otherwise false. */ bool isWordDelimiter(QString const& text) const; /*! * Checks if the given key event will remove or replace text. * - * @param [in] keyEvent The event to check. + * @param [in] keyEvent The event to check. * - * @return True, if the event will remove or replace text, otherwise false. + * @return True, if the event will remove or replace text, otherwise false. */ bool removesOrReplacesText(QKeyEvent* keyEvent); /*! * Checks if the given event will copy, cut or paste text. * - * @param [in] keyEvent The event to check. + * @param [in] keyEvent The event to check. * - * @return True, if the event will copy, cut or paste text, otherwise false. + * @return True, if the event will copy, cut or paste text, otherwise false. */ bool keysequenceCopyCutPaste(QKeyEvent* keyEvent) const; /*! * Checks if the given event will move the cursor. * - * @param [in] keyEvent The event to check. + * @param [in] keyEvent The event to check. * - * @return True, if the event will move the cursor, otherwise false. + * @return True, if the event will move the cursor, otherwise false. */ bool keyMovesCursor(QKeyEvent* keyEvent) const; /*! * Replaces the current selection in the underlying expression with whatever was typed. * - * @param [in] keyEvent The event to check. + * @param [in] keyEvent The event to check. */ void replaceSelectionInExpression(QKeyEvent* keyEvent); /*! * Replaces the references in the underlying expression with the referenced names. * - * @param [in] firstWord The sequence number of the first word to replace. - * @param [in] lastWord The sequence number of the last word to replace. + * @param [in] firstWord The sequence number of the first word to replace. + * @param [in] lastWord The sequence number of the last word to replace. */ void replaceReferencesInExpressionWithNames(int firstWord, int lastWord); /*! * Ends the editing of current term in the underlying expression with the given word delimiter. * - * @param [in] delimiter The word delimiter ending the term edit. + * @param [in] delimiter The word delimiter ending the term edit. */ virtual void finishEditingCurrentTerm(QString const& delimiter); /*! * Checks if the given key event represents shortcut for showing all available completions. * - * @param [in] keyEvent The key event to check. + * @param [in] keyEvent The key event to check. * - * @return True, if the key event requests showing completions, otherwise false. + * @return True, if the key event requests showing completions, otherwise false. */ bool showCompletionsRequested(QKeyEvent* keyEvent) const; diff --git a/editors/ComponentEditor/common/MemoryAlignScene.h b/editors/ComponentEditor/common/MemoryAlignScene.h index 36952bd0f..a5277d60a 100644 --- a/editors/ComponentEditor/common/MemoryAlignScene.h +++ b/editors/ComponentEditor/common/MemoryAlignScene.h @@ -39,8 +39,8 @@ class MemoryAlignScene : public QGraphicsScene /*! * The constructor. * - * @param [in] expressionParser The expression parser to use for local memory maps. - * @param [in] parent The owner of the scene. + * @param [in] expressionParser The expression parser to use for local memory maps. + * @param [in] parent The owner of the scene. */ MemoryAlignScene(QSharedPointer expressionParser, QObject *parent); @@ -74,7 +74,7 @@ class MemoryAlignScene : public QGraphicsScene /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ quint64 addressSpaceLastAddress() const; @@ -90,14 +90,14 @@ class MemoryAlignScene : public QGraphicsScene /*! * Get the width of the visualized memory. * - * @return The width of the memory. + * @return The width of the memory. */ virtual QString getWidth() const = 0; /*! * Get the range of the visualized memory. * - * @return The range of the memory. + * @return The range of the memory. */ virtual QString getRange() const = 0; @@ -121,9 +121,9 @@ class MemoryAlignScene : public QGraphicsScene /*! * Update the offsets and overlapping blocks of the segments/address blocks. * - * @param [in/out] itemMap Map of segments/blocks to update. - * @param [in] exceedingItemMap Map of segments/blocks outside address space. - * @param [in] align Alignment of text on items. + * @param [in/out] itemMap Map of segments/blocks to update. + * @param [in] exceedingItemMap Map of segments/blocks outside address space. + * @param [in] align Alignment of text on items. */ void updateMaps(QMultiMap& itemMap, QMultiMap const& exceedingItemMap, @@ -132,7 +132,7 @@ class MemoryAlignScene : public QGraphicsScene /*! * Positions segments and address blocks outside address space. * - * @param [in] yStart Minimum y-coordinate for items. + * @param [in] yStart Minimum y-coordinate for items. */ virtual void rePositionExceeding(qreal const yStart); @@ -140,11 +140,11 @@ class MemoryAlignScene : public QGraphicsScene * Checks if currentItem overlaps previous top-most item. Adds conflicted blocks * if memories overlap and hides completely overlapped memory blocks. * - * @param [in] currentItem Item to check. - * @param [in/out] topItem Top-most item so far. - * @param [in/out] prevConflict Previous conflicting memory block. - * @param [in] align Alignment of text on items. - * @param [in/out] map Map to which add conflicting blocks. + * @param [in] currentItem Item to check. + * @param [in/out] topItem Top-most item so far. + * @param [in/out] prevConflict Previous conflicting memory block. + * @param [in] align Alignment of text on items. + * @param [in/out] map Map to which add conflicting blocks. */ virtual void resolveConflicts(AddressSpaceVisualizationItem* currentItem, AddressSpaceVisualizationItem*& topItem, diff --git a/editors/ComponentEditor/common/MemoryTreeFactory.h b/editors/ComponentEditor/common/MemoryTreeFactory.h index 5e4c602a3..7e74f7199 100644 --- a/editors/ComponentEditor/common/MemoryTreeFactory.h +++ b/editors/ComponentEditor/common/MemoryTreeFactory.h @@ -32,8 +32,8 @@ class MemoryTreeFactory /*! * The constructor. * - * @param [in] memoryMaps The memory maps available in the tree. - * @param [in] addressSpaces The address spaces available in the tree. + * @param [in] memoryMaps The memory maps available in the tree. + * @param [in] addressSpaces The address spaces available in the tree. */ explicit MemoryTreeFactory(QSharedPointer > > memoryMaps, QSharedPointer > > addressSpaces); @@ -50,7 +50,7 @@ class MemoryTreeFactory /*! * Creates a tree of component memory items. * - * @return The root item of the tree. + * @return The root item of the tree. */ TreeItem* create() const; @@ -59,16 +59,16 @@ class MemoryTreeFactory /*! * Creates a tree item for an address block. * - * @param [in] memoryBlock The represented address block. - * @param [in] parentItem The parent item. + * @param [in] memoryBlock The represented address block. + * @param [in] parentItem The parent item. */ void createAddressBlockItem(QSharedPointer memoryBlock, TreeItem* parentItem) const; /*! * Creates a tree item for a register file. * - * @param [in] registerFile The represented register or register file. - * @param [in] parentItem The parent item. + * @param [in] registerFile The represented register or register file. + * @param [in] parentItem The parent item. */ void createRegisterItem(QSharedPointer registerBase, TreeItem* parentItem) const; diff --git a/editors/ComponentEditor/common/ModeReferenceDelegate.h b/editors/ComponentEditor/common/ModeReferenceDelegate.h index 6e7e8d0a5..2628678e8 100644 --- a/editors/ComponentEditor/common/ModeReferenceDelegate.h +++ b/editors/ComponentEditor/common/ModeReferenceDelegate.h @@ -23,35 +23,35 @@ class ModeReferenceDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ModeReferenceDelegate(QObject* parent); /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const override; /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const override; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override; diff --git a/editors/ComponentEditor/common/ModeReferenceEditor.h b/editors/ComponentEditor/common/ModeReferenceEditor.h index 477389a4d..f868bf84e 100644 --- a/editors/ComponentEditor/common/ModeReferenceEditor.h +++ b/editors/ComponentEditor/common/ModeReferenceEditor.h @@ -27,8 +27,8 @@ class ModeReferenceEditor : public QWidget /*! * The constructor. * - * @param [in] model The mode reference model to use. - * @param [in] parent The parent widget. + * @param [in] model The mode reference model to use. + * @param [in] parent The parent widget. */ ModeReferenceEditor(ModeReferenceInterface* modeRefInterface, QWidget* parent); diff --git a/editors/ComponentEditor/common/ModeReferenceModel.h b/editors/ComponentEditor/common/ModeReferenceModel.h index 99613e74b..288148300 100644 --- a/editors/ComponentEditor/common/ModeReferenceModel.h +++ b/editors/ComponentEditor/common/ModeReferenceModel.h @@ -25,67 +25,67 @@ class ModeReferenceModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] modeRefInterface The mode reference interface to use. - * @param [in] modeRefs The mode references to edit. + * @param [in] modeRefInterface The mode reference interface to use. + * @param [in] modeRefs The mode references to edit. */ ModeReferenceModel(ModeReferenceInterface* modeRefInterface, QObject* parent); /*! * Get the number of modes the model contains. * - * @param [in] parent Identifies the parent whose row count is requested. + * @param [in] parent Identifies the parent whose row count is requested. * - * @return Number of rows the model has. + * @return Number of rows the model has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the model has to be displayed. * - * @param [in] parent Identifies the parent whose column count is requested. + * @param [in] parent Identifies the parent whose column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specifying the possible operations for the item. + * @return Qt::ItemFlags specifying the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant containing the requested data. + * @return QVariant containing the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant containing the data for the item. + * @return QVariant containing the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); @@ -94,14 +94,14 @@ public slots: /*! * Handler for adding a new mode reference row. * - * @param [in] index The model index that was selected. + * @param [in] index The model index that was selected. */ virtual void onAddRow(QModelIndex const& index); /*! * Handler for removing a mode reference row. * - * @param [in] index The mode reference to be removed. + * @param [in] index The mode reference to be removed. */ virtual void onRemoveItem(QModelIndex const& index); diff --git a/editors/ComponentEditor/common/MultilineDescriptionDelegate.h b/editors/ComponentEditor/common/MultilineDescriptionDelegate.h index 9adb4b4ab..504b01cc7 100644 --- a/editors/ComponentEditor/common/MultilineDescriptionDelegate.h +++ b/editors/ComponentEditor/common/MultilineDescriptionDelegate.h @@ -27,7 +27,7 @@ class MultilineDescriptionDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ MultilineDescriptionDelegate(QObject* parent); @@ -36,9 +36,9 @@ class MultilineDescriptionDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * * \return Pointer to the editor to be used to edit the item. */ @@ -48,17 +48,17 @@ class MultilineDescriptionDelegate : public QStyledItemDelegate /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/common/ParameterizableTable.h b/editors/ComponentEditor/common/ParameterizableTable.h index 9f7ad4ffd..496f64361 100644 --- a/editors/ComponentEditor/common/ParameterizableTable.h +++ b/editors/ComponentEditor/common/ParameterizableTable.h @@ -30,7 +30,7 @@ class ParameterizableTable /*! * The constructor. * - * @param [in] parameterFinder Parameter finder. + * @param [in] parameterFinder Parameter finder. */ ParameterizableTable(QSharedPointer parameterFinder); @@ -46,7 +46,7 @@ class ParameterizableTable /*! * Sets the expression parser. * - * @param [in] expressionParser The expression parser. + * @param [in] expressionParser The expression parser. */ void setExpressionParser(QSharedPointer expressionParser); @@ -60,80 +60,80 @@ class ParameterizableTable /*! * Gets a formatted value for a given expression. * - * @param [in] expression The expression whose value to format. + * @param [in] expression The expression whose value to format. * - * @return The formatted value for the expression. + * @return The formatted value for the expression. */ virtual QString formattedValueFor(QString const& expression) const; /*! * Gets an italic font for an evaluated value and normal font for others. * - * @param [in] value The value. + * @param [in] value The value. * - * @return Italic font for evaluated value, normal for others. + * @return Italic font for evaluated value, normal for others. */ QVariant italicForEvaluatedValue(QModelIndex const& index) const; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const = 0; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const = 0; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const = 0; /*! * Gets a black color for valid index and red color for invalid index. * - * @param [in] index The index for which to get the color. + * @param [in] index The index for which to get the color. * - * @return Black for valid index, red for invalid index. + * @return Black for valid index, red for invalid index. */ QVariant blackForValidOrRedForInvalidIndex(QModelIndex const& index) const; /*! * Checks if the value is a valid expression. * - * @param [in] value The value. + * @param [in] value The value. * - * @return True, if value is a valid expression, otherwise false. + * @return True, if value is a valid expression, otherwise false. */ bool isValidExpression(QString const& value) const; /*! * Parse expression to decimal number. * - * @param [in] expression The expression to be parsed. - * @param [in] index The model index of the expression. + * @param [in] expression The expression to be parsed. + * @param [in] index The model index of the expression. * - * @return The decimal version of the number. + * @return The decimal version of the number. */ QString parseExpressionToDecimal(QString const& expression) const; /*! * Get the parameter finder. * - * @return The parameter finder used in the table. + * @return The parameter finder used in the table. */ QSharedPointer getParameterFinder() const; diff --git a/editors/ComponentEditor/common/ReferenceSelector/ReferenceSelector.h b/editors/ComponentEditor/common/ReferenceSelector/ReferenceSelector.h index b5d6c8b9b..c66b873ce 100644 --- a/editors/ComponentEditor/common/ReferenceSelector/ReferenceSelector.h +++ b/editors/ComponentEditor/common/ReferenceSelector/ReferenceSelector.h @@ -34,7 +34,7 @@ class ReferenceSelector : public QComboBox /*! * Sets the color of the text of the current text. * - * @param [in] color The color to set. + * @param [in] color The color to set. */ void setTextColor(QColor const& color); @@ -55,7 +55,7 @@ public slots: /*! * Handles the change events and changes the text colour depengin on the enabled state of the component. * - * @param [in] currentEvent The current change event. + * @param [in] currentEvent The current change event. */ virtual void changeEvent(QEvent *currentEvent); diff --git a/editors/ComponentEditor/common/ReferencingTableModel.h b/editors/ComponentEditor/common/ReferencingTableModel.h index 7d8bb6199..6d0695455 100644 --- a/editors/ComponentEditor/common/ReferencingTableModel.h +++ b/editors/ComponentEditor/common/ReferencingTableModel.h @@ -28,8 +28,8 @@ class ReferencingTableModel : public QAbstractTableModel /*! * [Description]. * - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of this table. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of this table. */ ReferencingTableModel(QSharedPointer parameterFinder, QObject *parent); @@ -43,34 +43,34 @@ class ReferencingTableModel : public QAbstractTableModel /*! * Remove all the references to all parameters from the item on the selected row. * - * @param [in] row The row of the selected item. + * @param [in] row The row of the selected item. */ void removeReferencesInItemOnRow(const int& row) const; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const = 0; /*! * Remove all the references from a single expression. * - * @param [in] expression The expression, where to seek the references. + * @param [in] expression The expression, where to seek the references. */ void removeReferencesFromSingleExpression(QString const& expression) const; /*! * Get the unique name from the selected name. * - * @param [in] originalName The selected name. - * @param [in] currentNames A list of already used names. + * @param [in] originalName The selected name. + * @param [in] currentNames A list of already used names. * - * @return A unique name created from the selected name. + * @return A unique name created from the selected name. */ QString getUniqueName(QString const& originalName, QStringList currentNames) const; @@ -79,14 +79,14 @@ class ReferencingTableModel : public QAbstractTableModel /*! * Decrease the amount of references to the selected parameter. * - * @param [in] valueId The id of the referenced parameter. + * @param [in] valueId The id of the referenced parameter. */ void decreaseReferences(const QString& valueId) const; /*! * Increase the amount of references to the selected parameter. * - * @param [in] valueId The id of the referenced parameter. + * @param [in] valueId The id of the referenced parameter. */ void increaseReferences(QString const& parameterID); diff --git a/editors/ComponentEditor/componenteditor.h b/editors/ComponentEditor/componenteditor.h index 90b1a0676..4faeab041 100644 --- a/editors/ComponentEditor/componenteditor.h +++ b/editors/ComponentEditor/componenteditor.h @@ -84,9 +84,9 @@ class ComponentEditor : public TabDocument /*! The constructor. * - * @param [in] libHandler The instance that manages the component library. - * @param [in] component The component being edited. - * @param [in] parent Parent widget of the editor. + * @param [in] libHandler The instance that manages the component library. + * @param [in] component The component being edited. + * @param [in] parent Parent widget of the editor. * */ ComponentEditor(LibraryInterface* libHandler, @@ -104,19 +104,19 @@ class ComponentEditor : public TabDocument /*! Get the VLNV that can be used to identify the component. * - * @return The VLNV of the component. + * @return The VLNV of the component. */ VLNV getIdentifyingVLNV() const final; /*! Get the vlnv of the current component. * - * @return VLNV of the component being edited. + * @return VLNV of the component being edited. */ VLNV getDocumentVLNV() const final; /*! Check if the editor is editing a hardware implementation or not. * - * @return True if the component is a hardware component. + * @return True if the component is a hardware component. */ bool isHWImplementation() const; @@ -126,28 +126,28 @@ class ComponentEditor : public TabDocument /*! * Applies the current settings into use. * - * @param [in] settings The settings file. + * @param [in] settings The settings file. */ void applySettings(QSettings& settings) override; /*! * Gets the names of all component editor items for HW component. * - * @return The names of the items. + * @return The names of the items. */ static QStringList getHwItemNames(); /*! * Gets the names of all component editor items for SW component. * - * @return The names of the items. + * @return The names of the items. */ static QStringList getSwItemNames(); /*! * Open item editor for a component. * - * @param [in] itemIdentifierChain List of string identifying the item to be opened. + * @param [in] itemIdentifierChain List of string identifying the item to be opened. */ void openItemEditor(QVector itemIdentifierChain); @@ -159,9 +159,9 @@ public slots: /*! * Validates the document against the IP-XACT standard. * - * @param [in] errorList Error message list for reporting standard violations. + * @param [in] errorList Error message list for reporting standard violations. * - * @return True if the document is valid. False if there were any violations. + * @return True if the document is valid. False if there were any violations. */ virtual bool validate(QVector& errorList); @@ -173,7 +173,7 @@ public slots: /*! Set the protection state of the document. * - * @param [in] locked True for locked state, false for unlocked. + * @param [in] locked True for locked state, false for unlocked. * */ virtual void setProtection(bool locked); @@ -187,7 +187,7 @@ private slots: /*! This slot is called when an item is selected in the navigation tree. * - * @param [in] index The index identifying the item. + * @param [in] index The index identifying the item. * */ void onItemActivated(const QModelIndex& index); @@ -197,7 +197,7 @@ private slots: * This function tells navigation view to select the index in the tree and then * calls ComponentEditor::onItemActivated() slot. * - * @param [in] index Model index that identifies the item to select. + * @param [in] index Model index that identifies the item to select. * */ void onNavigationTreeSelection(const QModelIndex& index); @@ -206,14 +206,14 @@ private slots: * * This function tells navigation view to expand the index in the tree. * - * @param [in] index Model index that identifies the item to expand. + * @param [in] index Model index that identifies the item to expand. * */ void onExpand(const QModelIndex& index); /*! \brief Display an error dialog to user with given text. * - * @param [in] message Contains the text to display in the error dialog. + * @param [in] message Contains the text to display in the error dialog. */ void onErrorDialog(const QString& message); @@ -221,8 +221,8 @@ private slots: /*! * Opens the specific C source file of the given component. * - * @param [in] filename The name of the file to open. - * @param [in] component The component containing the file. + * @param [in] filename The name of the file to open. + * @param [in] component The component containing the file. */ void openCSource(QString const& filename, QSharedPointer component); @@ -232,23 +232,23 @@ private slots: /*! * Creates the root item for the navigation model for the given component. * - * @param [in] component The component for which to create the root item. + * @param [in] component The component for which to create the root item. * - * @return The root item for the navigation model for the component. + * @return The root item for the navigation model for the component. */ QSharedPointer createNavigationRootForComponent(); /*! * Creates child items for the navigation model for a SW component. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. */ void addSWItems(ComponentEditorRootItem* root); /*! * Creates child items for the navigation model for a HW component. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. * @param [in] expressionSupport Collection of classes for handling expressions. * */ @@ -257,47 +257,47 @@ private slots: /*! * Create the General item in the navigation tree. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. * - * @return The created item. + * @return The created item. */ QSharedPointer createGeneralItem(ComponentEditorRootItem* root); /*! * Create the Parameters item in the navigation tree. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. * - * @return The created item. + * @return The created item. */ QSharedPointer createParametersItem(ComponentEditorRootItem* root); /*! * Create the Instantiations item in the navigation tree. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. * - * @return The created item. + * @return The created item. */ QSharedPointer createInstantiationsItem(ComponentEditorRootItem* root); /*! * Create the Views item in the navigation tree. * - * @param [in] root The root item in the navigation model. + * @param [in] root The root item in the navigation model. * - * @return The created item. + * @return The created item. */ QSharedPointer createViewsItem(ComponentEditorRootItem* root); /*! * Create the Ports item in the navigation tree. * - * @param [in] root The root item in the navigation model. - * @param [in] busInterface The interface for accessing bus interface data. + * @param [in] root The root item in the navigation model. + * @param [in] busInterface The interface for accessing bus interface data. * @param [in] expressionSupport Collection of classes for handling expressions. * - * @return The created item. + * @return The created item. */ QSharedPointer createPortsItem(ComponentEditorRootItem* root, BusInterfaceInterface* busInterface, ExpressionSet const& expressionSupport); @@ -305,11 +305,11 @@ private slots: /*! * Create the Bus Interfaces item in the navigation tree. * - * @param [in] root The root item in the navigation model. - * @param [in] busInterface The interface for accessing bus interface data. - * @param [in] portMapInterface The interface for accessing port map data. + * @param [in] root The root item in the navigation model. + * @param [in] busInterface The interface for accessing bus interface data. + * @param [in] portMapInterface The interface for accessing port map data. * - * @return The created item. + * @return The created item. */ QSharedPointer createBusInterfacesItem(ComponentEditorRootItem* root, BusInterfaceInterface* busInterface, PortMapInterface* portMapInterface); @@ -317,10 +317,10 @@ private slots: /*! * Create the Indirect Interfaces item in the navigation tree. * - * @param [in] root The root item in the navigation model. - * @param [in] busInterface The interface for accessing bus interface data. + * @param [in] root The root item in the navigation model. + * @param [in] busInterface The interface for accessing bus interface data. * - * @return The created item. + * @return The created item. */ QSharedPointer createIndirectInterfacesItem( ComponentEditorRootItem* root, BusInterfaceInterface* busInterface); @@ -331,10 +331,10 @@ private slots: /*! * Update component files of a target component. * - * @param [in] targetComponent The component whose files are being updated. - * @param [in] otherComponent The other component. - * @param [in] sourcePath Source path. - * @param [in] targetPath Target path. + * @param [in] targetComponent The component whose files are being updated. + * @param [in] otherComponent The other component. + * @param [in] sourcePath Source path. + * @param [in] targetPath Target path. */ void updateComponentFiles(QSharedPointer targetComponent, QSharedPointer otherComponent, QString const& sourcePath, QString const& targetPath) const; @@ -342,18 +342,18 @@ private slots: /*! * Get a list of the file names of a component. * - * @param [in] component The component whose file names are being looked. + * @param [in] component The component whose file names are being looked. * - * @return A list of file names contained within a component. + * @return A list of file names contained within a component. */ QStringList getComponentFileNames(QSharedPointer component) const; /*! * Change the name of a single file. * - * @param [in] from The original file name. - * @param [in] to The new file name. - * @param [in] component The component containing the file. + * @param [in] from The original file name. + * @param [in] to The new file name. + * @param [in] component The component containing the file. */ void changeFileName(QString const& from, QString const& to, QSharedPointer component) const; diff --git a/editors/ComponentEditor/cpus/CpuDetailsEditor.h b/editors/ComponentEditor/cpus/CpuDetailsEditor.h index 9056a07f9..5ecbafddf 100644 --- a/editors/ComponentEditor/cpus/CpuDetailsEditor.h +++ b/editors/ComponentEditor/cpus/CpuDetailsEditor.h @@ -41,10 +41,10 @@ class CpuDetailsEditor : public QGroupBox /*! * The constructor * - * @param [in] component The containing component. - * @param [in] cpu The cpu whose properties to edit. - * @param [in] finder The parameter finder to use. - * @param [in] parent The owner of this editor. + * @param [in] component The containing component. + * @param [in] cpu The cpu whose properties to edit. + * @param [in] finder The parameter finder to use. + * @param [in] parent The owner of this editor. */ CpuDetailsEditor(QSharedPointer component, QSharedPointer cpu, @@ -79,14 +79,14 @@ class CpuDetailsEditor : public QGroupBox /*! * Increase the amount of references made to the given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void increaseReferences(QString const& id) const; /*! * Decrease the amount of references made to the given parameter. * - * @param [in] id The id the given parameter. + * @param [in] id The id the given parameter. */ void decreaseReferences(QString const& id) const; diff --git a/editors/ComponentEditor/cpus/CpuVisualizer.h b/editors/ComponentEditor/cpus/CpuVisualizer.h index 81562591d..cf7426bf5 100644 --- a/editors/ComponentEditor/cpus/CpuVisualizer.h +++ b/editors/ComponentEditor/cpus/CpuVisualizer.h @@ -33,10 +33,10 @@ class CpuVisualizer : public ItemVisualizer /*! * The constructor. * - * @param [in] cpu The CPU being visualized. - * @param [in] memoryMaps The available memory maps for the CPU to reference. - * @param [in] expressionParser The expression parser to use. - * @param [in] parent The owner of the visualizer. + * @param [in] cpu The CPU being visualized. + * @param [in] memoryMaps The available memory maps for the CPU to reference. + * @param [in] expressionParser The expression parser to use. + * @param [in] parent The owner of the visualizer. */ CpuVisualizer(QSharedPointer cpu, QSharedPointer > > memoryMaps, @@ -58,14 +58,14 @@ class CpuVisualizer : public ItemVisualizer /*! * The minimum size hint for the visualizer. * - * @return The minimum size hint. + * @return The minimum size hint. */ QSize minimumSizeHint() const override; /*! * The size hint for the visualizer. * - * @return The size hint. + * @return The size hint. */ QSize sizeHint() const override; diff --git a/editors/ComponentEditor/cpus/RegionScene.h b/editors/ComponentEditor/cpus/RegionScene.h index 02df03191..8188f4f03 100644 --- a/editors/ComponentEditor/cpus/RegionScene.h +++ b/editors/ComponentEditor/cpus/RegionScene.h @@ -36,9 +36,9 @@ class RegionScene : public MemoryAlignScene /*! * The constructor. * - * @param [in] addrSpace The address space being visualized. - * @param [in] expressionParser The expression parser to use for local memory maps. - * @param [in] parent The owner of the scene. + * @param [in] addrSpace The address space being visualized. + * @param [in] expressionParser The expression parser to use for local memory maps. + * @param [in] parent The owner of the scene. */ RegionScene(QSharedPointer cpu, QSharedPointer > > memoryMaps, @@ -60,14 +60,14 @@ class RegionScene : public MemoryAlignScene /*! * Get the width of the visualized memory. * - * @return The width of the memory. + * @return The width of the memory. */ QString getWidth() const final; /*! * Get the range of the visualized memory. * - * @return The range of the memory. + * @return The range of the memory. */ QString getRange() const final; diff --git a/editors/ComponentEditor/cpus/RegionsDelegate.h b/editors/ComponentEditor/cpus/RegionsDelegate.h index 835b2cb19..6684eeb01 100644 --- a/editors/ComponentEditor/cpus/RegionsDelegate.h +++ b/editors/ComponentEditor/cpus/RegionsDelegate.h @@ -29,9 +29,9 @@ class RegionsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] parameterNameCompleter The completer to use for parameter names in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The parent object. + * @param [in] parameterNameCompleter The completer to use for parameter names in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The parent object. */ RegionsDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject* parent); @@ -48,9 +48,9 @@ class RegionsDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const final; diff --git a/editors/ComponentEditor/cpus/RegionsEditor.h b/editors/ComponentEditor/cpus/RegionsEditor.h index abd8033fd..972568511 100644 --- a/editors/ComponentEditor/cpus/RegionsEditor.h +++ b/editors/ComponentEditor/cpus/RegionsEditor.h @@ -26,11 +26,11 @@ class RegionsEditor : public QGroupBox /*! * The constructor * - * @param [in] regions The edited regions. - * @param [in] regionValidator The validator for regions. - * @param [in] componentPath The path to component xml file. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] regions The edited regions. + * @param [in] regionValidator The validator for regions. + * @param [in] componentPath The path to component xml file. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent Pointer to the owner of this editor. */ RegionsEditor(QSharedPointer > > regions, QSharedPointer regionValidator, @@ -77,14 +77,14 @@ class RegionsEditor : public QGroupBox /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/cpus/RegionsModel.h b/editors/ComponentEditor/cpus/RegionsModel.h index 7e4183a93..d13ac02d9 100644 --- a/editors/ComponentEditor/cpus/RegionsModel.h +++ b/editors/ComponentEditor/cpus/RegionsModel.h @@ -39,10 +39,10 @@ class RegionsModel : public ReferencingTableModel, public ParameterizableTable /*! * The constructor. * - * @param [in] regions The regions being edited. - * @param [in] validator The validator to use to check regions. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The owner of this model. + * @param [in] regions The regions being edited. + * @param [in] validator The validator to use to check regions. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The owner of this model. */ RegionsModel(QSharedPointer > > regions, QSharedPointer validator, @@ -61,66 +61,66 @@ class RegionsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed (always 4). + * @return The number of columns to be displayed (always 4). */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const final; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) final; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ QStringList mimeTypes() const final; @@ -129,21 +129,21 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -157,37 +157,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ QVariant expressionOrValueForIndex(QModelIndex const& index) const final; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const final; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; @@ -220,22 +220,22 @@ public slots: * * If there are no Regions defined then 0 is returned. * - * @return The last address contained in a Region. + * @return The last address contained in a Region. */ quint64 getLastRegionedAddress() const; /*! * Get the names of the contained address blocks. * - * @return The names of the contained address blocks. + * @return The names of the contained address blocks. */ QStringList getCurrentItemNames(); /*! * Increase the number of references made in the copied address space Region. * - * @param [in] pastedRegion The copied address space Region. - * @param [in] referenceCalculator The reference calculator. + * @param [in] pastedRegion The copied address space Region. + * @param [in] referenceCalculator The reference calculator. */ void increaseReferencesInPastedRegion(QSharedPointer pastedRegion, ReferenceCalculator& referenceCalculator); diff --git a/editors/ComponentEditor/cpus/SingleCpuEditor.h b/editors/ComponentEditor/cpus/SingleCpuEditor.h index 6ebd61217..b579e76fc 100644 --- a/editors/ComponentEditor/cpus/SingleCpuEditor.h +++ b/editors/ComponentEditor/cpus/SingleCpuEditor.h @@ -36,12 +36,12 @@ class SingleCpuEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component that contains the view. - * @param [in] cpu The remap state being edited. - * @param [in] regionValidator The validator for regions in the cpu. - * @param [in] libHandler The instance that manages the library. - * @param [in] expressions Changes the referenced ids to parameter names. - * @param [in] parent The owner of this editor. + * @param [in] component The component that contains the view. + * @param [in] cpu The remap state being edited. + * @param [in] regionValidator The validator for regions in the cpu. + * @param [in] libHandler The instance that manages the library. + * @param [in] expressions Changes the referenced ids to parameter names. + * @param [in] parent The owner of this editor. */ SingleCpuEditor(QSharedPointer component, QSharedPointer cpu, @@ -69,7 +69,7 @@ class SingleCpuEditor : public ItemEditor /*! * The show event for this editor. * - * @param [in] event The show event. + * @param [in] event The show event. */ void showEvent(QShowEvent * event) final; diff --git a/editors/ComponentEditor/cpus/cpusdelegate.h b/editors/ComponentEditor/cpus/cpusdelegate.h index 8f923dd69..46a722355 100644 --- a/editors/ComponentEditor/cpus/cpusdelegate.h +++ b/editors/ComponentEditor/cpus/cpusdelegate.h @@ -33,10 +33,10 @@ class CpusDelegate : public EnumerationEditorConstructorDelegate /*! The constructor * - * @param [in] component The component being edited. - * @param [in] parameterNameCompleter The completer to use for parameter names in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The owner of the delegate. + * @param [in] component The component being edited. + * @param [in] parameterNameCompleter The completer to use for parameter names in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The owner of the delegate. */ CpusDelegate(QSharedPointer component, QCompleter* parameterNameCompleter, QSharedPointer parameterFinder, QObject *parent); @@ -51,27 +51,27 @@ class CpusDelegate : public EnumerationEditorConstructorDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const final; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const final; @@ -80,14 +80,14 @@ class CpusDelegate : public EnumerationEditorConstructorDelegate /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString const& id); @@ -101,34 +101,34 @@ class CpusDelegate : public EnumerationEditorConstructorDelegate /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ bool isEnumerationEditorColumn(QModelIndex const& index) const final; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ QStringList getCurrentSelection(QModelIndex const& index) const final; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ QStringList getAvailableItems() const final; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const final; @@ -136,9 +136,9 @@ class CpusDelegate : public EnumerationEditorConstructorDelegate /*! * Checks if given column accepts expressions as value. * - * @param [in] column The column number to check. + * @param [in] column The column number to check. * - * @return True, if column cells accept expressions, otherwise false. + * @return True, if column cells accept expressions, otherwise false. */ bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/cpus/cpuseditor.h b/editors/ComponentEditor/cpus/cpuseditor.h index d8f1d4e2a..226e3494c 100644 --- a/editors/ComponentEditor/cpus/cpuseditor.h +++ b/editors/ComponentEditor/cpus/cpuseditor.h @@ -36,11 +36,11 @@ class CpusEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator for cpus. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator for cpus. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent of this editor. */ CpusEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer validator, diff --git a/editors/ComponentEditor/cpus/cpusmodel.h b/editors/ComponentEditor/cpus/cpusmodel.h index 9bf5bbd5d..4ab0843d7 100644 --- a/editors/ComponentEditor/cpus/cpusmodel.h +++ b/editors/ComponentEditor/cpus/cpusmodel.h @@ -38,9 +38,9 @@ class CpusModel : public ReferencingTableModel, public ParameterizableTable /*! The constructor * - * @param [in] component The component being edited. - * @param [in] validator The validator for cpus. - * @param [in] parent The owner of this model. + * @param [in] component The component being edited. + * @param [in] validator The validator for cpus. + * @param [in] parent The owner of this model. */ CpusModel(QSharedPointer component, QSharedPointer validator, ExpressionSet expressions, @@ -55,54 +55,54 @@ class CpusModel : public ReferencingTableModel, public ParameterizableTable /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving was successful. + * @return True if saving was successful. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -111,37 +111,37 @@ class CpusModel : public ReferencingTableModel, public ParameterizableTable /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ QVariant expressionOrValueForIndex(QModelIndex const& index) const final; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const final; @@ -149,13 +149,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); @@ -166,13 +166,13 @@ public slots: /*! Emitted when a new cpu is added to the model. * - * @param [in] index The index of the added cpu. + * @param [in] index The index of the added cpu. */ void cpuAdded(int index); /*! Emitted when a cpu is removed from the model. * - * @param [in] index The index of the removed cpu. + * @param [in] index The index of the removed cpu. */ void cpuRemoved(int index); diff --git a/editors/ComponentEditor/fileBuilders/filebuildersdelegate.h b/editors/ComponentEditor/fileBuilders/filebuildersdelegate.h index 11b605358..7bd89cc39 100644 --- a/editors/ComponentEditor/fileBuilders/filebuildersdelegate.h +++ b/editors/ComponentEditor/fileBuilders/filebuildersdelegate.h @@ -29,9 +29,9 @@ class FileBuildersDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent Pointer to the owner of the delegate. */ FileBuildersDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -42,11 +42,11 @@ class FileBuildersDelegate : public ExpressionDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index idetifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index idetifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -54,26 +54,26 @@ class FileBuildersDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; /*! * Paints the delegate. * - * @param [in] painter The used painter. - * @param [in] option The style options. - * @param [in] index Index used for painting. + * @param [in] painter The used painter. + * @param [in] option The style options. + * @param [in] index Index used for painting. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -82,10 +82,10 @@ class FileBuildersDelegate : public ExpressionDelegate /*! * Editor event. * - * @param [in] event The editor event. - * @param [in] model The item model. - * @param [in] option Style option. - * @param [in] index Model index. + * @param [in] event The editor event. + * @param [in] model The item model. + * @param [in] option Style option. + * @param [in] index Model index. */ virtual bool editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index); @@ -93,16 +93,16 @@ class FileBuildersDelegate : public ExpressionDelegate /*! * Check if a given column accepts expressions. * - * @param [in] column The selected column. + * @param [in] column The selected column. * - * @return True, if the column accepts expressions, false otherwise. + * @return True, if the column accepts expressions, false otherwise. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the column number for the description column. * - * @return File builders do not have description. + * @return File builders do not have description. */ virtual int descriptionColumn() const; diff --git a/editors/ComponentEditor/fileBuilders/filebuilderseditor.h b/editors/ComponentEditor/fileBuilders/filebuilderseditor.h index 4cd140c50..715ebfc6a 100644 --- a/editors/ComponentEditor/fileBuilders/filebuilderseditor.h +++ b/editors/ComponentEditor/fileBuilders/filebuilderseditor.h @@ -39,12 +39,12 @@ class FileBuildersEditor : public QGroupBox /*! * The constructor. * - * @param [in] fileBuilderInterface Interface for accessing file builders. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] expressionFormatter Formatter used to format expressions. - * @param [in] availableFileBuilders List of editable file builders. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] fileBuilderInterface Interface for accessing file builders. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] expressionFormatter Formatter used to format expressions. + * @param [in] availableFileBuilders List of editable file builders. + * @param [in] parent Pointer to the owner of this editor. */ FileBuildersEditor(FileBuilderInterface* fileBuilderInterface, QSharedPointer parameterFinder, @@ -61,7 +61,7 @@ class FileBuildersEditor : public QGroupBox /*! * Check for the validity of the edited file builders. * - * @return True if all file builders are in valid state. + * @return True if all file builders are in valid state. */ virtual bool isValid() const; @@ -84,14 +84,14 @@ public slots: /*! * Increase the number of references in the selected parameter. * - * @param [in] id Id of the selected parameter. + * @param [in] id Id of the selected parameter. */ void increaseReferences(QString id) const; /*! * Decrease the number of references in the selected parameter. * - * @param [in] id Id of the selected parameter. + * @param [in] id Id of the selected parameter. */ void decreaseReferences(QString id) const; diff --git a/editors/ComponentEditor/fileBuilders/filebuildersmodel.h b/editors/ComponentEditor/fileBuilders/filebuildersmodel.h index 63f0b9fbb..2a43b5061 100644 --- a/editors/ComponentEditor/fileBuilders/filebuildersmodel.h +++ b/editors/ComponentEditor/fileBuilders/filebuildersmodel.h @@ -38,11 +38,11 @@ class FileBuildersModel : public ReferencingTableModel, public ParameterizableTa /*! * The constructor. * - * @param [in] builderInterface Interface for accessing file builders. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionFormatter Formatter used to format expressions. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] parent Pointer to the owner of this model. + * @param [in] builderInterface Interface for accessing file builders. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionFormatter Formatter used to format expressions. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] parent Pointer to the owner of this model. */ FileBuildersModel(FileBuilderInterface* builderInterface, QSharedPointer parameterFinder, @@ -58,68 +58,68 @@ class FileBuildersModel : public ReferencingTableModel, public ParameterizableTa /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * Must be invalid because this is not hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * Must be invalid because this is not hierarchical model. * - * @return Always returns 4 + * @return Always returns 4 */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted. * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted. - * @param [in] orientation Only Qt::Horizontal is supported. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation Only Qt::Horizontal is supported. + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed + * @return QVariant containing the data to be displayed */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole ); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Check if the model is in valid state or not. * - * @return True if all items in model are valid. + * @return True if all items in model are valid. */ bool isValid() const; @@ -128,14 +128,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); @@ -155,37 +155,37 @@ public slots: /*! * Check if the given column can contain expressions. * - * @param [in] index The index of the selected column. + * @param [in] index The index of the selected column. * - * @return True, if the column can contain expressions, false otherwise. + * @return True, if the column can contain expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Get the value of the item in the given index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The value matching the index. + * @return The value matching the index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validate the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the index is valid, otherwise false. + * @return True, if the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Get all the references to a selected parameter in the selected row. * - * @param [in] row The selected row. - * @param [in] valueID The Id of the selected parameter. + * @param [in] row The selected row. + * @param [in] valueID The Id of the selected parameter. * - * @return The number of references made to teh selected Id. + * @return The number of references made to teh selected Id. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -198,27 +198,27 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyDelegate.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyDelegate.h index bbad8efc5..47134e096 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyDelegate.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyDelegate.h @@ -49,34 +49,34 @@ class FileDependencyDelegate : public EnumerationEditorConstructorDelegate /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ virtual bool isEnumerationEditorColumn(QModelIndex const& index) const override final; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ virtual QStringList getCurrentSelection(QModelIndex const& index) const override final; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ virtual QStringList getAvailableItems() const override final; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ virtual void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const override final; diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyEditor.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyEditor.h index cf9198709..f4de46793 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyEditor.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyEditor.h @@ -42,9 +42,9 @@ class FileDependencyEditor : public QWidget /*! * Constructor. * - * @param [in] component The component being edited. - * @param [in] basePath The component's base path. - * @param [in] parent The parent widget. + * @param [in] component The component being edited. + * @param [in] basePath The component's base path. + * @param [in] parent The parent widget. */ FileDependencyEditor(QSharedPointer component, QString const& basePath, QWidget* parent); @@ -57,7 +57,7 @@ class FileDependencyEditor : public QWidget /*! * Sets the editor in compact mode. * - * @param [in] compact If true, the editor is set compact with only the table-graph in view. + * @param [in] compact If true, the editor is set compact with only the table-graph in view. * If false, the full editor is shown. */ void setCompact(bool compact); @@ -116,14 +116,14 @@ private slots: /*! * Updates the progress bar with the given value. * - * @param [in] value The value to set to the progress bar. + * @param [in] value The value to set to the progress bar. */ void updateProgressBar(int value); /*! * Sends filters to the dependency graph. * - * @param [in] the filter being toggled. + * @param [in] the filter being toggled. */ void filterToggle(QAction* action); @@ -148,14 +148,14 @@ private slots: /*! * Scans recursively files in the given path and adds them to the component file sets. * - * @param [in] path The path to scan. + * @param [in] path The path to scan. */ void scanFiles(QString const& path); /*! * Returns true if the given file is IP-XACT. * - * @param [in] filename The name of the file to check. + * @param [in] filename The name of the file to check. */ bool isFileIPXact(QString const& filename) const; @@ -165,9 +165,9 @@ private slots: /* * Adds a filter button to the toolbar. * - * @param [in] icon The icon for the button. - * @param [in] iconText The text displayed for the icon. - * @param [in] filter The filter value for the button. + * @param [in] icon The icon for the button. + * @param [in] iconText The text displayed for the icon. + * @param [in] filter The filter value for the button. */ void addFilterButton(QIcon const& icon, QString const& iconText, FileDependencyGraphView::DependencyFilter filter); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphView.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphView.h index b5a958767..96cab7512 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphView.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphView.h @@ -56,7 +56,7 @@ class FileDependencyGraphView : public QTreeView /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ FileDependencyGraphView(QWidget* parent); @@ -68,7 +68,7 @@ class FileDependencyGraphView : public QTreeView /*! * Sets the item model. * - * @param [in] model The model to set. + * @param [in] model The model to set. */ virtual void setModel(QAbstractItemModel* model); @@ -85,7 +85,7 @@ class FileDependencyGraphView : public QTreeView /*! * Sets the dependencies editable/read-only. * - * @param [in] editable If true, the dependencies are editable. If false, they are read-only. + * @param [in] editable If true, the dependencies are editable. If false, they are read-only. */ void setDependenciesEditable(bool editable); @@ -119,7 +119,7 @@ public slots: /*! * Sets the graph column scroll index. * - * @param [in] index The index to set. + * @param [in] index The index to set. */ void setGraphColumnScrollIndex(int index); @@ -157,16 +157,16 @@ public slots: /*! * Handles resize of the graph view. * - * @param [in] event The resize event. + * @param [in] event The resize event. */ virtual void resizeEvent(QResizeEvent *event); /*! * Handles auto-expand when rows are inserted. * - * @param [in] parent The parent model index. - * @param [in] start The start index of the inserted rows. - * @param [in] end The end index of the inserted rows. + * @param [in] parent The parent model index. + * @param [in] start The start index of the inserted rows. + * @param [in] end The end index of the inserted rows. */ virtual void rowsInserted(QModelIndex const& parent, int start, int end); @@ -283,63 +283,63 @@ private slots: /*! * Draws the dependency graph into the dependencies column. * - * @param [in] painter The drawing context. - * @param [in] rect The currently visible drawing area. + * @param [in] painter The drawing context. + * @param [in] rect The currently visible drawing area. */ void drawDependencyGraph(QPainter& painter, QRect const& rect); /*! * Retrieves the final drawing coordinates and the items for the given dependency. * - * @param [in] dep The dependency. - * @param [out] fromY The resulted from y coordinate. - * @param [out] toY The resulted to y coordinate. + * @param [in] dep The dependency. + * @param [out] fromY The resulted from y coordinate. + * @param [out] toY The resulted to y coordinate. */ bool getCoordinates(GraphDependency const& dep, int& fromY, int& toY) const; /*! * Draws the temporary manual dependency arrow when the user is creating a manual connection. * - * @param [in] painter The drawing context. + * @param [in] painter The drawing context. */ void drawManualCreationArrow(QPainter& painter); /*! * Draws a dependency arrow. * - * @param [in] painter The painter context. - * @param [in] x The x coordinate for the arrow. - * @param [in] fromY The "from" y coordinate. - * @param [in] toY The "to" y coordinate. - * @param [in] color The arrow color. - * @param [in] bidirectional If true, arrow heads will be drawn to both ends. + * @param [in] painter The painter context. + * @param [in] x The x coordinate for the arrow. + * @param [in] fromY The "from" y coordinate. + * @param [in] toY The "to" y coordinate. + * @param [in] color The arrow color. + * @param [in] bidirectional If true, arrow heads will be drawn to both ends. */ void drawArrow(QPainter& painter, int x, int fromY, int toY, QColor const& color, bool bidirectional = false); /*! * Draws an arrow head pointing down. * - * @param [in] painter The painter to use for drawing. - * @param [in] x The x coordinate of the arrow head. - * @param [in] y The y coordinate of the arrow head. + * @param [in] painter The painter to use for drawing. + * @param [in] x The x coordinate of the arrow head. + * @param [in] y The y coordinate of the arrow head. */ void drawArrowHeadDown(QPainter& painter, int x, int y); /*! * Draws an arrow head pointing up. * - * @param [in] painter The painter to use for drawing. - * @param [in] x The x coordinate of the arrow head. - * @param [in] y The y coordinate of the arrow head. + * @param [in] painter The painter to use for drawing. + * @param [in] x The x coordinate of the arrow head. + * @param [in] y The y coordinate of the arrow head. */ void drawArrowHeadUp(QPainter& painter, int x, int y); /*! * Retrieves the center y coordinate for the row specified by the given model index. * - * @param [in] index The model index of the row. - * @param [in] y The retrieved y coordinate. + * @param [in] index The model index of the row. + * @param [in] y The retrieved y coordinate. * - * @return True, if the row is visible. False if hidden. + * @return True, if the row is visible. False if hidden. */ bool getVisualRowY(QModelIndex const& index, int& y) const; @@ -351,41 +351,41 @@ private slots: /*! * Searches for a dependency at the given mouse coordinate. * - * @param [in] pt The mouse coordinate point to test for. + * @param [in] pt The mouse coordinate point to test for. * - * @return If found, the dependency at the given coordinate. Otherwise null. + * @return If found, the dependency at the given coordinate. Otherwise null. */ FileDependency* findDependencyAt(QPoint const& point) const; /*! * Checks the dependency against the filters. * - * @param [in] dependency The dependency to check. + * @param [in] dependency The dependency to check. * - * @return False, if the dependency should not be shown. Otherwise true. + * @return False, if the dependency should not be shown. Otherwise true. */ bool filterDependency(FileDependency const* dependency) const; /*! * Repaints the given dependency. * - * @param [in] dependency The dependency to repaint. + * @param [in] dependency The dependency to repaint. */ void repaintDependency(FileDependency const* dependency); /*! * Repaints a region containing a dependency arrow. * - * @param [in] x The x coordinate of the arrow. - * @param [in] fromY The starting y coordinate of the arrow. - * @param [in] toY The ending y coordinate of the arrow. + * @param [in] x The x coordinate of the arrow. + * @param [in] fromY The starting y coordinate of the arrow. + * @param [in] toY The ending y coordinate of the arrow. */ void repaintArrowRegion(int x, int fromY, int toY); /*! * Creates a context menu for the currently selected dependency. * - * @param [in] position The global position for the context menu. + * @param [in] position The global position for the context menu. */ void createContextMenu(const QPoint& position); @@ -393,7 +393,7 @@ private slots: /*! * Changes the selected dependency and repaints the previous and current selection. * - * @param [in] newSelection The dependency to select. + * @param [in] newSelection The dependency to select. */ void changeDependencySelection(FileDependency* newSelection); @@ -415,7 +415,7 @@ private slots: /*! * Creates a new dependency using the start and end item. * - * @return The created dependency. + * @return The created dependency. */ FileDependency* createManualDependency(); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphWidget.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphWidget.h index 3c43b5c85..b737a5712 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphWidget.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyGraphWidget.h @@ -57,7 +57,7 @@ private slots: /*! * Shows a warning message on the information display. * - * @param [in] message The message to show. + * @param [in] message The message to show. */ void showWarningMessage(QString const& message); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyInfoWidget.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyInfoWidget.h index 2f2b87e93..5cf788d23 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyInfoWidget.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyInfoWidget.h @@ -32,7 +32,7 @@ class FileDependencyInfoWidget : public QGroupBox /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ FileDependencyInfoWidget(QWidget* parent ); @@ -57,7 +57,7 @@ public slots: /*! * Sets the given file dependency editable in the widget. * - * @param [in] dependency The dependency to set for editing. + * @param [in] dependency The dependency to set for editing. * * @remarks If the dependency is null, all contents of the widgets are cleared and * the widgets are set to disabled mode. @@ -69,14 +69,14 @@ private slots: /*! * Handles a change in the direction.. * - * @param [in] state The new state for the direction. + * @param [in] state The new state for the direction. */ void directionChanged(int state); /*! * Handles the change in the locked check. * - * @param [in] state The new state. + * @param [in] state The new state. */ void lockedCheckChanged(int state); @@ -105,7 +105,7 @@ private slots: /*! * Locks / unlocks everything. * - * @param [in] isLocked The lock status. + * @param [in] isLocked The lock status. */ void lockEverything(bool isLocked); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyItem.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyItem.h index dc91f51fd..02dc5ff7e 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyItem.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyItem.h @@ -68,10 +68,10 @@ class FileDependencyItem : public QObject /*! * Adds a file item. * - * @param [in] type The item type. - * @param [in] component The component being edited. - * @param [in] path The file path. - * @param [in] fileRefs The file references. + * @param [in] type The item type. + * @param [in] component The component being edited. + * @param [in] path The file path. + * @param [in] fileRefs The file references. */ FileDependencyItem* addFile(QSharedPointer component, QString const& path, QList > const& fileRefs); @@ -79,31 +79,31 @@ class FileDependencyItem : public QObject /*! * Adds a folder item. * - * @param [in] component The component being edited. - * @param [in] path The folder path. Enclose external locations with with '$' e.g. $path$. + * @param [in] component The component being edited. + * @param [in] path The folder path. Enclose external locations with with '$' e.g. $path$. * - * @return The created item. + * @return The created item. */ FileDependencyItem* addFolder(QSharedPointer component, QString const& path); /*! * Inserts an item. * - * @param [in] item The item to insert. + * @param [in] item The item to insert. */ void insertItem(FileDependencyItem* item); /*! * Removes an item. * - * @param [in] item The item to remove. + * @param [in] item The item to remove. */ void removeItem(FileDependencyItem* item); /*! * Sets the status of the item. * - * @param [in] status The new status to set. + * @param [in] status The new status to set. */ void setStatus(FileDependencyStatus status); @@ -117,14 +117,14 @@ class FileDependencyItem : public QObject /*! * Sets the latest hash to the metadata. * - * @param [in] hash The hash to set. + * @param [in] hash The hash to set. */ void setLastHash(QString const& hash); /*! * Assigns the file into the given file sets. * - * @param [in] fileSets The file sets where the file is assigned. + * @param [in] fileSets The file sets where the file is assigned. */ void setFileSets(QList > fileSets); @@ -136,14 +136,14 @@ class FileDependencyItem : public QObject /*! * Returns the child at the given index. * - * @param [in] index The index of the child to retrieve. + * @param [in] index The index of the child to retrieve. */ FileDependencyItem* getChild(int index); /*! * Returns the child at the given index. * - * @param [in] index The index of the child to retrieve. + * @param [in] index The index of the child to retrieve. */ FileDependencyItem const* getChild(int index) const; @@ -175,7 +175,7 @@ class FileDependencyItem : public QObject /*! * Gets the names of all the contained file sets. * - * @return The names of the contained file sets. + * @return The names of the contained file sets. */ QStringList getFileSetNames() const; @@ -217,10 +217,10 @@ class FileDependencyItem : public QObject /*! * Constructor which creates a file item. * - * @param [in] component The component being edited. - * @param [in] path The path of the file. - * @param [in] fileRefs The file references. - * @param [in] parent The parent item. + * @param [in] component The component being edited. + * @param [in] path The path of the file. + * @param [in] fileRefs The file references. + * @param [in] parent The parent item. */ FileDependencyItem( QSharedPointer component, QString const& path, QList > const& fileRefs, FileDependencyItem* parent); @@ -228,9 +228,9 @@ class FileDependencyItem : public QObject /*! * Constructor which creates a folder item. * - * @param [in] component The component being edited. - * @param [in] path The path of the file/folder. - * @param [in] parent The parent item. + * @param [in] component The component being edited. + * @param [in] path The path of the file/folder. + * @param [in] parent The parent item. */ FileDependencyItem(QSharedPointer component, QString const& path, FileDependencyItem* parent); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyModel.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyModel.h index 2f206d35d..47bc9684f 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyModel.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencyModel.h @@ -33,8 +33,8 @@ class FileDependencyModel : public QAbstractItemModel /*! * Constructor. * - * @param [in] component The component to which this model is made. - * @param [in] basePath The component's base path. + * @param [in] component The component to which this model is made. + * @param [in] basePath The component's base path. */ FileDependencyModel(QSharedPointer component, QString const& basePath); @@ -52,71 +52,71 @@ class FileDependencyModel : public QAbstractItemModel /*! * Adds a new dependency to the model. * - * @param [in] dependency The file dependency to add. + * @param [in] dependency The file dependency to add. */ void addDependency(QSharedPointer dependency); /*! * Removes a dependency from the model. * - * @param [in] dependency The file dependency to remove. + * @param [in] dependency The file dependency to remove. */ void removeDependency(FileDependency* dependency); /*! * Defines the location for the given item. * - * @param [in] item The item whose location to define. - * @param [in] path The path where the file resides. + * @param [in] item The item whose location to define. + * @param [in] path The path where the file resides. */ void defineLocation(FileDependencyItem* item, QString const& path); /*! * Resets the location of the given item. * - * @param [in] item The item whose location to reset. + * @param [in] item The item whose location to reset. */ void resetLocation(FileDependencyItem* item); /*! * Searches for a file item with the given path. * - * @param [in] path The path. + * @param [in] path The path. * - * @return The corresponding item of null if not found in the model. + * @return The corresponding item of null if not found in the model. */ FileDependencyItem* findFileItem(QString const& path); /*! * Searches for an external file item with the given path. * - * @param [in,out] path The base path as an input. The found path if the item was found. + * @param [in,out] path The base path as an input. The found path if the item was found. * - * @return The corresponding item of null if not found in the model. + * @return The corresponding item of null if not found in the model. */ FileDependencyItem* findExternalFileItem(QString& path); /*! * Searches for a folder item with the given path. * - * @param [in] path The path. + * @param [in] path The path. * - * @return The corresponding item of null if not found in the model. + * @return The corresponding item of null if not found in the model. */ FileDependencyItem* findFolderItem(QString const& path); /*! * Searches for a dependency between the given files. * - * @param [in] file1 The first file. - * @param [in] file2 The second file. + * @param [in] file1 The first file. + * @param [in] file2 The second file. */ FileDependency* findDependency(QString const& file1, QString const& file2) const; /*! * Returns the model index of the given file dependency item. * - * @param [in] item The file dependency item. + * @param [in] item The file dependency item. */ QModelIndex getItemIndex(FileDependencyItem* item, int column) const; @@ -143,18 +143,18 @@ class FileDependencyModel : public QAbstractItemModel /*! * Adds a new folder item to the model. * - * @param [in] path The folder path. + * @param [in] path The folder path. */ FileDependencyItem* addFolder(QString const& path); /*! * Return header data for the given header column. * - * @param [in] section The index of the header column. - * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. - * @param [in] role The role of the data. + * @param [in] section The index of the header column. + * @param [in] orientation The orientation of the header, only Qt::Horizontal supported. + * @param [in] role The role of the data. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; @@ -162,18 +162,18 @@ class FileDependencyModel : public QAbstractItemModel /*! * Returns the number of columns in this model. * - * @param [in] parent Model index identifying the item whose column count is requested. + * @param [in] parent Model index identifying the item whose column count is requested. * - * @return The number of columns. + * @return The number of columns. */ virtual int columnCount(const QModelIndex & parent = QModelIndex() ) const; /*! * Returns the number of rows an item has. * - * @param [in] parent Model index identifying the item whose row count is wanted. + * @param [in] parent Model index identifying the item whose row count is wanted. * - * @return The number of rows the item has. + * @return The number of rows the item has. */ virtual int rowCount(const QModelIndex &parent = QModelIndex()) const; @@ -290,25 +290,25 @@ private slots: /*! * Analyzes the given file item. * - * @param [in] fileItem The file item to analyze. + * @param [in] fileItem The file item to analyze. */ void analyze(FileDependencyItem* fileItem); /*! * Calculates an Md5 sum for a given file. Changes in Md5 indicate change in file content. * - * @param [in] absPath Absolute path to the file to calculate Md5 for. + * @param [in] absPath Absolute path to the file to calculate Md5 for. * - * @return The calculated Md5 sum. + * @return The calculated Md5 sum. */ QString calculateMd5forFile(QString const& absPath) const; /*! * Searches for a dependency between the given files in the given container. * - * @param [in] dependencies The list of dependencies. - * @param [in] file1 File path of the first file. - * @param [in] file2 File path of the second file. + * @param [in] dependencies The list of dependencies. + * @param [in] file1 File path of the first file. + * @param [in] file2 File path of the second file. */ FileDependency* findDependency(QList const& dependencies, QString const& file1, QString const& file2) const; @@ -316,16 +316,16 @@ private slots: /*! * Searches for all dependencies that reference the given file. * - * @param [in] file File path of the file. - * @param [out] dependencies The found dependencies. + * @param [in] file File path of the file. + * @param [out] dependencies The found dependencies. */ QList findDependencies(QString const& file) const; /*! * Moves the item to the new parent. * - * @param [in] item The item to move. - * @param [in] parent The new parent for the item. + * @param [in] item The item to move. + * @param [in] parent The new parent for the item. */ void moveItem(FileDependencyItem* item, FileDependencyItem* parent); diff --git a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencySourceEditor.h b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencySourceEditor.h index a5e62bc5e..e87df45bb 100644 --- a/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencySourceEditor.h +++ b/editors/ComponentEditor/fileSet/dependencyAnalysis/FileDependencySourceEditor.h @@ -34,10 +34,10 @@ class FileDependencySourceEditor : public DirListManager /*! * Constructor. * - * @param [in] xmlPath The directory path where the parent component is located. + * @param [in] xmlPath The directory path where the parent component is located. * Source directories are saved relative to this path. - * @param [in] sourceDirs The current list of source directories. - * @param [in] parent The parent widget. + * @param [in] sourceDirs The current list of source directories. + * @param [in] parent The parent widget. */ FileDependencySourceEditor(QString const& basePath, QStringList const& sourceDirs, QWidget* parent = 0); @@ -49,14 +49,14 @@ class FileDependencySourceEditor : public DirListManager /*! * Retrieves the new list of source directories. * - * @return The list of source directories. + * @return The list of source directories. */ QStringList getSourceDirectories() const; /*! * Initializes the editor. * - * @param [in] items QStringList that contains the items to add to the widget. + * @param [in] items QStringList that contains the items to add to the widget. * * @remark FileDependencySourceEditor calls initialize() in constructor. */ @@ -82,7 +82,7 @@ private slots: /*! * Returns the currently selected directories in absolute paths. * - * @return The absolute paths for the directories. + * @return The absolute paths for the directories. */ QStringList getAbsoluteDirectories(); diff --git a/editors/ComponentEditor/fileSet/file/filebuildcommand.h b/editors/ComponentEditor/fileSet/file/filebuildcommand.h index 098878e31..ef8eea57c 100644 --- a/editors/ComponentEditor/fileSet/file/filebuildcommand.h +++ b/editors/ComponentEditor/fileSet/file/filebuildcommand.h @@ -41,12 +41,12 @@ class FileBuildCommand : public QGroupBox /*! * The constructor. * - * @param [in] fileName The file that is being edited. - * @param [in] fileInterface Interface for files. - * @param [in] componentPath The path to the component containing the file. - * @param [in] parameterFinder The used parameter finder. - * @param [in] expressionParser Parser for calculating expressions. - * @param [in] parent The owner of this widget. + * @param [in] fileName The file that is being edited. + * @param [in] fileInterface Interface for files. + * @param [in] componentPath The path to the component containing the file. + * @param [in] parameterFinder The used parameter finder. + * @param [in] expressionParser Parser for calculating expressions. + * @param [in] parent The owner of this widget. */ FileBuildCommand(std::string fileName, FileInterface* fileInterface, @@ -68,7 +68,7 @@ class FileBuildCommand : public QGroupBox /*! * Handle the name change of the containing file. * - * @param [in] newName The new name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& newName); @@ -82,14 +82,14 @@ class FileBuildCommand : public QGroupBox /*! * Increase the number of references made to the selected parameter. * - * @param [in] id ID of the selected parameter. + * @param [in] id ID of the selected parameter. */ void increaseReferences(QString id); /*! * Decrease the number of references made to the selected parameter. * - * @param [in] id ID of the selected parameter. + * @param [in] id ID of the selected parameter. */ void decreaseReferences(QString id); diff --git a/editors/ComponentEditor/fileSet/file/filedefinemodel.h b/editors/ComponentEditor/fileSet/file/filedefinemodel.h index 2f5939422..a51e3651d 100644 --- a/editors/ComponentEditor/fileSet/file/filedefinemodel.h +++ b/editors/ComponentEditor/fileSet/file/filedefinemodel.h @@ -30,8 +30,8 @@ class FileDefineModel : public QAbstractTableModel /*! The constructor * - * @param [in] file The file being modified. - * @param [in] parent The owner of this widget. + * @param [in] file The file being modified. + * @param [in] parent The owner of this widget. */ FileDefineModel(QSharedPointer file, QObject* parent); @@ -40,80 +40,80 @@ class FileDefineModel : public QAbstractTableModel /*! Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns in the model * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of columns currently in the model. + * @return Number of columns currently in the model. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Get the data for the headers * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return The string to display as header. + * @return The string to display as header. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! Insert rows to the model * - * @param [in] row The row to start inserting rows to. - * @param [in] count The number of rows to insert. - * @param [in] parent Model index of the parent to which the rows are inserted. + * @param [in] row The row to start inserting rows to. + * @param [in] count The number of rows to insert. + * @param [in] parent Model index of the parent to which the rows are inserted. * - * @return True if rows were successfully inserted. + * @return True if rows were successfully inserted. */ bool insertRows(int row, int count, QModelIndex const& parent = QModelIndex()); /*! Remove rows from the model * - * @param [in] row The row to start removing rows from. - * @param [in] count The number of rows to remove - * @param [in] parent Model index of the parent from which the rows are removed. + * @param [in] row The row to start removing rows from. + * @param [in] count The number of rows to remove + * @param [in] parent Model index of the parent from which the rows are removed. * - * @return True if rows were successfully removed. + * @return True if rows were successfully removed. */ bool removeRows(int row, int count, QModelIndex const& parent = QModelIndex()); /*! Is the model in valid condition. * - * @return True if the items in the model are valid. + * @return True if the items in the model are valid. */ bool isValid() const; diff --git a/editors/ComponentEditor/fileSet/file/fileeditor.h b/editors/ComponentEditor/fileSet/file/fileeditor.h index 425efca5a..1762244e7 100644 --- a/editors/ComponentEditor/fileSet/file/fileeditor.h +++ b/editors/ComponentEditor/fileSet/file/fileeditor.h @@ -44,14 +44,14 @@ class FileEditor : public ItemEditor /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] fileName Name of the file that is edited. - * @param [in] parameterFinder The used parameter finder. - * @param [in] expressionParser Parser for calculating expressions. - * @param [in] fileInterface Interface for files. - * @param [in] files The available files. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] fileName Name of the file that is edited. + * @param [in] parameterFinder The used parameter finder. + * @param [in] expressionParser Parser for calculating expressions. + * @param [in] fileInterface Interface for files. + * @param [in] files The available files. + * @param [in] parent Pointer to the owner of this widget. */ FileEditor(LibraryInterface* handler, QSharedPointer component, @@ -77,8 +77,8 @@ public slots: /*! * Handle the name change of the containing file. * - * @param [in] oldName Old name of the file. - * @param [in] newName The new name of the file. + * @param [in] oldName Old name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& oldName, std::string const& newName); @@ -98,7 +98,7 @@ public slots: /*! * Shows the editor and emits a request for the help file. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event); diff --git a/editors/ComponentEditor/fileSet/file/filegeneraleditor.h b/editors/ComponentEditor/fileSet/file/filegeneraleditor.h index 68073738e..3441a3f16 100644 --- a/editors/ComponentEditor/fileSet/file/filegeneraleditor.h +++ b/editors/ComponentEditor/fileSet/file/filegeneraleditor.h @@ -33,9 +33,9 @@ class FileGeneralEditor : public QGroupBox /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget - * @param [in] fileName Name of the file that is being edited. - * @param [in] fileInterface Interface for accessing files. + * @param [in] parent Pointer to the owner of this widget + * @param [in] fileName Name of the file that is being edited. + * @param [in] fileInterface Interface for accessing files. */ FileGeneralEditor(QWidget *parent, std::string const& fileName, FileInterface* fileInterface); @@ -52,7 +52,7 @@ class FileGeneralEditor : public QGroupBox /*! * Handle the name change of the containing file. * - * @param [in] newName The new name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& newName); diff --git a/editors/ComponentEditor/fileSet/file/filenameeditor.h b/editors/ComponentEditor/fileSet/file/filenameeditor.h index b2b7d5388..7343ca04f 100644 --- a/editors/ComponentEditor/fileSet/file/filenameeditor.h +++ b/editors/ComponentEditor/fileSet/file/filenameeditor.h @@ -32,9 +32,9 @@ class FileNameEditor : public QGroupBox /*! * The constructor * - * @param [in] fileName Name of to the file being edited. - * @param [in] fileInterface Interface for accessing files. - * @param [in] parent Pointer to the owner of this widget + * @param [in] fileName Name of to the file being edited. + * @param [in] fileInterface Interface for accessing files. + * @param [in] parent Pointer to the owner of this widget */ FileNameEditor(std::string const& fileName, FileInterface* fileInterface, QWidget *parent); @@ -55,7 +55,7 @@ class FileNameEditor : public QGroupBox /*! * Handle the name change of the containing file. * - * @param [in] newName The new name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& newName); diff --git a/editors/ComponentEditor/fileSet/file/filesdelegate.h b/editors/ComponentEditor/fileSet/file/filesdelegate.h index c4bac5f6f..548746038 100644 --- a/editors/ComponentEditor/fileSet/file/filesdelegate.h +++ b/editors/ComponentEditor/fileSet/file/filesdelegate.h @@ -33,7 +33,7 @@ class FilesDelegate : public MultilineDescriptionDelegate /*! * The constructor. * - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] parent Pointer to the owner of the delegate. */ FilesDelegate(Document::Revision docRevision, QObject *parent); @@ -47,11 +47,11 @@ class FilesDelegate : public MultilineDescriptionDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -59,17 +59,17 @@ class FilesDelegate : public MultilineDescriptionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; diff --git a/editors/ComponentEditor/fileSet/file/fileseditor.h b/editors/ComponentEditor/fileSet/file/fileseditor.h index 9bc2a382c..57bfd5872 100644 --- a/editors/ComponentEditor/fileSet/file/fileseditor.h +++ b/editors/ComponentEditor/fileSet/file/fileseditor.h @@ -36,12 +36,12 @@ class FilesEditor : public QGroupBox /*! * The constructor. * - * @param [in] availableFiles List of editable files. - * @param [ni] fileInterface Interface for accessing files. - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of this editor. - * @param [in] title The title for the group box. + * @param [in] availableFiles List of editable files. + * @param [ni] fileInterface Interface for accessing files. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of this editor. + * @param [in] title The title for the group box. */ FilesEditor(QSharedPointer > > availableFiles, FileInterface* fileInterface, @@ -79,8 +79,8 @@ public slots: /*! * Inform of a name change in a file. * - * @param [in] oldName Old name of the file. - * @param [in] newName The new name of the file. + * @param [in] oldName Old name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& oldName, std::string const& newName); diff --git a/editors/ComponentEditor/fileSet/file/filesmodel.h b/editors/ComponentEditor/fileSet/file/filesmodel.h index fd9e0dbfc..3d6c5072e 100644 --- a/editors/ComponentEditor/fileSet/file/filesmodel.h +++ b/editors/ComponentEditor/fileSet/file/filesmodel.h @@ -34,10 +34,10 @@ class FilesModel : public QAbstractTableModel /*! The constructor. * - * @param [in] handler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] fileInterface Interface for accessing files. - * @param [in] parent The owner of this model. + * @param [in] handler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] fileInterface Interface for accessing files. + * @param [in] parent The owner of this model. * */ FilesModel(LibraryInterface* handler, @@ -53,86 +53,86 @@ class FilesModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Flags specifying the possible operations for the item. + * @return Flags specifying the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return The requested data. + * @return The requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return The data for the item. + * @return The data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if save was successful, otherwise false. + * @return True if save was successful, otherwise false. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ virtual QStringList mimeTypes() const; /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ virtual Qt::DropActions supportedDropActions() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ virtual bool dropMimeData(QMimeData const* data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -142,30 +142,30 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new file. + * @param [in] index The index identifying the position for new file. */ virtual void onAddItem(QModelIndex const& index); /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new file. - * @param [in] filePath The file path to the file to be added. + * @param [in] index The index identifying the position for new file. + * @param [in] filePath The file path to the file to be added. */ virtual void onAddItem(QModelIndex const& index, const QString& filePath); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); /*! * Move item from one position to another. * - * @param [in] originalPos The index identifying which item to move. - * @param [in] newPos The position to move the item to. + * @param [in] originalPos The index identifying which item to move. + * @param [in] newPos The position to move the item to. */ virtual void onMoveItem(QModelIndex const& originalPos, QModelIndex const& newPos); @@ -186,8 +186,8 @@ public slots: /*! * Informs of a file name change. * - * @param [in] oldName Old name of the file. - * @param [in] newName New name of the file. + * @param [in] oldName Old name of the file. + * @param [in] newName New name of the file. */ void fileRenamed(std::string const& oldName, std::string const& newName); @@ -199,9 +199,9 @@ public slots: /*! * Get the file types of the selected file as a combined string. * - * @param [in] fileName Name of the selected file. + * @param [in] fileName Name of the selected file. * - * @return File types of the selected file as a combined string. + * @return File types of the selected file as a combined string. */ QString getFileTypesString(std::string const& fileName) const; diff --git a/editors/ComponentEditor/fileSet/file/filesview.h b/editors/ComponentEditor/fileSet/file/filesview.h index e6aae5377..a1cf69c28 100644 --- a/editors/ComponentEditor/fileSet/file/filesview.h +++ b/editors/ComponentEditor/fileSet/file/filesview.h @@ -33,9 +33,9 @@ class FilesView : public EditableTableView /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the owner of this view. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the owner of this view. */ FilesView(LibraryInterface* handler, QSharedPointer component, QWidget *parent); diff --git a/editors/ComponentEditor/fileSet/file/filetypeeditor.h b/editors/ComponentEditor/fileSet/file/filetypeeditor.h index 9a515350d..f436a68ff 100644 --- a/editors/ComponentEditor/fileSet/file/filetypeeditor.h +++ b/editors/ComponentEditor/fileSet/file/filetypeeditor.h @@ -33,9 +33,9 @@ class FileTypeEditor : public ListManager /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget - * @param [in] fileName Name of the file being edited - * @param [in] fileInterface Interface for accessing files. + * @param [in] parent Pointer to the owner of this widget + * @param [in] fileName Name of the file being edited + * @param [in] fileInterface Interface for accessing files. */ FileTypeEditor(Document::Revision docRevision, QWidget *parent, std::string const& fileName, FileInterface* fileInterface); @@ -49,7 +49,7 @@ class FileTypeEditor : public ListManager * * This function must be called after creating the file type editor and before using it. * - * @param [in] items QStringList that contains the items to add to the widget. + * @param [in] items QStringList that contains the items to add to the widget. */ virtual void initialize(const QStringList& items = QStringList()); @@ -66,14 +66,14 @@ class FileTypeEditor : public ListManager /*! * Check if the editor is in a valid state or not. * - * @return True if the editor is in valid state + * @return True if the editor is in valid state */ bool isValid() const; /*! * Handle the name change of the containing file. * - * @param [in] newName The new name of the file. + * @param [in] newName The new name of the file. */ void fileRenamed(std::string const& newName); diff --git a/editors/ComponentEditor/fileSet/file/filetypeeditordelegate.h b/editors/ComponentEditor/fileSet/file/filetypeeditordelegate.h index 835f98b42..bdd2a1a7c 100644 --- a/editors/ComponentEditor/fileSet/file/filetypeeditordelegate.h +++ b/editors/ComponentEditor/fileSet/file/filetypeeditordelegate.h @@ -29,7 +29,7 @@ class FileTypeEditorDelegate : public QStyledItemDelegate /*! The constructor * - * @param [in] parent The owner of this delegate. + * @param [in] parent The owner of this delegate. * */ FileTypeEditorDelegate(Document::Revision docRevision, QObject *parent); @@ -39,27 +39,27 @@ class FileTypeEditorDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/fileSet/fileseteditor.h b/editors/ComponentEditor/fileSet/fileseteditor.h index 56ff77cbc..93ffeade4 100644 --- a/editors/ComponentEditor/fileSet/fileseteditor.h +++ b/editors/ComponentEditor/fileSet/fileseteditor.h @@ -45,14 +45,14 @@ class FileSetEditor : public ItemEditor /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component model that is being edited. - * @param [in] fileSet The edited fileset. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] expressionFormatter Formatter used to format expressions. - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component model that is being edited. + * @param [in] fileSet The edited fileset. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] expressionFormatter Formatter used to format expressions. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parent Pointer to the owner of this widget. */ FileSetEditor(LibraryInterface* handler, QSharedPointer component, @@ -79,8 +79,8 @@ class FileSetEditor : public ItemEditor /*! * Handle the name change of a file. * - * @param [in] oldName Old name of the selected file. - * @param [in] newName The new name for the selected file. + * @param [in] oldName Old name of the selected file. + * @param [in] newName The new name for the selected file. */ void fileRenamed(std::string const& oldName, std::string const& newName); diff --git a/editors/ComponentEditor/fileSet/filesetsdelegate.h b/editors/ComponentEditor/fileSet/filesetsdelegate.h index 29d1403f4..61ee47d17 100644 --- a/editors/ComponentEditor/fileSet/filesetsdelegate.h +++ b/editors/ComponentEditor/fileSet/filesetsdelegate.h @@ -38,7 +38,7 @@ class FileSetsDelegate : public MultilineDescriptionDelegate /*! * The constructor * - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] parent Pointer to the owner of the delegate. */ FileSetsDelegate(QObject *parent); @@ -48,11 +48,11 @@ class FileSetsDelegate : public MultilineDescriptionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -60,17 +60,17 @@ class FileSetsDelegate : public MultilineDescriptionDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/fileSet/filesetseditor.h b/editors/ComponentEditor/fileSet/filesetseditor.h index 4a9e2fceb..1ce670820 100644 --- a/editors/ComponentEditor/fileSet/filesetseditor.h +++ b/editors/ComponentEditor/fileSet/filesetseditor.h @@ -38,10 +38,10 @@ class FileSetsEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] libInterface The library interface. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] component The component being edited. + * @param [in] libInterface The library interface. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] fileSetInterface Interface for accessing file sets. */ FileSetsEditor(QSharedPointer component, LibraryInterface* libInterface, diff --git a/editors/ComponentEditor/fileSet/filesetsmodel.h b/editors/ComponentEditor/fileSet/filesetsmodel.h index 1fe7e6b3f..acf7abaa0 100644 --- a/editors/ComponentEditor/fileSet/filesetsmodel.h +++ b/editors/ComponentEditor/fileSet/filesetsmodel.h @@ -33,9 +33,9 @@ class FileSetsModel : public QAbstractTableModel /*! * The constructor * - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] parent The owner of this model. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] parent The owner of this model. */ FileSetsModel(FileSetInterface* fileSetInterface, QSharedPointer parameterFinder, @@ -53,54 +53,54 @@ class FileSetsModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Flags specify the possible operations for the item. + * @return Flags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; @@ -108,14 +108,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. * */ virtual void onRemoveItem(const QModelIndex& index); @@ -123,7 +123,7 @@ public slots: /*! * Updates the model when a file set has been added from outside the model. * - * @param [in] fileSet The file set that was added. + * @param [in] fileSet The file set that was added. */ void onFileSetAdded(FileSet* fileSet); @@ -134,14 +134,14 @@ public slots: /*! Emitted when a new file set is added to the model. * - * @param [in] index The index of the added file set. + * @param [in] index The index of the added file set. * */ void fileSetAdded(int index); /*! Emitted when a file set is removed from the model. * - * @param [in] index The index of the removed file set. + * @param [in] index The index of the removed file set. * */ void fileSetRemoved(int index); @@ -149,7 +149,7 @@ public slots: /*! * Decrease the amount of references to the selected parameter. * - * @param [in] valueId The id of the referenced parameter. + * @param [in] valueId The id of the referenced parameter. */ void decreaseReferences(QString valueId) const; @@ -161,7 +161,7 @@ public slots: /*! * Remove the references from the selected file set. * - * @param [in] fileSetName Name of the selected file set. + * @param [in] fileSetName Name of the selected file set. */ void decreaseReferencesWithRemovedFileSet(std::string const& fileSetName); diff --git a/editors/ComponentEditor/fileSet/groupmanager.h b/editors/ComponentEditor/fileSet/groupmanager.h index a2ffde283..05029b577 100644 --- a/editors/ComponentEditor/fileSet/groupmanager.h +++ b/editors/ComponentEditor/fileSet/groupmanager.h @@ -25,8 +25,8 @@ class GroupManager : public ListManager /*! The constructor. * - * @param [in] title The title for the QGroupBox. - * @param [in] parent The owner of this widget. + * @param [in] title The title for the QGroupBox. + * @param [in] parent The owner of this widget. */ GroupManager(QString const& title = tr("Group identifiers"), QWidget* parent = 0); @@ -37,7 +37,7 @@ class GroupManager : public ListManager * * This function must be called after creating the group manager and before using it. * - * @param [in] items The items to add to the widget. + * @param [in] items The items to add to the widget. */ virtual void initialize(QStringList const& items = QStringList()); diff --git a/editors/ComponentEditor/fileSet/groupmanagerdelegate.h b/editors/ComponentEditor/fileSet/groupmanagerdelegate.h index 39a1cb89c..11f0f7cef 100644 --- a/editors/ComponentEditor/fileSet/groupmanagerdelegate.h +++ b/editors/ComponentEditor/fileSet/groupmanagerdelegate.h @@ -22,7 +22,7 @@ class GroupManagerDelegate : public QStyledItemDelegate { /*! The constructor * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ GroupManagerDelegate(QObject *parent); @@ -31,11 +31,11 @@ class GroupManagerDelegate : public QStyledItemDelegate { /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/general/generaleditor.h b/editors/ComponentEditor/general/generaleditor.h index 8799ec847..3a190c7b8 100644 --- a/editors/ComponentEditor/general/generaleditor.h +++ b/editors/ComponentEditor/general/generaleditor.h @@ -47,9 +47,9 @@ class GeneralEditor : public ItemEditor /*! * Constructor. * - * @param [in] libHandler The library handler. - * @param [in] component The component model to edit. - * @param [in] parent The parent widget. + * @param [in] libHandler The library handler. + * @param [in] component The component model to edit. + * @param [in] parent The parent widget. */ GeneralEditor(LibraryInterface* libHandler, QSharedPointer component, QWidget *parent = 0); @@ -65,7 +65,7 @@ class GeneralEditor : public ItemEditor /*! * Check for the validity of the edited item. * - * @return True is item is valid. + * @return True is item is valid. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesDelegate.h b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesDelegate.h index 11f842d92..459ce9970 100644 --- a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesDelegate.h +++ b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesDelegate.h @@ -27,8 +27,8 @@ class IndirectInterfacesDelegate : public MultilineDescriptionDelegate /*! The constructor * - * @param [in] component The component containing the edited indirect interfaces. - * @param [in] parent The owner of the delegate. + * @param [in] component The component containing the edited indirect interfaces. + * @param [in] parent The owner of the delegate. */ IndirectInterfacesDelegate(QSharedPointer component, QObject *parent); @@ -37,11 +37,11 @@ class IndirectInterfacesDelegate : public MultilineDescriptionDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -49,17 +49,17 @@ class IndirectInterfacesDelegate : public MultilineDescriptionDelegate /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesEditor.h b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesEditor.h index 879a1d528..7c28597e3 100644 --- a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesEditor.h +++ b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesEditor.h @@ -38,10 +38,10 @@ class IndirectInterfacesEditor : public ItemEditor /*! * The constructor. * - * @param [in] library The IP library. - * @param [in] component The component being edited. - * @param [in] validator The validator for indirect interfaces. - * @param [in] parent The owner of this editor. + * @param [in] library The IP library. + * @param [in] component The component being edited. + * @param [in] validator The validator for indirect interfaces. + * @param [in] parent The owner of this editor. */ IndirectInterfacesEditor(LibraryInterface* library, QSharedPointer component, QSharedPointer validator, diff --git a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesModel.h b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesModel.h index e724e5584..0a2fa21ee 100644 --- a/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesModel.h +++ b/editors/ComponentEditor/indirectInterfaces/IndirectInterfacesModel.h @@ -35,9 +35,9 @@ class IndirectInterfacesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] validator The validator for items. - * @param [in] parent The owner of this model. + * @param [in] component The component being edited. + * @param [in] validator The validator for items. + * @param [in] parent The owner of this model. */ IndirectInterfacesModel(QSharedPointer component, QSharedPointer validator, @@ -52,54 +52,54 @@ class IndirectInterfacesModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -107,14 +107,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. * */ void onRemoveItem(QModelIndex const& index); @@ -126,14 +126,14 @@ public slots: /*! Emitted when a new bus interface is added to the model. * - * @param [in] index The index of the added bus interface. + * @param [in] index The index of the added bus interface. * */ void interfaceAdded(int index); /*! Emitted when a bus interface is removed from the model. * - * @param [in] index The index of the bus interface to remove. + * @param [in] index The index of the bus interface to remove. * */ void interfaceRemoved(int index); @@ -141,14 +141,14 @@ public slots: /*! * Increase the number of references made to the specified parameter. * - * @param [in] id Id of the parameter whose reference count is increased. + * @param [in] id Id of the parameter whose reference count is increased. */ void increaseReferences(QString id); /*! * Decrease the number of references made to the specified parameter. * - * @param [in] id Id of the parameter whose reference count is decreased. + * @param [in] id Id of the parameter whose reference count is decreased. */ void decreaseReferences(QString id); diff --git a/editors/ComponentEditor/indirectInterfaces/SingleIndirectInterfaceEditor.h b/editors/ComponentEditor/indirectInterfaces/SingleIndirectInterfaceEditor.h index d078a349b..6ed55cf7a 100644 --- a/editors/ComponentEditor/indirectInterfaces/SingleIndirectInterfaceEditor.h +++ b/editors/ComponentEditor/indirectInterfaces/SingleIndirectInterfaceEditor.h @@ -42,13 +42,13 @@ class SingleIndirectInterfaceEditor : public ParameterItemEditor /*! * The constructor.. * - * @param [in] indirectInterface The indirect interface to edit. - * @param [in] validator Validator for the indirect interface. - * @param [in] component The component containing the indirect interface. - * @param [in] library The available IP-XACT library. - * @param [in] finder Finder for available parameters for the indirect interface. - * @param [in] formatter Formatter for expressions. - * @param [in] parent The parent widget. + * @param [in] indirectInterface The indirect interface to edit. + * @param [in] validator Validator for the indirect interface. + * @param [in] component The component containing the indirect interface. + * @param [in] library The available IP-XACT library. + * @param [in] finder Finder for available parameters for the indirect interface. + * @param [in] formatter Formatter for expressions. + * @param [in] parent The parent widget. */ SingleIndirectInterfaceEditor(QSharedPointer indirectInterface, QSharedPointer validator, @@ -106,14 +106,14 @@ private slots: /*! * Handle the selection of memory map. * - * @param [in] checked Flag for enabling memory map. + * @param [in] checked Flag for enabling memory map. */ void onMemoryMapSelected(bool checked); /*! * Handle the selection of transparent bridges. * - * @param [in] checked Flag for enabling transparent bridges. + * @param [in] checked Flag for enabling transparent bridges. */ void onTransparentBridgeSelected(bool checked); private: @@ -134,7 +134,7 @@ private slots: /*! * Finds all the available field references. * - * @return The available field references in the current component. + * @return The available field references in the current component. */ QStringList findAvailableReferences() const; diff --git a/editors/ComponentEditor/instantiations/ComponentInstantiationDisplayer.h b/editors/ComponentEditor/instantiations/ComponentInstantiationDisplayer.h index 8ed4aca2b..18992f51f 100644 --- a/editors/ComponentEditor/instantiations/ComponentInstantiationDisplayer.h +++ b/editors/ComponentEditor/instantiations/ComponentInstantiationDisplayer.h @@ -28,7 +28,7 @@ class ComponentInstantiationDisplayer : public QGroupBox /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ComponentInstantiationDisplayer(QWidget* parent); diff --git a/editors/ComponentEditor/instantiations/ComponentInstantiationEditor.h b/editors/ComponentEditor/instantiations/ComponentInstantiationEditor.h index 0843e9ea9..a1ece69f0 100644 --- a/editors/ComponentEditor/instantiations/ComponentInstantiationEditor.h +++ b/editors/ComponentEditor/instantiations/ComponentInstantiationEditor.h @@ -47,14 +47,14 @@ class ComponentInstantiationEditor : public ParameterItemEditor /*! * The constructor. * - * @param [in] component The component that contains the view. - * @param [in] view The view being edited. - * @param [in] parameterFinder Parameter finder for view parameter expressions. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] expressionFormatter Formatter for view parameter expressions. - * @param [in] instantiationInterface Interface for accessing component instantiations. - * @param [in] parent The owner of this widget. + * @param [in] component The component that contains the view. + * @param [in] view The view being edited. + * @param [in] parameterFinder Parameter finder for view parameter expressions. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] expressionFormatter Formatter for view parameter expressions. + * @param [in] instantiationInterface Interface for accessing component instantiations. + * @param [in] parent The owner of this widget. */ ComponentInstantiationEditor(QSharedPointer component, LibraryInterface* library, diff --git a/editors/ComponentEditor/instantiations/ComponentInstantiationsEditor.h b/editors/ComponentEditor/instantiations/ComponentInstantiationsEditor.h index ede428716..c27e91ac5 100644 --- a/editors/ComponentEditor/instantiations/ComponentInstantiationsEditor.h +++ b/editors/ComponentEditor/instantiations/ComponentInstantiationsEditor.h @@ -36,11 +36,11 @@ class ComponentInstantiationsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] instantiationInterface Interface for accessing component instantiations. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] instantiationInterface Interface for accessing component instantiations. + * @param [in] parent The parent of this editor. */ ComponentInstantiationsEditor(QSharedPointer component, LibraryInterface* handler, diff --git a/editors/ComponentEditor/instantiations/ComponentInstantiationsModel.h b/editors/ComponentEditor/instantiations/ComponentInstantiationsModel.h index 71e34aaef..ad71f3ba0 100644 --- a/editors/ComponentEditor/instantiations/ComponentInstantiationsModel.h +++ b/editors/ComponentEditor/instantiations/ComponentInstantiationsModel.h @@ -35,9 +35,9 @@ class ComponentInstantiationsModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] finder Finder used to identify parameters. - * @param [in] instantiationInterface Interface for accessing component instantiations. - * @param [in] parent Pointer to the owner of the model. + * @param [in] finder Finder used to identify parameters. + * @param [in] instantiationInterface Interface for accessing component instantiations. + * @param [in] parent Pointer to the owner of the model. */ ComponentInstantiationsModel(QSharedPointer finder, ComponentInstantiationInterface* instantiationInterface, @@ -51,59 +51,59 @@ class ComponentInstantiationsModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return The requested data. + * @return The requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return The data for the item. + * @return The data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True, if saving happened successfully, otherwise false. + * @return True, if saving happened successfully, otherwise false. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -112,14 +112,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); @@ -137,7 +137,7 @@ public slots: /*! * Decrease the amount of references to the selected parameter. * - * @param [in] valueId The id of the referenced parameter. + * @param [in] valueId The id of the referenced parameter. */ void decreaseReferences(QString valueId) const; @@ -149,16 +149,16 @@ public slots: /*! * Remove references made in the selected component instantiation. * - * @param [in] instantiationName Name of the selected component instantiation. + * @param [in] instantiationName Name of the selected component instantiation. */ void decreaseReferencesInRemovedComponentInstantiation(std::string const& instantiationName); /*! * Get all the referable values form a given parameter. * - * @param [in] selectedParameter The selected parameter. + * @param [in] selectedParameter The selected parameter. * - * @return A list of values with possible references to parameters. + * @return A list of values with possible references to parameters. */ QStringList getAllReferencableValuesFromParameter(QSharedPointer selectedParameter) const; diff --git a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationEditor.h b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationEditor.h index 966beb3b9..3f504bbdc 100644 --- a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationEditor.h +++ b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationEditor.h @@ -34,12 +34,12 @@ class DesignConfigurationInstantiationEditor : public ParameterItemEditor /*! * Constructor. * - * @param [in] component The component being edited. - * @param [in] instantiation The instantiation being edited. - * @param [in] libHandler The available IP-XACT library. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] parent The parent widget. + * @param [in] component The component being edited. + * @param [in] instantiation The instantiation being edited. + * @param [in] libHandler The available IP-XACT library. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] parent The parent widget. */ DesignConfigurationInstantiationEditor(QSharedPointer component, QSharedPointer instantiation, @@ -81,7 +81,7 @@ private slots: /*! * Create configurable element editor. * - * @param [in] parameterFinder The component parameter finder. + * @param [in] parameterFinder The component parameter finder. */ void createConfigurableElementEditor(QSharedPointer parameterFinder); diff --git a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsEditor.h b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsEditor.h index 34f518751..5225309fb 100644 --- a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsEditor.h +++ b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsEditor.h @@ -33,10 +33,10 @@ class DesignConfigurationInstantiationsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator used for design configuration instantiations. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator used for design configuration instantiations. + * @param [in] parent The parent of this editor. */ DesignConfigurationInstantiationsEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer validator, QWidget* parent = 0); diff --git a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsModel.h b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsModel.h index faeba0a10..eae02a62a 100644 --- a/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsModel.h +++ b/editors/ComponentEditor/instantiations/DesignConfigurationInstantiationsModel.h @@ -33,11 +33,11 @@ class DesignConfigurationInstantiationsModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] instantiations The design configuration instantiations. - * @param [in] validator The validator used for design configuration instantiations. - * @param [in] component The component being edited. - * @param [in] library The library interface. - * @param [in] parent The owner of the model. + * @param [in] instantiations The design configuration instantiations. + * @param [in] validator The validator used for design configuration instantiations. + * @param [in] component The component being edited. + * @param [in] library The library interface. + * @param [in] parent The owner of the model. */ DesignConfigurationInstantiationsModel( QSharedPointer > > instantiations, @@ -50,86 +50,86 @@ class DesignConfigurationInstantiationsModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ virtual Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ virtual QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ virtual bool dropMimeData(QMimeData const* data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -139,14 +139,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); diff --git a/editors/ComponentEditor/instantiations/DesignInstantiationEditor.h b/editors/ComponentEditor/instantiations/DesignInstantiationEditor.h index 78c3aba9a..a8aa097ae 100644 --- a/editors/ComponentEditor/instantiations/DesignInstantiationEditor.h +++ b/editors/ComponentEditor/instantiations/DesignInstantiationEditor.h @@ -37,11 +37,11 @@ class DesignInstantiationEditor : public ItemEditor /*! * Constructor. * - * @param [in] component The component being edited. - * @param [in] instantiation The instantiation being edited. - * @param [in] libHandler The available IP-XACT library. - * @param [in] componentParameterFinder Finds the parameters contained within the component. - * @param [in] parent The parent widget. + * @param [in] component The component being edited. + * @param [in] instantiation The instantiation being edited. + * @param [in] libHandler The available IP-XACT library. + * @param [in] componentParameterFinder Finds the parameters contained within the component. + * @param [in] parent The parent widget. */ DesignInstantiationEditor(QSharedPointer component, QSharedPointer instantiation, LibraryInterface* libHandler, diff --git a/editors/ComponentEditor/instantiations/DesignInstantiationsDelegate.h b/editors/ComponentEditor/instantiations/DesignInstantiationsDelegate.h index 99a992d44..67740d243 100644 --- a/editors/ComponentEditor/instantiations/DesignInstantiationsDelegate.h +++ b/editors/ComponentEditor/instantiations/DesignInstantiationsDelegate.h @@ -26,7 +26,7 @@ class DesignInstantiationsDelegate : public MultilineDescriptionDelegate /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ DesignInstantiationsDelegate(QObject* parent); diff --git a/editors/ComponentEditor/instantiations/DesignInstantiationsEditor.h b/editors/ComponentEditor/instantiations/DesignInstantiationsEditor.h index 2dde8816c..3efc58fb4 100644 --- a/editors/ComponentEditor/instantiations/DesignInstantiationsEditor.h +++ b/editors/ComponentEditor/instantiations/DesignInstantiationsEditor.h @@ -33,10 +33,10 @@ class DesignInstantiationsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator used for design instantiations. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator used for design instantiations. + * @param [in] parent The parent of this editor. */ DesignInstantiationsEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer validator, QWidget* parent = 0); diff --git a/editors/ComponentEditor/instantiations/DesignInstantiationsModel.h b/editors/ComponentEditor/instantiations/DesignInstantiationsModel.h index 5c64fe08b..69126adbb 100644 --- a/editors/ComponentEditor/instantiations/DesignInstantiationsModel.h +++ b/editors/ComponentEditor/instantiations/DesignInstantiationsModel.h @@ -34,11 +34,11 @@ class DesignInstantiationsModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] instantiations The design instantiations. - * @param [in] validator The instantiations validator. - * @param [in] component Pointer to the component being edited. - * @param [in] library The library interface. - * @param [in] parent Pointer to the owner of the model. + * @param [in] instantiations The design instantiations. + * @param [in] validator The instantiations validator. + * @param [in] component Pointer to the component being edited. + * @param [in] library The library interface. + * @param [in] parent Pointer to the owner of the model. */ DesignInstantiationsModel(QSharedPointer > > instantiations, QSharedPointer validator, QSharedPointer component, @@ -50,86 +50,86 @@ class DesignInstantiationsModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ virtual Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ virtual QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ virtual bool dropMimeData(QMimeData const* data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -139,14 +139,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); diff --git a/editors/ComponentEditor/instantiations/InstantiationsEditor.h b/editors/ComponentEditor/instantiations/InstantiationsEditor.h index 21545ce99..921fd8582 100644 --- a/editors/ComponentEditor/instantiations/InstantiationsEditor.h +++ b/editors/ComponentEditor/instantiations/InstantiationsEditor.h @@ -36,12 +36,12 @@ class InstantiationsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator used for instantiations. - * @param [in] componentInstantiationInterface Interface for accessing component instantiations. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator used for instantiations. + * @param [in] componentInstantiationInterface Interface for accessing component instantiations. + * @param [in] parent The parent of this editor. */ InstantiationsEditor(QSharedPointer component, QSharedPointer parameterFinder, diff --git a/editors/ComponentEditor/instantiations/ModuleParameterDelegate.h b/editors/ComponentEditor/instantiations/ModuleParameterDelegate.h index d02070b4b..7102e9dee 100644 --- a/editors/ComponentEditor/instantiations/ModuleParameterDelegate.h +++ b/editors/ComponentEditor/instantiations/ModuleParameterDelegate.h @@ -31,12 +31,12 @@ class ModuleParameterDelegate : public ParameterDelegate /*! The constructor * - * @param [in] choices The choices available for model parameter value. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent The parent object + * @param [in] choices The choices available for model parameter value. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent The parent object */ ModuleParameterDelegate(QSharedPointer > > choices, QAbstractItemModel* completionModel, @@ -51,11 +51,11 @@ class ModuleParameterDelegate : public ParameterDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -65,98 +65,98 @@ class ModuleParameterDelegate : public ParameterDelegate /*! * Gets the column for name. * - * @return The column index for editing name. + * @return The column index for editing name. */ virtual int nameColumn() const; /*! * Gets the column for choices. * - * @return The column for editing choice selection. + * @return The column for editing choice selection. */ virtual int choiceColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int formatColumn() const; /*! * Gets the column for the left value of bit width vector. * - * @return The column for editing the left value of the bit width vector. + * @return The column for editing the left value of the bit width vector. */ virtual int bitWidthLeftColumn() const; /*! * Gets the column for the right value of bit width vector. * - * @return The column for editing the right value of the bit width vector. + * @return The column for editing the right value of the bit width vector. */ virtual int bitWidthRightColumn() const; /*! * Gets the column for minimum value. * - * @return The column for editing the minimum value. + * @return The column for editing the minimum value. */ virtual int minimumColumn() const; /*! * Gets the column for maximum value. * - * @return The column for editing the maximum value. + * @return The column for editing the maximum value. */ virtual int maximumColumn() const; /*! * Gets the column for values. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int valueColumn() const; /*! * Gets the column for resolve. * - * @return The column for resolve selection. + * @return The column for resolve selection. */ virtual int resolveColumn() const; /*! * Gets the column index for description. * - * @return The column index for description section. + * @return The column index for description section. */ virtual int descriptionColumn() const; /*! * Gets the column index for array left. * - * @return The column index for array left side. + * @return The column index for array left side. */ virtual int arrayLeftColumn() const; /*! * Gets the column index for array right. * - * @return The column index for array right side. + * @return The column index for array right side. */ virtual int arrayRightColumn() const; /*! * Gets the column index for usage count. * - * @return The column index for usage count. + * @return The column index for usage count. */ virtual int usageCountColumn() const; /*! * Gets the column index for the id of the model parameter. * - * @return The column index for model parameter id. + * @return The column index for model parameter id. */ virtual int idColumn() const; diff --git a/editors/ComponentEditor/instantiations/ModuleParameterEditor.h b/editors/ComponentEditor/instantiations/ModuleParameterEditor.h index 3088d9c13..49445540b 100644 --- a/editors/ComponentEditor/instantiations/ModuleParameterEditor.h +++ b/editors/ComponentEditor/instantiations/ModuleParameterEditor.h @@ -38,13 +38,13 @@ class ModuleParameterEditor : public QGroupBox /*! * The constructor. * - * @param [in] instantiation Component instantiation containing the selected module parameters. - * @param [in] componentChoices The component choices. - * @param [in] parameterFinder The selected parameter finder. - * @param [in] expressionFormatter The selected expression formatter. - * @param [in] parameterInterface Interface for accessing module parameters. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent The owner of this editor. + * @param [in] instantiation Component instantiation containing the selected module parameters. + * @param [in] componentChoices The component choices. + * @param [in] parameterFinder The selected parameter finder. + * @param [in] expressionFormatter The selected expression formatter. + * @param [in] parameterInterface Interface for accessing module parameters. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent The owner of this editor. */ ModuleParameterEditor( QSharedPointer instantiation, @@ -78,7 +78,7 @@ class ModuleParameterEditor : public QGroupBox /*! * Sets the module parameters to edit. * - * @param [in] containingInstantiation Component instantiation containing the module parameters. + * @param [in] containingInstantiation Component instantiation containing the module parameters. */ void setModuleParameters(QSharedPointer containingInstantiation); @@ -95,30 +95,30 @@ class ModuleParameterEditor : public QGroupBox /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); /*! * Open the reference tree of the parameter with the ID. * - * @param [in] id The ID of the parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id The ID of the parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName) const; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); diff --git a/editors/ComponentEditor/instantiations/ModuleParameterHeaderView.h b/editors/ComponentEditor/instantiations/ModuleParameterHeaderView.h index 21d3e79f1..065da6454 100644 --- a/editors/ComponentEditor/instantiations/ModuleParameterHeaderView.h +++ b/editors/ComponentEditor/instantiations/ModuleParameterHeaderView.h @@ -24,8 +24,8 @@ class ModuleParameterHeaderView : public ParameterEditorHeaderView /*! * The constructor for the header. * - * @param [in] orientation The headers orientation. - * @param [in] parent The parent of the header. + * @param [in] orientation The headers orientation. + * @param [in] parent The parent of the header. */ ModuleParameterHeaderView(Qt::Orientation orientation, QWidget* parent = 0); @@ -36,28 +36,28 @@ class ModuleParameterHeaderView : public ParameterEditorHeaderView /*! * Gets the description column index. * - * @return The description column index. + * @return The description column index. */ virtual int descriptionColumn() const; /*! * Gets the value column index. * - * @return The value column index. + * @return The value column index. */ virtual int valueColumn() const; /*! * Gets the maximum column index. * - * @return The maximum column index. + * @return The maximum column index. */ virtual int maximumColumn() const; /*! * Gets the index of array right column. * - * @return The array right column index. + * @return The array right column index. */ virtual int arrayRightColumn() const; diff --git a/editors/ComponentEditor/instantiations/ModuleParameterModel.h b/editors/ComponentEditor/instantiations/ModuleParameterModel.h index fdda0a847..be524ffbc 100644 --- a/editors/ComponentEditor/instantiations/ModuleParameterModel.h +++ b/editors/ComponentEditor/instantiations/ModuleParameterModel.h @@ -36,10 +36,10 @@ class ModuleParameterModel : public AbstractParameterModel /*! * The constructor. * - * @param [in] moduleParameterInterface Interface for accessing module parameters. - * @param [in] expressionParser Expression parser for configurable elements. - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of this model. + * @param [in] moduleParameterInterface Interface for accessing module parameters. + * @param [in] expressionParser Expression parser for configurable elements. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of this model. */ ModuleParameterModel(ModuleParameterInterface* moduleParameterInterface, QSharedPointer expressionParser, @@ -54,50 +54,50 @@ class ModuleParameterModel : public AbstractParameterModel /*! * Get the number of columns in the model * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of columns currently in the model. + * @return Number of columns currently in the model. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted. * - * @return The data for the given index. + * @return The data for the given index. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted. - * @param [in] orientation The orientation of the header data. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation The orientation of the header data. + * @param [in] role Specified the type of data that is wanted. * - * @return The header data for the given section. + * @return The header data for the given section. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True, if data was successfully set, otherwise false. + * @return True, if data was successfully set, otherwise false. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); @@ -121,14 +121,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ virtual void onRemoveItem(const QModelIndex& index); @@ -137,105 +137,105 @@ public slots: /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int nameColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int displayNameColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int typeColumn() const; /*! * Gets the column for the left value of bit width vector. * - * @return The column for editing the left value of the bit width vector. + * @return The column for editing the left value of the bit width vector. */ virtual int bitWidthLeftColumn() const; /*! * Gets the column for the right value of bit width vector. * - * @return The column for editing the right value of the bit width vector. + * @return The column for editing the right value of the bit width vector. */ virtual int bitWidthRightColumn() const; /*! * Gets the column for minimum value. * - * @return The column for editing the minimum value. + * @return The column for editing the minimum value. */ virtual int minimumColumn() const; /*! * Gets the column for maximum value. * - * @return The column for editing the maximum value. + * @return The column for editing the maximum value. */ virtual int maximumColumn() const; /*! * Gets the column for choices. * - * @return The column for editing choice selection. + * @return The column for editing choice selection. */ virtual int choiceColumn() const; /*! * Gets the column for values. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int valueColumn() const; /*! * Gets the column for resolve. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int resolveColumn() const; /*! * Gets the column for array left. * - * @return The column for editing array left. + * @return The column for editing array left. */ virtual int arrayLeftColumn() const; /*! * Gets the column for array right. * - * @return The column for editing array right. + * @return The column for editing array right. */ virtual int arrayRightColumn() const; /*! * Gets the column for description. * - * @return The column for editing description. + * @return The column for editing description. */ virtual int descriptionColumn() const; /*! * Gets the column index for model parameter id. * - * @return The column index for the model parameter id. + * @return The column index for the model parameter id. */ virtual int idColumn() const; /*! * Gets the column index for usage count. * - * @return The column index for usage count. + * @return The column index for usage count. */ virtual int usageCountColumn() const; diff --git a/editors/ComponentEditor/instantiations/filesetrefeditor.h b/editors/ComponentEditor/instantiations/filesetrefeditor.h index 76f4e38b7..e517b63cc 100644 --- a/editors/ComponentEditor/instantiations/filesetrefeditor.h +++ b/editors/ComponentEditor/instantiations/filesetrefeditor.h @@ -31,9 +31,9 @@ class FileSetRefEditor : public ListManager /*! * The constructor. * - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] title Title for the QGroupBox. - * @param [in] parent The owner of this editor. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] title Title for the QGroupBox. + * @param [in] parent The owner of this editor. */ FileSetRefEditor(FileSetInterface* fileSetInterface, const QString title = tr("List"), QWidget *parent = 0); @@ -45,7 +45,7 @@ class FileSetRefEditor : public ListManager /*! * Initialize the file set reference editor. * - * @param [in] items QStringList that contains the items to add to the widget. + * @param [in] items QStringList that contains the items to add to the widget. */ virtual void initialize(QStringList const& items = QStringList()); diff --git a/editors/ComponentEditor/instantiations/filesetrefeditordelegate.h b/editors/ComponentEditor/instantiations/filesetrefeditordelegate.h index fa2eb8e77..44671ac0c 100644 --- a/editors/ComponentEditor/instantiations/filesetrefeditordelegate.h +++ b/editors/ComponentEditor/instantiations/filesetrefeditordelegate.h @@ -31,8 +31,8 @@ class FileSetRefEditorDelegate : public ComboDelegate /*! * The constructor. * - * @param [in] parent The pointer to the owner of this delegate. - * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parent The pointer to the owner of this delegate. + * @param [in] fileSetInterface Interface for accessing file sets. */ FileSetRefEditorDelegate(QObject *parent, FileSetInterface* fileSetInterface); @@ -42,11 +42,11 @@ class FileSetRefEditorDelegate : public ComboDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; diff --git a/editors/ComponentEditor/instantiations/filesetrefmodel.h b/editors/ComponentEditor/instantiations/filesetrefmodel.h index 8bddae045..a551ca2cd 100644 --- a/editors/ComponentEditor/instantiations/filesetrefmodel.h +++ b/editors/ComponentEditor/instantiations/filesetrefmodel.h @@ -31,9 +31,9 @@ class FileSetRefModel : public ListManagerModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this model. - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] items QStringList that contains the items to add. + * @param [in] parent Pointer to the owner of this model. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] items QStringList that contains the items to add. */ FileSetRefModel(QObject *parent, FileSetInterface* fileSetInterface, const QStringList& items = QStringList()); @@ -45,8 +45,8 @@ class FileSetRefModel : public ListManagerModel /*! * Get the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; diff --git a/editors/ComponentEditor/itemeditor.h b/editors/ComponentEditor/itemeditor.h index fa291cdb5..a93be9e65 100644 --- a/editors/ComponentEditor/itemeditor.h +++ b/editors/ComponentEditor/itemeditor.h @@ -33,9 +33,9 @@ class ItemEditor : public QWidget /*! * The constructor. * - * @param [in] component Pointer to the component instance that is being edited. - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] component Pointer to the component instance that is being edited. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the owner of this widget. */ ItemEditor(QSharedPointer component, LibraryInterface* handler, QWidget *parent = 0); @@ -45,7 +45,7 @@ class ItemEditor : public QWidget /*! * Allows/disallows the editor change. * - * @return True, if this editor can be hidden without consequences. Otherwise false. + * @return True, if this editor can be hidden without consequences. Otherwise false. */ virtual bool confirmEditorChange(); @@ -60,7 +60,7 @@ class ItemEditor : public QWidget * The base class implementation enables/disables the editor widget. Override to e.g. enable/disable * individual editor tabs. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); @@ -74,7 +74,7 @@ class ItemEditor : public QWidget /*! * Emitted when the contents of the widget change. * - * @param [in] change This is set just for convenience so this signal can be connected directly to + * @param [in] change This is set just for convenience so this signal can be connected directly to * a widget to set it enabled. This should always be set to true. */ void contentChanged(); @@ -96,44 +96,44 @@ class ItemEditor : public QWidget /*! * Emitted when the editor adds a new item that should be shown in navigation tree. * - * @param [in] index The index of the added item. + * @param [in] index The index of the added item. */ void childAdded(int index); /*! * Emitted when the editor removes a child that should also be removed from navigation tree. * - * @param [in] index The index of the removed item. + * @param [in] index The index of the removed item. */ void childRemoved(int index); /*! * Emitted when the editor moves child from one position to another. * - * @param [in] source The index of the moved item. - * @param [in] target The index to move the child to. + * @param [in] source The index of the moved item. + * @param [in] target The index to move the child to. */ void childMoved(int source, int target); /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString id); /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] containingID ID for the vendor extensions editor. - * @param [in] extensionItem The item containing the selected vendor extensions. + * @param [in] containingID ID for the vendor extensions editor. + * @param [in] extensionItem The item containing the selected vendor extensions. */ void changeVendorExtensions(QString const& containingID, QSharedPointer extensionItem); @@ -142,7 +142,7 @@ class ItemEditor : public QWidget /*! * Get the the component pointer from the base-class. * - * @return Pointer to the component model that is being edited + * @return Pointer to the component model that is being edited */ QSharedPointer component() const; @@ -150,7 +150,7 @@ class ItemEditor : public QWidget /*! * Get pointer to the instance managing the library. * - * @return Pointer to the instance managing the library. + * @return Pointer to the instance managing the library. */ LibraryInterface* handler() const; diff --git a/editors/ComponentEditor/itemvisualizer.h b/editors/ComponentEditor/itemvisualizer.h index 09647673e..b0a07fac1 100644 --- a/editors/ComponentEditor/itemvisualizer.h +++ b/editors/ComponentEditor/itemvisualizer.h @@ -26,7 +26,7 @@ class ItemVisualizer : public QWidget /*! The constructor * - * @param [in] parent The parent widget of the visualizer. + * @param [in] parent The parent widget of the visualizer. */ ItemVisualizer(QWidget* parent = 0); diff --git a/editors/ComponentEditor/memoryMaps/AccessPoliciesDelegate.h b/editors/ComponentEditor/memoryMaps/AccessPoliciesDelegate.h index d4bc57ea4..da1e0342a 100644 --- a/editors/ComponentEditor/memoryMaps/AccessPoliciesDelegate.h +++ b/editors/ComponentEditor/memoryMaps/AccessPoliciesDelegate.h @@ -30,37 +30,37 @@ class AccessPoliciesDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const override; /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const override; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override; /*! * Updates the editor geometry for a given index. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option, const QModelIndex& index) const override; diff --git a/editors/ComponentEditor/memoryMaps/AccessPoliciesModel.h b/editors/ComponentEditor/memoryMaps/AccessPoliciesModel.h index f15ae78a1..f5e630e6e 100644 --- a/editors/ComponentEditor/memoryMaps/AccessPoliciesModel.h +++ b/editors/ComponentEditor/memoryMaps/AccessPoliciesModel.h @@ -33,59 +33,59 @@ class AccessPoliciesModel : public QAbstractTableModel /*! * Get the number of access policies the model contains. * - * @param [in] parent Identifies the parent whose row count is requested. + * @param [in] parent Identifies the parent whose row count is requested. * - * @return Number of rows the model has. + * @return Number of rows the model has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the model has to be displayed. * - * @param [in] parent Identifies the parent whose column count is requested. + * @param [in] parent Identifies the parent whose column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specifying the possible operations for the item. + * @return Qt::ItemFlags specifying the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant containing the requested data. + * @return QVariant containing the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant containing the data for the item. + * @return QVariant containing the data for the item. */ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); @@ -106,14 +106,14 @@ public slots: /*! * Handler for adding a new field access policy. * - * @param [in] index The model index of the item that was selected. + * @param [in] index The model index of the item that was selected. */ void onAddRow(QModelIndex const& index); /*! * Handler for removing a field access policy. * - * @param [in] index The model index for the item/row to be removed. + * @param [in] index The model index for the item/row to be removed. */ void onRemoveItem(QModelIndex const& index); @@ -122,18 +122,18 @@ public slots: /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Validates the data in the index. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/memoryMaps/ExpressionProxyModel.h b/editors/ComponentEditor/memoryMaps/ExpressionProxyModel.h index 45cca7fe6..a2b14f9e6 100644 --- a/editors/ComponentEditor/memoryMaps/ExpressionProxyModel.h +++ b/editors/ComponentEditor/memoryMaps/ExpressionProxyModel.h @@ -28,7 +28,7 @@ class ExpressionProxyModel : public QSortFilterProxyModel /*! The constructor * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ExpressionProxyModel(QSharedPointer expressionParser, QObject *parent); @@ -38,7 +38,7 @@ class ExpressionProxyModel : public QSortFilterProxyModel /*! * Sets a column to accept expressions and to be compared by the expression value. * - * @param [in] column The column to set as expression column. + * @param [in] column The column to set as expression column. */ void setColumnToAcceptExpressions(int column); @@ -46,10 +46,10 @@ class ExpressionProxyModel : public QSortFilterProxyModel /*! Compares two items by value. * - * @param left [in] Index identifying the left item. - * @param right [in] Index identifying the right item. + * @param left [in] Index identifying the left item. + * @param right [in] Index identifying the right item. * - * @return True, if left < right, otherwise false. + * @return True, if left < right, otherwise false. */ virtual bool lessThan(QModelIndex const& left, QModelIndex const& right) const; diff --git a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesDelegate.h b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesDelegate.h index 1b781a090..40545a55e 100644 --- a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesDelegate.h +++ b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesDelegate.h @@ -27,10 +27,10 @@ class FieldAccessPoliciesDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] modeRefInterface The interface to access mode references. - * @param [in] parent The parent object. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] modeRefInterface The interface to access mode references. + * @param [in] parent The parent object. */ FieldAccessPoliciesDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, ModeReferenceInterface* modeRefInterface, @@ -44,37 +44,37 @@ class FieldAccessPoliciesDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const override; /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const override; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const override; /*! * Updates the editor geometry for a given index. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option, const QModelIndex& index) const override; @@ -90,9 +90,9 @@ protected slots: /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const override; diff --git a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesEditor.h b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesEditor.h index 89ae6a81f..f269912d2 100644 --- a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesEditor.h +++ b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesEditor.h @@ -49,14 +49,14 @@ class FieldAccessPoliciesEditor : public QGroupBox /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesModel.h b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesModel.h index 92e425b67..e29b81e61 100644 --- a/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesModel.h +++ b/editors/ComponentEditor/memoryMaps/FieldAccessPoliciesModel.h @@ -26,11 +26,11 @@ class FieldAccessPoliciesModel : public ReferencingTableModel, public Parameteri /*! * The constructor. * - * @param [in] fieldName The name of the field being edited. - * @param [in] parameterFinder Parameter finder to use. - * @param [in] fieldInterface Field interface to access field data. - * @param [in] expressionParser Expression parser to use. - * @param [in] parent Parent object. + * @param [in] fieldName The name of the field being edited. + * @param [in] parameterFinder Parameter finder to use. + * @param [in] fieldInterface Field interface to access field data. + * @param [in] expressionParser Expression parser to use. + * @param [in] parent Parent object. */ FieldAccessPoliciesModel(QString const& fieldName, QSharedPointer parameterFinder, FieldInterface* fieldInterface, QSharedPointer expressionParser, QObject* parent); @@ -43,66 +43,66 @@ class FieldAccessPoliciesModel : public ReferencingTableModel, public Parameteri /*! * Get the number of access policies the model contains. * - * @param [in] parent Identifies the parent whose row count is requested. + * @param [in] parent Identifies the parent whose row count is requested. * - * @return Number of rows the model has. + * @return Number of rows the model has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the model has to be displayed. * - * @param [in] parent Identifies the parent whose column count is requested. + * @param [in] parent Identifies the parent whose column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specifying the possible operations for the item. + * @return Qt::ItemFlags specifying the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant containing the requested data. + * @return QVariant containing the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant containing the data for the item. + * @return QVariant containing the data for the item. */ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -111,21 +111,21 @@ public slots: /*! * Handler for adding a new field access policy. * - * @param [in] index The model index of the item that was selected. + * @param [in] index The model index of the item that was selected. */ void onAddRow(QModelIndex const& index); /*! * Handler for removing a field access policy. * - * @param [in] index The model index for the item/row to be removed. + * @param [in] index The model index for the item/row to be removed. */ void onRemoveItem(QModelIndex const& index); /*! * Copy the items in the selected rows. * - * @param [in] indices List of indexes pointing to the selected rows. + * @param [in] indices List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList const& indices); @@ -151,17 +151,17 @@ public slots: /*! * Get all the references made to the selected parameter from the selected row. * - * @param [in] row The selected row. - * @param [in] valueID The target parameter. + * @param [in] row The selected row. + * @param [in] valueID The target parameter. * - * @return Number of references made to the selected id from the selected row. + * @return Number of references made to the selected id from the selected row. */ int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * * return True, if column can have expressions, false otherwise. */ @@ -170,7 +170,7 @@ public slots: /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return Expression in the given index, or plain value. */ @@ -179,7 +179,7 @@ public slots: /*! * Validates the data in the cell given by the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * * return True, if the data in the parameter is valid, false otherwise. */ @@ -194,9 +194,9 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ QVariant formattedExpressionForIndex(QModelIndex const& index) const; @@ -204,7 +204,7 @@ public slots: * Increase the references of the parameters in a field access policy given by row, when copy pasting a * the field access policy. * - * @param [in] row Description + * @param [in] row Description */ void increaseReferencesInFieldAccessPolicy(int const& row); diff --git a/editors/ComponentEditor/memoryMaps/MemoryBlockDelegate.h b/editors/ComponentEditor/memoryMaps/MemoryBlockDelegate.h index c6dfebbb9..b8ed8f2ba 100644 --- a/editors/ComponentEditor/memoryMaps/MemoryBlockDelegate.h +++ b/editors/ComponentEditor/memoryMaps/MemoryBlockDelegate.h @@ -27,9 +27,9 @@ class MemoryBlockDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder for expression editor. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder for expression editor. + * @param [in] parent Pointer to the owner of the delegate. */ MemoryBlockDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -42,11 +42,11 @@ class MemoryBlockDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -56,9 +56,9 @@ class MemoryBlockDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True if the cells in the column allow expressions, otherwise false. + * @return True if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; @@ -78,32 +78,32 @@ private slots: /*! * Get the column for block name. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const = 0; /*! * Get the column for block base address. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const = 0; /*! * Get the column for block is present. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const = 0; /*! * Creates an editor for name. * - * @param [in] parent The parent widget for the editor. - * @param [in] option The style options for the editor. - * @param [in] index The index for which the editor is created. + * @param [in] parent The parent widget for the editor. + * @param [in] option The style options for the editor. + * @param [in] index The index for which the editor is created. * - * @return Editor for editing name. + * @return Editor for editing name. */ QWidget* createNameEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; }; diff --git a/editors/ComponentEditor/memoryMaps/MemoryBlockFilter.h b/editors/ComponentEditor/memoryMaps/MemoryBlockFilter.h index a5bb5e756..260a61aab 100644 --- a/editors/ComponentEditor/memoryMaps/MemoryBlockFilter.h +++ b/editors/ComponentEditor/memoryMaps/MemoryBlockFilter.h @@ -32,9 +32,9 @@ class MemoryBlockFilter : public ExpressionProxyModel /*! * Constructor. * - * @param [in] parser The expression parser. - * @param [in] blockInterface Interface for accessing memory blocks. - * @param [in] parent The parent object. + * @param [in] parser The expression parser. + * @param [in] blockInterface Interface for accessing memory blocks. + * @param [in] parent The parent object. */ MemoryBlockFilter(QSharedPointer parser, MemoryBlockInterface* blockInterface, QObject* parent = 0); @@ -53,10 +53,10 @@ class MemoryBlockFilter : public ExpressionProxyModel /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const override; diff --git a/editors/ComponentEditor/memoryMaps/MemoryBlockModel.h b/editors/ComponentEditor/memoryMaps/MemoryBlockModel.h index 2c0738bd9..f8de0d8a7 100644 --- a/editors/ComponentEditor/memoryMaps/MemoryBlockModel.h +++ b/editors/ComponentEditor/memoryMaps/MemoryBlockModel.h @@ -36,11 +36,11 @@ class MemoryBlockModel : public ReferencingTableModel, public ParameterizableTab /*! * The constructor. * - * @param [in] blockInterface Interface for memory blocks; - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent Pointer to the owner of this model. + * @param [in] blockInterface Interface for memory blocks; + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent Pointer to the owner of this model. */ MemoryBlockModel(MemoryBlockInterface* blockInterface, QSharedPointer expressionParser, @@ -61,66 +61,66 @@ class MemoryBlockModel : public ReferencingTableModel, public ParameterizableTab /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const override final; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const = 0; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const = 0; @@ -130,28 +130,28 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ void onRemoveItem(QModelIndex const& index); /*! * Change the current address unit bits. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void addressUnitBitsUpdated(QString const& newAddressUnitBits); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -165,55 +165,55 @@ public slots: /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return Expression or plain value in the given index. + * @return Expression or plain value in the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * validates the data in the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made on the selected row to the selected parameter. * - * @param [in] row The row of the selected item. - * @param [in] valueID The referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The referenced parameter. * - * @return The number of references made to the parameter on the selected row. + * @return The number of references made to the parameter on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant valueForIndex(QModelIndex const& index) const; @@ -234,29 +234,29 @@ public slots: /*! * Informs of a need to redraw the visualization. * - * @param [in] index Index of the memory block graphics item. + * @param [in] index Index of the memory block graphics item. */ void graphicsChanged(int index); /*! * Emitted when a new memory map item is added to the given index. * - * @param [in] index Index of the new memory block item. + * @param [in] index Index of the new memory block item. */ void itemAdded(int index); /*! * Emitted when a memory map item is removed from the given index. * - * @param [in] index Index of the removed memory block item. + * @param [in] index Index of the removed memory block item. */ void itemRemoved(int index); /* * Informs of memory block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void blockNameChanged(QString const& oldName, QString const& newName); @@ -268,7 +268,7 @@ public slots: /*! * Informs of addressing changes in child items. * - * @param [in] Index of the selected address block. + * @param [in] Index of the selected address block. */ void childAddressingChanged(int); @@ -277,35 +277,35 @@ public slots: /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const = 0; /*! * Get the index of the base address column. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const = 0; /*! * Get the index of the is present column. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const = 0; /*! * Get the index of the description column. * - * @return Index of the description column. + * @return Index of the description column. */ virtual int descriptionColumn() const = 0; /*! * Increase the number of references made in the selected expressions. * - * @param [in] expressionList List of expressions. + * @param [in] expressionList List of expressions. */ void increaseReferencesInPastedExpressions(QStringList const& expressionList); diff --git a/editors/ComponentEditor/memoryMaps/MemoryMapsView.h b/editors/ComponentEditor/memoryMaps/MemoryMapsView.h index 35c10c25c..cca251a2d 100644 --- a/editors/ComponentEditor/memoryMaps/MemoryMapsView.h +++ b/editors/ComponentEditor/memoryMaps/MemoryMapsView.h @@ -26,7 +26,7 @@ class MemoryMapsView : public EditableTreeView /*! * The constructor. * - * @param [in] parent Pointer to the owner of this view. + * @param [in] parent Pointer to the owner of this view. */ MemoryMapsView(QWidget* parent); @@ -42,7 +42,7 @@ class MemoryMapsView : public EditableTreeView /*! * Enable/disable the import/export csv-file functionality. * - * @param [in] allow If true, then import/export is enabled. + * @param [in] allow If true, then import/export is enabled. */ void setAllowImportExport(bool allow); @@ -51,21 +51,21 @@ public slots: /*! * Create a csv-file of the editor contents. * - * @param [in] filePath Contains an absolute file path to the file to create. + * @param [in] filePath Contains an absolute file path to the file to create. */ void onCSVExport(const QString& filePath = QString()); /*! * Import contents of a csv-file to the editor. * - * @param [in] filePath The path to the csv-file to import. + * @param [in] filePath The path to the csv-file to import. */ void onCSVImport(const QString& filePath = QString()); /*! * Set the default path to use for import/export csv. * - * @param [in] path The path to tuse ad default. + * @param [in] path The path to tuse ad default. */ void setDefaultImportExportPath(const QString& path); @@ -74,14 +74,14 @@ public slots: /*! * Copy the selected rows. * - * @param [in] indexList List of selected indexes containing the copied rows. + * @param [in] indexList List of selected indexes containing the copied rows. */ void copyRows(QModelIndexList indexList); /*! * Paste the copied rows. * - * @param [in] targetIndex The target of the paste action. + * @param [in] targetIndex The target of the paste action. */ void pasteRows(QModelIndex targetIndex); @@ -90,14 +90,14 @@ public slots: /*! * Handles keypress events for copy, paste, cut, delete and line separator insertion. * - * @param [in] event The key event. + * @param [in] event The key event. */ virtual void keyPressEvent(QKeyEvent* event) override final; /*! * Creates a context menu for adding/removing/editing items in the editor. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event) override final; @@ -133,10 +133,10 @@ private slots: /*! * Generates a unique name within the table for the item. * - * @param [in] original The original name of the item. - * @param [in] model The model of this view. + * @param [in] original The original name of the item. + * @param [in] model The model of this view. * - * @return Unique name for the item. + * @return Unique name for the item. */ QString getUniqueName(QString const& original, QAbstractItemModel* model); diff --git a/editors/ComponentEditor/memoryMaps/RemapModeReferenceEditor.h b/editors/ComponentEditor/memoryMaps/RemapModeReferenceEditor.h index e3701fb1c..c76f3e891 100644 --- a/editors/ComponentEditor/memoryMaps/RemapModeReferenceEditor.h +++ b/editors/ComponentEditor/memoryMaps/RemapModeReferenceEditor.h @@ -30,8 +30,8 @@ class RemapModeReferenceEditor : public GroupBoxWithAlertSign /*! * The constructor. * - * @param [in] modeRefInterface The mode reference interface to use. - * @param [in] parent The parent widget. + * @param [in] modeRefInterface The mode reference interface to use. + * @param [in] parent The parent widget. */ RemapModeReferenceEditor(ModeReferenceInterface* modeRefInterface, QWidget* parent, bool isRemap); diff --git a/editors/ComponentEditor/memoryMaps/ResetsDelegate.h b/editors/ComponentEditor/memoryMaps/ResetsDelegate.h index 1c15377f4..b6346fe62 100644 --- a/editors/ComponentEditor/memoryMaps/ResetsDelegate.h +++ b/editors/ComponentEditor/memoryMaps/ResetsDelegate.h @@ -33,10 +33,10 @@ class ResetsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for expression editor. - * @param [in] resetTypes The reset types of the containing component. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for expression editor. + * @param [in] resetTypes The reset types of the containing component. + * @param [in] parent Pointer to the owner of the delegate. */ ResetsDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QSharedPointer > > resetTypes, QObject *parent); @@ -49,11 +49,11 @@ class ResetsDelegate : public ExpressionDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -61,17 +61,17 @@ class ResetsDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; @@ -80,9 +80,9 @@ class ResetsDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True if the cells in the column allow expressions, otherwise false. + * @return True if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; @@ -107,9 +107,9 @@ private slots: /*! * Create the combo box for reset type reference editor. * - * @param [in] parent Parent for the editor. + * @param [in] parent Parent for the editor. * - * @return Pointer to the created reset type reference editor. + * @return Pointer to the created reset type reference editor. */ QComboBox* createResetTypeCombo(QWidget* parent) const; diff --git a/editors/ComponentEditor/memoryMaps/ResetsEditor.h b/editors/ComponentEditor/memoryMaps/ResetsEditor.h index 5129d4e60..03544f903 100644 --- a/editors/ComponentEditor/memoryMaps/ResetsEditor.h +++ b/editors/ComponentEditor/memoryMaps/ResetsEditor.h @@ -43,12 +43,12 @@ class ResetsEditor : public QGroupBox /*! * The constructor. * - * @param [in] resetInterface Interface for resets. - * @param [in] resetTypes List of reset types within the containing component. - * @param [in] expressionParser The expression parser. - * @param [in] parameterFinder Component parameter finder. - * @param [in] containingField Field containing the resets. - * @param [in] parent Pointer to the parent of this editor. + * @param [in] resetInterface Interface for resets. + * @param [in] resetTypes List of reset types within the containing component. + * @param [in] expressionParser The expression parser. + * @param [in] parameterFinder Component parameter finder. + * @param [in] containingField Field containing the resets. + * @param [in] parent Pointer to the parent of this editor. */ ResetsEditor(ResetInterface* resetInterface, QSharedPointer > > resetTypes, QSharedPointer expressionParser, QSharedPointer parameterFinder, @@ -74,14 +74,14 @@ class ResetsEditor : public QGroupBox /*! * Increase the number of references made to the selected parameter. * - * @param [in] id ID of the selected parameter. + * @param [in] id ID of the selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references made to the selected parameter. * - * @param [in] id ID of the selected parameter. + * @param [in] id ID of the selected parameter. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/memoryMaps/ResetsModel.h b/editors/ComponentEditor/memoryMaps/ResetsModel.h index aa53a731d..2bb983296 100644 --- a/editors/ComponentEditor/memoryMaps/ResetsModel.h +++ b/editors/ComponentEditor/memoryMaps/ResetsModel.h @@ -34,10 +34,10 @@ class ResetsModel : public ReferencingTableModel, public ParameterizableTable /*! * The constructor. * - * @param [in] resetInterface Interface for resets. - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] parent Pointer to the owner of the model. + * @param [in] resetInterface Interface for resets. + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] parent Pointer to the owner of the model. */ ResetsModel(ResetInterface* resetInterface, QSharedPointer expressionParser, QSharedPointer parameterFinder, QObject *parent); @@ -50,59 +50,59 @@ class ResetsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); @@ -111,37 +111,37 @@ class ResetsModel : public ReferencingTableModel, public ParameterizableTable /*! * Check if the column index is valid for expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, otherwise false. + * @return True, if column can have expressions, otherwise false. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return Expression or plain value in the given index. + * @return Expression or plain value in the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made on the selected row to the selected parameter. * - * @param [in] row The row of the selected item. - * @param [in] valueID The selected parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The selected parameter. * - * @return The amount of references made on the selected row to the selected parameter. + * @return The amount of references made on the selected row to the selected parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -150,14 +150,14 @@ class ResetsModel : public ReferencingTableModel, public ParameterizableTable /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); @@ -177,27 +177,27 @@ class ResetsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/memoryMaps/SingleAddressBlockEditor.h b/editors/ComponentEditor/memoryMaps/SingleAddressBlockEditor.h index 8bada42a1..d7faccc2c 100644 --- a/editors/ComponentEditor/memoryMaps/SingleAddressBlockEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleAddressBlockEditor.h @@ -49,16 +49,16 @@ class SingleAddressBlockEditor : public ItemEditor /*! * The constructor. * - * @param [in] blockInterface Interface for address blocks. - * @param [in] addressBlock The address block being edited. - * @param [in] containingMap Memory map item containing the edited address block. - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] addressBlockValidator Validator used for address blocks. - * @param [in] parent The parent of this editor. + * @param [in] blockInterface Interface for address blocks. + * @param [in] addressBlock The address block being edited. + * @param [in] containingMap Memory map item containing the edited address block. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] parent The parent of this editor. */ SingleAddressBlockEditor(AddressBlockInterface* blockInterface, QSharedPointer addressBlock, @@ -92,8 +92,8 @@ public slots: /* * Handles addressblock name change from memory map editor. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onAddressBlockNameChanged(QString const& oldName, QString const& newName); @@ -107,15 +107,15 @@ public slots: /*! * Change the value for address unit bits in the model. * - * @param [in] newAddressUnitBits The new address unit bits value. + * @param [in] newAddressUnitBits The new address unit bits value. */ void addressUnitBitsChanged(int newAddressUnitBits); /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); @@ -130,7 +130,7 @@ public slots: /*! * Shows the widget and informs of the required help document. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event) override final; @@ -157,21 +157,21 @@ private slots: /*! * Sets the value in the usage editor. * - * @param [in] newUsage The selected usage. + * @param [in] newUsage The selected usage. */ void onUsageSelected(QString const& newUsage); /*! * Sets the value in the access editor. * - * @param [in] newAccess The selected access. + * @param [in] newAccess The selected access. */ void onAccessSelected(QString const& newAccess); /*! * Sets the value in the volatile editor. * - * @param [in] newVolatileValue The selected volatile status. + * @param [in] newVolatileValue The selected volatile status. */ void onVolatileSelected(QString const& newVolatileValue); @@ -190,16 +190,16 @@ private slots: /*! * Change the status of signal blocking in all the expression editors. * - * @param [in] blockStatus The new signal blocking status. + * @param [in] blockStatus The new signal blocking status. */ void changeExpressionEditorSignalBlockStatus(bool blockStatus); /*! * Calculates the value of an expression. * - * @param [in] expression The expression, whose value is to be calculated. + * @param [in] expression The expression, whose value is to be calculated. * - * @return The calculated value of the given expression. + * @return The calculated value of the given expression. */ QString formattedValueFor(QString const& expression) const; diff --git a/editors/ComponentEditor/memoryMaps/SingleFieldEditor.h b/editors/ComponentEditor/memoryMaps/SingleFieldEditor.h index 5ee78d56b..9f4ed95fb 100644 --- a/editors/ComponentEditor/memoryMaps/SingleFieldEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleFieldEditor.h @@ -50,15 +50,15 @@ class SingleFieldEditor : public ItemEditor /*! * The constructor. * - * @param [in] fieldItem The field being edited. - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder The instance for finding parameter references. - * @param [in] expressionParser The expression parser to use. - * @param [in] fieldValidator The used field validator. - * @param [in] fieldInterface Interface for fields. - * @param [in] containingRegister Register containing the edited field. - * @param [in] parent The parent of this editor. + * @param [in] fieldItem The field being edited. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder The instance for finding parameter references. + * @param [in] expressionParser The expression parser to use. + * @param [in] fieldValidator The used field validator. + * @param [in] fieldInterface Interface for fields. + * @param [in] containingRegister Register containing the edited field. + * @param [in] parent The parent of this editor. */ SingleFieldEditor(QSharedPointer fieldItem, QSharedPointer component, @@ -88,8 +88,8 @@ public slots: /* * Handles field name change from register editor. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onFieldNameChanged(QString const& oldName, QString const& newName); @@ -103,7 +103,7 @@ public slots: /*! * informs of the required help document. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event); @@ -122,42 +122,42 @@ private slots: /*! * Sets the selected volatile value for the field. * - * @param [in] newVolatileValue The selected volatile value. + * @param [in] newVolatileValue The selected volatile value. */ void onVolatileSelected(QString const& newVolatileValue); /*! * Sets the selected access value for the field. * - * @param [in] newAccessValue The selected access value. + * @param [in] newAccessValue The selected access value. */ void onAccessSelected(QString const& newAccessValue); /*! * Sets the selected modified write value for the field. * - * @param [in] newModWriteValue The selected modified write value. + * @param [in] newModWriteValue The selected modified write value. */ void onModifiedWriteSelected(QString const& newModWriteValue); /*! * Sets the selected read action value for the field. * - * @param [in] newReadActionValue The selected read action value. + * @param [in] newReadActionValue The selected read action value. */ void onReadActionSelected(QString const& newReadActionValue); /*! * Sets the selected testable value for the field. * - * @param [in] newTestableValue The selected testable value. + * @param [in] newTestableValue The selected testable value. */ void onTestableSelected(QString const& newTestableValue); /*! * Sets the selected test constrained value for the field. * - * @param [in] newTestConstrainedValue The selected test constrained value. + * @param [in] newTestConstrainedValue The selected test constrained value. */ void onTestConstrainedSelected(QString const& newTestConstrainedValue); @@ -179,21 +179,21 @@ private slots: /*! * Sets the selected write constraint value for the field. * - * @param [in] newIndex The index of the selected write constraint value. + * @param [in] newIndex The index of the selected write constraint value. */ void onWriteConstraintSelected(int newIndex); /*! * Sets the edited write constraint minimum value for the field. * - * @param [in] newWriteConstraintMin The edited write constraint minimum value. + * @param [in] newWriteConstraintMin The edited write constraint minimum value. */ void onWriteConstraintMinimumEdited(); /*! * Sets the edited write constraint maximum value for the field. * - * @param [in] newWriteConstraintMax The edited write constraint maximum value. + * @param [in] newWriteConstraintMax The edited write constraint maximum value. */ void onWriteConstraintMaximumEdited(); @@ -206,23 +206,23 @@ private slots: /*! * Change the signal blocking status of the expression editors in this editor. * - * @param [in] blockStatus The new signal blocking status for the expression editors. + * @param [in] blockStatus The new signal blocking status for the expression editors. */ void changeExpressionEditorSignalBlockStatus(bool blockStatus) const; /*! * Calculates the value of an expression. * - * @param [in] expression The expression to be calculated. + * @param [in] expression The expression to be calculated. * - * @return The calculated value of an expression. + * @return The calculated value of an expression. */ QString formattedValueFor(QString const& expression) const; /*! * Set the status of write constraint minimum and maximum editors. * - * @param [in] writeConstraintIndex The index of the write constraint value. + * @param [in] writeConstraintIndex The index of the write constraint value. */ void setWriteMinMaxConstraintEnableStatus(int writeConstraintIndex) const; diff --git a/editors/ComponentEditor/memoryMaps/SingleMemoryMapEditor.h b/editors/ComponentEditor/memoryMaps/SingleMemoryMapEditor.h index 6d13c62bc..3d0c99cf7 100644 --- a/editors/ComponentEditor/memoryMaps/SingleMemoryMapEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleMemoryMapEditor.h @@ -45,15 +45,15 @@ class SingleMemoryMapEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component that contains the editor. - * @param [in] memoryRemap The memory remap being edited. - * @param [in] parentMapName Name of the parent of the memory remap being edited. - * @param [in] libHandler The instance that manages the library. - * @param [in] parameterFinder The finder for the parameter references. - * @param [in] expressionParser The expression parser. - * @param [in] mapInterface Interface for memory maps. - * @param [in] isMemoryRemap Flag for informing if the edited item is a memory map or a remap. - * @param [in] parent The owner of this editor. + * @param [in] component The component that contains the editor. + * @param [in] memoryRemap The memory remap being edited. + * @param [in] parentMapName Name of the parent of the memory remap being edited. + * @param [in] libHandler The instance that manages the library. + * @param [in] parameterFinder The finder for the parameter references. + * @param [in] expressionParser The expression parser. + * @param [in] mapInterface Interface for memory maps. + * @param [in] isMemoryRemap Flag for informing if the edited item is a memory map or a remap. + * @param [in] parent The owner of this editor. */ SingleMemoryMapEditor(QSharedPointer component, QSharedPointer memoryRemap, @@ -80,17 +80,17 @@ public slots: /* * Handles memory map name change from memory maps editor. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onMemoryMapNameChanged(QString const& oldName, QString const& newName); /* * Handles of memory remap name change from memory maps editor. * - * @param [in] parentName Name of the containing memory map. - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] parentName Name of the containing memory map. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onMemoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); @@ -104,7 +104,7 @@ public slots: /*! * The show event for this editor. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent * event); @@ -126,7 +126,7 @@ private slots: /*! * Sets the new remap state to the memory remap. * - * @param [in] newRemapState The name of the selected remap state. + * @param [in] newRemapState The name of the selected remap state. */ void onRemapStateSelected(QString const& newRemapState); @@ -145,37 +145,37 @@ private slots: /*! * Emitted when address unit bits are changed for memory map. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); /* * Informs of address block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void addressBlockNameChanged(QString const& oldName, QString const& newName); /*! * Informs of subspace map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void subspaceMapNameChanged(QString const& oldName, QString const& newName); /*! * Informs change in child addressing. * - * @param [in] + * @param [in] */ void childAddressingChanged(int); /*! * Informs change in child graphics. * - * @param [in] + * @param [in] */ void childGraphicsChanged(int); diff --git a/editors/ComponentEditor/memoryMaps/SingleRegisterEditor.h b/editors/ComponentEditor/memoryMaps/SingleRegisterEditor.h index 3c151e30b..e81cf0a9c 100644 --- a/editors/ComponentEditor/memoryMaps/SingleRegisterEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleRegisterEditor.h @@ -47,14 +47,14 @@ class SingleRegisterEditor : public ItemEditor /*! * The constructor. * - * @param [in] selectedRegister The register being edited. - * @param [in] component The component being edited. - * @param [in] handler The instance that manages the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser to use. - * @param [in] registerInterface Interface for registers. - * @param [in] containingRegisterData Register data containing the edited register. - * @param [in] parent The parent of this editor. + * @param [in] selectedRegister The register being edited. + * @param [in] component The component being edited. + * @param [in] handler The instance that manages the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser to use. + * @param [in] registerInterface Interface for registers. + * @param [in] containingRegisterData Register data containing the edited register. + * @param [in] parent The parent of this editor. */ SingleRegisterEditor(QSharedPointer selectedRegister, QSharedPointer component, @@ -91,8 +91,8 @@ class SingleRegisterEditor : public ItemEditor /* * Informs of field name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void fieldNameChanged(QString const& oldName, QString const& newName); @@ -102,8 +102,8 @@ public slots: /* * Handles register name change from address block editor. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onRegisterNameChanged(QString const& oldName, QString const& newName); @@ -117,7 +117,7 @@ public slots: /*! * After a show event, fetches the help file for the editor. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event); @@ -146,14 +146,14 @@ private slots: /*! * Save the selected volatile value to the register. * - * @param [in] newVolatileValue The new volatile value. + * @param [in] newVolatileValue The new volatile value. */ void onVolatileSelected(QString const& newVolatileValue); /*! * Save the selected access value to the register. * - * @param [in] newAccessValue The new access value. + * @param [in] newAccessValue The new access value. */ void onAccessSelected(QString const& newAccessValue); @@ -172,16 +172,16 @@ private slots: /*! * Calculate the value for the expression. * - * @param [in] expression The expression to be calculated. + * @param [in] expression The expression to be calculated. * - * @return The calculated value of the expression. + * @return The calculated value of the expression. */ QString formattedValueFor(QString const& expression) const; /*! * Change the signal blocking status of the expression editors. * - * @param [in] blockStatus The new status of signal blocking. + * @param [in] blockStatus The new status of signal blocking. */ void changeExpressionEditorsSignalBlockStatus(bool blockStatus) const; diff --git a/editors/ComponentEditor/memoryMaps/SingleRegisterFileEditor.h b/editors/ComponentEditor/memoryMaps/SingleRegisterFileEditor.h index 282ca7249..1130bb24a 100644 --- a/editors/ComponentEditor/memoryMaps/SingleRegisterFileEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleRegisterFileEditor.h @@ -41,14 +41,14 @@ class SingleRegisterFileEditor : public ItemEditor /*! * The constructor. * - * @param [in] registerInterface Interface for registers. - * @param [in] registerFile The register file to edit. - * @param [in] component The component containing the register file. - * @param [in] handler The available IP-XACT library. - * @param [in] parameterFinder Finder for parameters. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] registerFileValidator Validator for register files. - * @param [in] parent The parent widget. + * @param [in] registerInterface Interface for registers. + * @param [in] registerFile The register file to edit. + * @param [in] component The component containing the register file. + * @param [in] handler The available IP-XACT library. + * @param [in] parameterFinder Finder for parameters. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] registerFileValidator Validator for register files. + * @param [in] parent The parent widget. */ SingleRegisterFileEditor(RegisterInterface* registerInterface, QSharedPointer registerFile, @@ -83,8 +83,8 @@ class SingleRegisterFileEditor : public ItemEditor /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); @@ -118,16 +118,16 @@ private slots: /*! * Get the formatted value of a given expression. * - * @param [in] expression The expression to format. + * @param [in] expression The expression to format. * - * @return The formatted value. + * @return The formatted value. */ QString formattedValueFor(QString const& expression) const; /*! * Block/unblock signals from expression editor. * - * @param [in] blockStatus If true, signals are blocked, otherwise signals are enabled. + * @param [in] blockStatus If true, signals are blocked, otherwise signals are enabled. */ void changeExpressionEditorsSignalBlockStatus(bool blockStatus) const; diff --git a/editors/ComponentEditor/memoryMaps/SingleSubspaceMapEditor.h b/editors/ComponentEditor/memoryMaps/SingleSubspaceMapEditor.h index b3214b944..d1aaaf34e 100644 --- a/editors/ComponentEditor/memoryMaps/SingleSubspaceMapEditor.h +++ b/editors/ComponentEditor/memoryMaps/SingleSubspaceMapEditor.h @@ -45,14 +45,14 @@ class SingleSubspaceMapEditor : public ItemEditor /*! * The constructor. * - * @param [in] subspaceInterface Interface for accessing subspace maps. - * @param [in] subspaceMap The subspace map being edited. - * @param [in] containingMap Memory map containing the edited address block. - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] parent The parent of this editor. + * @param [in] subspaceInterface Interface for accessing subspace maps. + * @param [in] subspaceMap The subspace map being edited. + * @param [in] containingMap Memory map containing the edited address block. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] parent The parent of this editor. */ SingleSubspaceMapEditor(SubspaceMapInterface* subspaceInterface, QSharedPointer subspaceMap, @@ -82,8 +82,8 @@ public slots: /* * Handles subspace map name change from memory map editor. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onSubspaceNameChanged(QString const& oldName, QString const& newName); @@ -109,7 +109,7 @@ public slots: /*! * Shows the widget and informs of the required help document. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent* event) override final; @@ -128,14 +128,14 @@ private slots: /*! * Handle the change in master bus interface reference. * - * @param [in] newMasterReference The new master bus interface reference. + * @param [in] newMasterReference The new master bus interface reference. */ void onMasterSelected(QString const& newMasterReference); /*! * Handle the change in segment reference. * - * @param [in] newSegment The new segment reference. + * @param [in] newSegment The new segment reference. */ void onSegmentSelected(QString const& newSegment); @@ -149,9 +149,9 @@ private slots: /*! * Get the address space of the selected bus interface. * - * @param [in] busReference Name of the selected bus interface. + * @param [in] busReference Name of the selected bus interface. * - * @return Address space of the selected bus interface. + * @return Address space of the selected bus interface. */ QSharedPointer getSpace(QString const& busReference); @@ -168,16 +168,16 @@ private slots: /*! * Change the status of signal blocking in all the expression editors. * - * @param [in] blockStatus The new signal blocking status. + * @param [in] blockStatus The new signal blocking status. */ void changeExpressionEditorSignalBlockStatus(bool blockStatus); /*! * Calculates the value of an expression. * - * @param [in] expression The expression, whose value is to be calculated. + * @param [in] expression The expression, whose value is to be calculated. * - * @return The calculated value of the given expression. + * @return The calculated value of the given expression. */ QString formattedValueFor(QString const& expression) const; diff --git a/editors/ComponentEditor/memoryMaps/SubspaceMapDelegate.h b/editors/ComponentEditor/memoryMaps/SubspaceMapDelegate.h index 24d9aa2c2..fe902b506 100644 --- a/editors/ComponentEditor/memoryMaps/SubspaceMapDelegate.h +++ b/editors/ComponentEditor/memoryMaps/SubspaceMapDelegate.h @@ -34,11 +34,11 @@ class SubspaceMapDelegate : public MemoryBlockDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder for expression editor. - * @param [in] subspaceInterface Interface for accessing subspace maps. - * @param [in] docRevision The IP-XACT standard revision to comply to. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder for expression editor. + * @param [in] subspaceInterface Interface for accessing subspace maps. + * @param [in] docRevision The IP-XACT standard revision to comply to. + * @param [in] parent Pointer to the owner of the delegate. */ SubspaceMapDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, SubspaceMapInterface* subspaceInterface, QSharedPointer > > addressSpaces, @@ -56,11 +56,11 @@ class SubspaceMapDelegate : public MemoryBlockDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -68,17 +68,17 @@ class SubspaceMapDelegate : public MemoryBlockDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -94,46 +94,46 @@ class SubspaceMapDelegate : public MemoryBlockDelegate /*! * Get the available initiator/master bus interface names. * - * @return List of initiator/master bus interface names. + * @return List of initiator/master bus interface names. */ QStringList getInitiatorInterfaceNames() const; /*! * Get the list of available segments. * - * @param [in] index Index of the selected subspace map. + * @param [in] index Index of the selected subspace map. * - * @return List of available segments. + * @return List of available segments. */ QStringList getSegmentNames(QModelIndex const& index) const; /*! * Get the address space of the selected bus interface. * - * @param [in] busName Name of the selected bus interface. + * @param [in] busName Name of the selected bus interface. * - * @return Address of the selected bus interface. + * @return Address of the selected bus interface. */ QSharedPointer getAddressSpace(QString const& busName) const; /*! * Get the column for block name. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Get the column for block base address. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const override final; /*! * Get the column for block is present. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const override final; diff --git a/editors/ComponentEditor/memoryMaps/SubspaceMapModel.h b/editors/ComponentEditor/memoryMaps/SubspaceMapModel.h index 5fb8681a3..ffe775ced 100644 --- a/editors/ComponentEditor/memoryMaps/SubspaceMapModel.h +++ b/editors/ComponentEditor/memoryMaps/SubspaceMapModel.h @@ -33,11 +33,11 @@ class SubspaceMapModel : public MemoryBlockModel /*! * The constructor. * - * @param [in] subspaceInterface Interface for accessing subspace maps; - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent Pointer to the owner of this model. + * @param [in] subspaceInterface Interface for accessing subspace maps; + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent Pointer to the owner of this model. */ SubspaceMapModel(SubspaceMapInterface* subspaceInterface, QSharedPointer expressionParser, @@ -57,57 +57,57 @@ class SubspaceMapModel : public MemoryBlockModel /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const override final; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const override final; @@ -116,27 +116,27 @@ class SubspaceMapModel : public MemoryBlockModel /*! * validates the data in the selected index. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const override final; /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant valueForIndex(QModelIndex const& index) const override final; /*! * Checks if the column index is valid for expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if the column can have expressions, otherwise false. + * @return True, if the column can have expressions, otherwise false. */ bool isValidExpressionColumn(QModelIndex const& index) const final; @@ -145,28 +145,28 @@ class SubspaceMapModel : public MemoryBlockModel /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Get the index of the base address column. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const override final; /*! * Get the index of the is present column. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const override final; /*! * Get the index of the description column. * - * @return Index of the description column. + * @return Index of the description column. */ virtual int descriptionColumn() const override final; diff --git a/editors/ComponentEditor/memoryMaps/SubspaceMapsEditor.h b/editors/ComponentEditor/memoryMaps/SubspaceMapsEditor.h index 0b1418558..9d0b0bff4 100644 --- a/editors/ComponentEditor/memoryMaps/SubspaceMapsEditor.h +++ b/editors/ComponentEditor/memoryMaps/SubspaceMapsEditor.h @@ -39,12 +39,12 @@ class SubspaceMapsEditor : public QGroupBox /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder for component. - * @param [in] expressionParser The expression parser. - * @param [in] subspaceMapInterface Interface for accessing subspace maps. - * @param [in] blocks Pointer to the available memory blocks. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder for component. + * @param [in] expressionParser The expression parser. + * @param [in] subspaceMapInterface Interface for accessing subspace maps. + * @param [in] blocks Pointer to the available memory blocks. + * @param [in] parent The parent of this editor. */ SubspaceMapsEditor(QSharedPointer component, QSharedPointer parameterFinder, @@ -78,43 +78,43 @@ class SubspaceMapsEditor : public QGroupBox /*! * Emits an error message for the user. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Emits a notice message for the user. * - * @param [in] msg [Description]. + * @param [in] msg [Description]. */ void noticeMessage(const QString& msg) const; /*! * Increases the number of references to the given parameter. * - * @param [in] id The target parameter. + * @param [in] id The target parameter. */ void increaseReferences(QString id); /*! * Decreases the number of references to the given parameter. * - * @param [in] id The target parameter. + * @param [in] id The target parameter. */ void decreaseReferences(QString id); /*! * Assign new address unit bits for address blocks. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); /* * Informs of address block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void subspaceMapNameChanged(QString const& oldName, QString const& newName); @@ -131,21 +131,21 @@ class SubspaceMapsEditor : public QGroupBox /*! * Informs of an added child. * - * @param [in] index The index of the new child. + * @param [in] index The index of the new child. */ void childAdded(int index); /*! * Informs of a removed child. * - * @param [in] index The index of the removed child. + * @param [in] index The index of the removed child. */ void childRemoved(int index); /*! * Informs of a change in item addressing. * - * @param [in] index Index of the item whose addressing is changed. + * @param [in] index Index of the item whose addressing is changed. */ void childAddressingChanged(int index); diff --git a/editors/ComponentEditor/memoryMaps/WriteValueConstraintComboBox.h b/editors/ComponentEditor/memoryMaps/WriteValueConstraintComboBox.h index 51432096a..2e2c70e89 100644 --- a/editors/ComponentEditor/memoryMaps/WriteValueConstraintComboBox.h +++ b/editors/ComponentEditor/memoryMaps/WriteValueConstraintComboBox.h @@ -29,8 +29,8 @@ class WriteValueConstraintComboBox : public QComboBox /*! * The constructor. * - * @param [in] writeConstraint Pointer to the write constraint being edited. - * @param [in] parent Pointer to the owner of the group box. + * @param [in] writeConstraint Pointer to the write constraint being edited. + * @param [in] parent Pointer to the owner of the group box. */ WriteValueConstraintComboBox(QSharedPointer writeConstraint, QWidget* parent); @@ -46,7 +46,7 @@ class WriteValueConstraintComboBox : public QComboBox /*! * Sets the type for the write constraint. * - * @param [in] newIndex The index of the selected write constraint type. + * @param [in] newIndex The index of the selected write constraint type. */ void onIndexChanged(int newIndex); diff --git a/editors/ComponentEditor/memoryMaps/addressblockdelegate.h b/editors/ComponentEditor/memoryMaps/addressblockdelegate.h index 98a9a5cdf..b0ce10829 100644 --- a/editors/ComponentEditor/memoryMaps/addressblockdelegate.h +++ b/editors/ComponentEditor/memoryMaps/addressblockdelegate.h @@ -28,9 +28,9 @@ class AddressBlockDelegate : public ExpressionDelegate /*! * The constructor * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent Pointer to the owner of this delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent Pointer to the owner of this delegate. */ AddressBlockDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -41,11 +41,11 @@ class AddressBlockDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -53,17 +53,17 @@ class AddressBlockDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -72,9 +72,9 @@ class AddressBlockDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/memoryMaps/addressblockeditor.h b/editors/ComponentEditor/memoryMaps/addressblockeditor.h index 9a7f4ec96..fe8525ace 100644 --- a/editors/ComponentEditor/memoryMaps/addressblockeditor.h +++ b/editors/ComponentEditor/memoryMaps/addressblockeditor.h @@ -38,12 +38,12 @@ class AddressBlockEditor : public QGroupBox /*! * The constructor. * - * @param [in] registers Registers for the interface. - * @param [in] registerInterface Interface for registers. - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The parent of this editor. + * @param [in] registers Registers for the interface. + * @param [in] registerInterface Interface for registers. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The parent of this editor. */ AddressBlockEditor(QSharedPointer > > registers, RegisterInterface* registerInterface, QSharedPointer component, @@ -68,15 +68,15 @@ class AddressBlockEditor : public QGroupBox /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); /*! * Change the value for address unit bits in the model. * - * @param [in] newAddressUnitBits The new address unit bits value. + * @param [in] newAddressUnitBits The new address unit bits value. */ void addressUnitBitsChanged(int newAddressUnitBits); @@ -93,49 +93,49 @@ class AddressBlockEditor : public QGroupBox /*! * Sends an error message forward. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Sends a notification message forward. * - * @param [in] msg The notification message. + * @param [in] msg The notification message. */ void noticeMessage(const QString& msg) const; /*! * Increase the amount of references made to the given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void increaseReferences(QString id) const; /*! * Decrease the amount of references made to the given parameter. * - * @param [in] id The id the given parameter. + * @param [in] id The id the given parameter. */ void decreaseReferences(QString id) const; /*! * Informs that a new item has been created. * - * @param [in] index The index of the new item. + * @param [in] index The index of the new item. */ void childAdded(int index); /*! * Informs that an item has been removed. * - * @param [in] index The index of the removed item. + * @param [in] index The index of the removed item. */ void childRemoved(int index); /*! * Informs of a change in item addressing. * - * @param [in] index Index of the item whose addressing is changed. + * @param [in] index Index of the item whose addressing is changed. */ void childAddressingChanged(int index); diff --git a/editors/ComponentEditor/memoryMaps/addressblockmodel.h b/editors/ComponentEditor/memoryMaps/addressblockmodel.h index c0111f239..141e11603 100644 --- a/editors/ComponentEditor/memoryMaps/addressblockmodel.h +++ b/editors/ComponentEditor/memoryMaps/addressblockmodel.h @@ -36,10 +36,10 @@ class AddressBlockModel : public ReferencingTableModel, public ParameterizableTa /*! * The constructor. * - * @param [in] registerInterface Interface for registers. - * @param [in] expressionParser The expression parser. - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of the model. + * @param [in] registerInterface Interface for registers. + * @param [in] expressionParser The expression parser. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of the model. */ AddressBlockModel(RegisterInterface* registerInterface, QSharedPointer expressionParser, @@ -55,66 +55,66 @@ class AddressBlockModel : public ReferencingTableModel, public ParameterizableTa /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of displayed columns. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -123,37 +123,37 @@ class AddressBlockModel : public ReferencingTableModel, public ParameterizableTa /*! * Check if the column is valid for containing expressions. * - * @param [in] index The index of the column. + * @param [in] index The index of the column. * - * @return True, if the column is valid for expressions, otherwise false. + * @return True, if the column is valid for expressions, otherwise false. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return Expression or plain value for the given index. + * @return Expression or plain value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in the index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets all the references to the selected id from the selected register. * - * @param [in] row The row of the selected register. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected register. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the target parameter. + * @return The amount of references made to the target parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -162,28 +162,28 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Change the value for address unit bits. * - * @param [in] newAddressUnitbits The new value for address unit bits. + * @param [in] newAddressUnitbits The new value for address unit bits. */ void addressUnitBitsChanged(int newAddressUnitbits); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -216,8 +216,8 @@ public slots: /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); @@ -232,56 +232,56 @@ public slots: /*! * Add a register. * - * @param [in] regItem The new register. - * @param [in] index Index of the new register. + * @param [in] regItem The new register. + * @param [in] index Index of the new register. */ void onAddItem(QSharedPointer regItem, QModelIndex const& index); /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Get the value for the corresponding index. * - * @param [in] index The index whose value is being searched for. + * @param [in] index The index whose value is being searched for. */ QVariant valueForIndex(const QModelIndex& index) const; /*! * Decrease the number of references when removing a register. * - * @param [in] registerName Name of the removed register. + * @param [in] registerName Name of the removed register. */ void decreaseReferencesWithRemovedRegister(QString const& registerName); /*! * Increase the number of references made in the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. */ void increaseReferencesInPastedRegister(QString const& registerName); /*! * Calculates the parameters used in the selected register. * - * @param [in] registerName Name of the selected register. + * @param [in] registerName Name of the selected register. * - * @return A map containing pairs of referenced ids and the number of references made to them. + * @return A map containing pairs of referenced ids and the number of references made to them. */ QMap getReferencedParameters(QString const& registerName) const; diff --git a/editors/ComponentEditor/memoryMaps/enumeratedvaluedelegate.h b/editors/ComponentEditor/memoryMaps/enumeratedvaluedelegate.h index 415f0f328..b0fe0eadb 100644 --- a/editors/ComponentEditor/memoryMaps/enumeratedvaluedelegate.h +++ b/editors/ComponentEditor/memoryMaps/enumeratedvaluedelegate.h @@ -26,7 +26,7 @@ class EnumeratedValueDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] parent Pointer to the owner of the delegate. */ EnumeratedValueDelegate(QObject *parent); @@ -36,11 +36,11 @@ class EnumeratedValueDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -48,17 +48,17 @@ class EnumeratedValueDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; diff --git a/editors/ComponentEditor/memoryMaps/enumeratedvaluemodel.h b/editors/ComponentEditor/memoryMaps/enumeratedvaluemodel.h index c24a6ccff..ebe633a1a 100644 --- a/editors/ComponentEditor/memoryMaps/enumeratedvaluemodel.h +++ b/editors/ComponentEditor/memoryMaps/enumeratedvaluemodel.h @@ -30,9 +30,9 @@ class EnumeratedValueModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] enumeratedValues The enumerated values being edited. - * @param [in] enumeratedValueValidator The validator used for enumerated values. - * @param [in] parent Pointer to the owner of the model. + * @param [in] enumeratedValues The enumerated values being edited. + * @param [in] enumeratedValueValidator The validator used for enumerated values. + * @param [in] parent Pointer to the owner of the model. */ EnumeratedValueModel(QSharedPointer > > enumeratedValues, QSharedPointer enumeratedValueValidator, QObject *parent); @@ -43,66 +43,66 @@ class EnumeratedValueModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -111,21 +111,21 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -156,18 +156,18 @@ public slots: /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Get a unique name for the selected name. * - * @param [in] originalName The selected name. + * @param [in] originalName The selected name. * - * @return A unique name created from the selected name. + * @return A unique name created from the selected name. */ QString getUniqueName(QString const& originalName); diff --git a/editors/ComponentEditor/memoryMaps/fieldeditor.h b/editors/ComponentEditor/memoryMaps/fieldeditor.h index 03c01764a..d7d405201 100644 --- a/editors/ComponentEditor/memoryMaps/fieldeditor.h +++ b/editors/ComponentEditor/memoryMaps/fieldeditor.h @@ -36,11 +36,11 @@ class FieldEditor : public QGroupBox /*! * The constructor. * - * @param [in] enumeratedValues List of enumerated values being edited. - * @param [in] enumeratedValueValidator The validator for enumerated values. - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance managing the library. - * @param [in] parent Pointer to the parent of this editor. + * @param [in] enumeratedValues List of enumerated values being edited. + * @param [in] enumeratedValueValidator The validator for enumerated values. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance managing the library. + * @param [in] parent Pointer to the parent of this editor. */ FieldEditor(QSharedPointer > > enumeratedValues, QSharedPointer enumeratedValueValidator, QSharedPointer component, diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsExpressionCalculators/ReferenceCalculator.h b/editors/ComponentEditor/memoryMaps/memoryMapsExpressionCalculators/ReferenceCalculator.h index a87e9fd1a..590011ddb 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsExpressionCalculators/ReferenceCalculator.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsExpressionCalculators/ReferenceCalculator.h @@ -28,7 +28,7 @@ class ReferenceCalculator /*! * The constructor. * - * @param [in] parameterFinder Pointer to the instance for finding component parameters. + * @param [in] parameterFinder Pointer to the instance for finding component parameters. */ ReferenceCalculator(QSharedPointer parameterFinder); @@ -40,9 +40,9 @@ class ReferenceCalculator /*! * Calculates the parameters used in a given list of expressions. * - * @param [in] listOfPossibleReferences A list of expressions with possible references. + * @param [in] listOfPossibleReferences A list of expressions with possible references. * - * @return A map containing pairs of referenced ids and the number of references made to them. + * @return A map containing pairs of referenced ids and the number of references made to them. */ QMap getReferencedParameters(QStringList listOfPossibleReferences) const; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/MemoryBlockGraphItem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/MemoryBlockGraphItem.h index a12813d65..6d23340fa 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/MemoryBlockGraphItem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/MemoryBlockGraphItem.h @@ -30,8 +30,8 @@ class MemoryBlockGraphItem : public MemoryVisualizationItem /*! * The constructor * - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent graph item. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent graph item. */ MemoryBlockGraphItem(QSharedPointer expressionParser, QGraphicsItem *parent); @@ -53,21 +53,21 @@ class MemoryBlockGraphItem : public MemoryVisualizationItem /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; /*! * Sets the addressable unit size. * - * @param [in] addressableUnitBits The number of bits per address unit. + * @param [in] addressableUnitBits The number of bits per address unit. */ void setAddressableUnitBits(int addressableUnitBits); /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override final; @@ -76,14 +76,14 @@ class MemoryBlockGraphItem : public MemoryVisualizationItem /*! * Get the name of the memory block. * - * @return Name of the memory block. + * @return Name of the memory block. */ virtual QString getName() const = 0; /*! * Get the range of the memory block. * - * @return Range of the memory block. + * @return Range of the memory block. */ virtual quint64 getRange() const = 0; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/SubspaceMapGraphItem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/SubspaceMapGraphItem.h index 532739343..29c750c98 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/SubspaceMapGraphItem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/SubspaceMapGraphItem.h @@ -34,10 +34,10 @@ class SubspaceMapGraphItem : public MemoryBlockGraphItem /*! * The constructor * - * @param [in] submapInterface Interface for accessing subspace maps. - * @param [in] subspaceName Name of the represented subspace map. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent graph item. + * @param [in] submapInterface Interface for accessing subspace maps. + * @param [in] subspaceName Name of the represented subspace map. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent graph item. */ SubspaceMapGraphItem(SubspaceMapInterface* submapInterface, QString const& subspaceName, @@ -56,21 +56,21 @@ class SubspaceMapGraphItem : public MemoryBlockGraphItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; @@ -79,8 +79,8 @@ public slots: /*! * Handle the name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void onNameChanged(QString const& oldName, QString const& newName); @@ -89,14 +89,14 @@ public slots: /*! * Get the name of the memory block. * - * @return Name of the memory block. + * @return Name of the memory block. */ virtual QString getName() const override final; /*! * Get the range of the memory block. * - * @return Range of the memory block. + * @return Range of the memory block. */ virtual quint64 getRange() const override final; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/addressblockgraphitem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/addressblockgraphitem.h index b397d2851..4de022348 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/addressblockgraphitem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/addressblockgraphitem.h @@ -34,9 +34,9 @@ class AddressBlockGraphItem : public MemoryBlockGraphItem /*! * The constructor * - * @param [in] addrBlock The address block to visualize. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent graph item. + * @param [in] addrBlock The address block to visualize. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent graph item. */ AddressBlockGraphItem(QSharedPointer addrBlock, QSharedPointer expressionParser, @@ -52,21 +52,21 @@ class AddressBlockGraphItem : public MemoryBlockGraphItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; @@ -75,14 +75,14 @@ class AddressBlockGraphItem : public MemoryBlockGraphItem /*! * Get the name of the memory block. * - * @return Name of the memory block. + * @return Name of the memory block. */ virtual QString getName() const override final; /*! * Get the range of the memory block. * - * @return Range of the memory block. + * @return Range of the memory block. */ virtual quint64 getRange() const override final; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/fieldgraphitem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/fieldgraphitem.h index f0fc5f9d5..301636a39 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/fieldgraphitem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/fieldgraphitem.h @@ -31,9 +31,9 @@ class FieldGraphItem : public MemoryVisualizationItem /*! * The constructor. * - * @param [in] field The field to visualize. - * @param [in] expressionParser Parser for expressions in fields. - * @param [in] parent The parent graph item. + * @param [in] field The field to visualize. + * @param [in] expressionParser Parser for expressions in fields. + * @param [in] parent The parent graph item. */ FieldGraphItem(QSharedPointer field, QSharedPointer expressionParser, QGraphicsItem* parent); @@ -51,42 +51,42 @@ class FieldGraphItem : public MemoryVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the last bit contained in the field. * - * @return The last bit. + * @return The last bit. */ virtual quint64 getLastAddress() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override final; /*! * Set the width for the item. * - * @param [in] width The new width of the item. + * @param [in] width The new width of the item. */ virtual void setWidth(qreal width) override final; /*! * Sets the first non-overlapping address to display. * - * @param [in] The first address to set. + * @param [in] The first address to set. */ virtual void setDisplayOffset(quint64 const& address) override final; @@ -94,14 +94,14 @@ class FieldGraphItem : public MemoryVisualizationItem /*! * Sets the last non-overlapping address to display. * - * @param [in] The last address to set. + * @param [in] The last address to set. */ virtual void setDisplayLastAddress(quint64 const& address) override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapgraphitem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapgraphitem.h index 774f670d2..b69c4401d 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapgraphitem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapgraphitem.h @@ -34,9 +34,9 @@ class MemoryMapGraphItem : public MemoryVisualizationItem /*! * The constructor. * - * @param [in] parentMemoryMap The parent memory map of the memory remap. - * @param [in] memoryRemap The memory remap to be visualized. - * @param [in] parent Pointer to the owner of this graphics item. + * @param [in] parentMemoryMap The parent memory map of the memory remap. + * @param [in] memoryRemap The memory remap to be visualized. + * @param [in] parent Pointer to the owner of this graphics item. */ MemoryMapGraphItem(QSharedPointer parentMemoryMap, QSharedPointer memoryRemap, @@ -58,28 +58,28 @@ class MemoryMapGraphItem : public MemoryVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override; @@ -88,14 +88,14 @@ class MemoryMapGraphItem : public MemoryVisualizationItem * * This width is affected by the item's children so if children grow this width grows accordingly. * - * @return The width of the item and it's sub-items. + * @return The width of the item and it's sub-items. */ virtual qreal itemTotalWidth() const override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; @@ -105,7 +105,7 @@ class MemoryMapGraphItem : public MemoryVisualizationItem /*! * Get the displayed memory remap. * - * @return The displayed memory remap. + * @return The displayed memory remap. */ QSharedPointer getMemoryMap() const; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapscene.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapscene.h index 28d745b49..06f7653ec 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapscene.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapscene.h @@ -32,7 +32,7 @@ class MemoryMapScene : public QGraphicsScene /*! * The constructor. * - * @param [in] parent Pointer to the owner of the graphics scene. + * @param [in] parent Pointer to the owner of the graphics scene. */ explicit MemoryMapScene(QObject *parent); @@ -48,21 +48,21 @@ class MemoryMapScene : public QGraphicsScene /*! * Add a new memory map graph item to the scene. * - * @param [in] memGraphItem Pointer to the item. + * @param [in] memGraphItem Pointer to the item. */ void addMemGraphItem(MemoryMapGraphItem* memGraphItem); /*! * Remove a memory map graph item from the scene. * - * @param [in] memGraphItem Pointer to the item to remove. + * @param [in] memGraphItem Pointer to the item to remove. */ void removeMemGraphItem(MemoryMapGraphItem* memGraphItem); /*! * Set the scene width. * - * @param [in] width Width to set. + * @param [in] width Width to set. */ void setWidth(int width); diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapsvisualizer.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapsvisualizer.h index 76c4df754..59e4d198a 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapsvisualizer.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapsvisualizer.h @@ -37,7 +37,7 @@ class MemoryMapsVisualizer : public ItemVisualizer /*! The constructor * - * @param [in] parent Pointer to the owner of the visualizer widget. + * @param [in] parent Pointer to the owner of the visualizer widget. * */ explicit MemoryMapsVisualizer(QWidget *parent = 0); @@ -53,25 +53,25 @@ class MemoryMapsVisualizer : public ItemVisualizer /*! Add a new memory map graphics item to the scene. * - * @param [in] memMapItem Pointer to the graphics item. + * @param [in] memMapItem Pointer to the graphics item. */ void addMemoryMapItem(MemoryMapGraphItem* memMapItem); /*! Remove a memory map graphics item from the scene. * - * @param [in] memMapItem Pointer to the graphics item. + * @param [in] memMapItem Pointer to the graphics item. */ void removeMemoryMapItem(MemoryMapGraphItem* memMapItem); /*! The minimum size hint for the visualizer. * - * @return The minimum size hint. + * @return The minimum size hint. */ virtual QSize minimumSizeHint() const; /*! The size hint for the visualizer. * - * @return The size hint. + * @return The size hint. */ virtual QSize sizeHint() const; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapview.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapview.h index ec528d81f..1d58e55fe 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapview.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/memorymapview.h @@ -26,7 +26,7 @@ class MemoryMapView : public QGraphicsView /*! * The constructor. * - * @param [in] parent The pointer to the owner of the graphics view. + * @param [in] parent The pointer to the owner of the graphics view. */ MemoryMapView(QWidget *parent); diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registerfilegraphitem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registerfilegraphitem.h index c5cc2b19d..06a3fa920 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registerfilegraphitem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registerfilegraphitem.h @@ -32,9 +32,9 @@ class RegisterFileGraphItem : public MemoryVisualizationItem /*! * The constructor. * - * @param [in] regFile The register file represented by the item. - * @param [in] expressionParser Parser for expressions. - * @param [in] parent The parent item. + * @param [in] regFile The register file represented by the item. + * @param [in] expressionParser Parser for expressions. + * @param [in] parent The parent item. */ RegisterFileGraphItem(QSharedPointer regFile, QSharedPointer expressionParser, @@ -53,35 +53,35 @@ class RegisterFileGraphItem : public MemoryVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the last bit contained in the field. * - * @return The last bit. + * @return The last bit. */ virtual quint64 getLastAddress() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; diff --git a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registergraphitem.h b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registergraphitem.h index af0e41e77..fc1be9a6e 100644 --- a/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registergraphitem.h +++ b/editors/ComponentEditor/memoryMaps/memoryMapsVisualizer/registergraphitem.h @@ -32,9 +32,9 @@ class RegisterGraphItem : public MemoryVisualizationItem /*! * The constructor. * - * @param [in] reg The register that this graph item visualizes. - * @param [in] expressionParser Parser for expressions in register fields. - * @param [in] parent The parent of this graph item. + * @param [in] reg The register that this graph item visualizes. + * @param [in] expressionParser Parser for expressions in register fields. + * @param [in] parent The parent of this graph item. */ RegisterGraphItem(QSharedPointer reg, QSharedPointer expressionParser, QGraphicsItem* parent); @@ -58,42 +58,42 @@ class RegisterGraphItem : public MemoryVisualizationItem /*! * Get the offset of the item. * - * @return The offset of the item from the parent item's base address. + * @return The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const override final; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const override final; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const override final; /*! * Set the width for the item. * - * @param [in] width The new width of the item. + * @param [in] width The new width of the item. */ virtual void setWidth(qreal width) override final; /*! * Checks if the item is to be used in the visualization. * - * @return True, if the item should be used, otherwise false. + * @return True, if the item should be used, otherwise false. */ virtual bool isPresent() const override final; @@ -121,21 +121,21 @@ class RegisterGraphItem : public MemoryVisualizationItem /*! * Gets the register size in AUB units. * - * @return The size of the register in AUBs. + * @return The size of the register in AUBs. */ quint64 getSizeInAUB() const; /*! * Gets the MSB of the register. * - * @return The MSB of the register. + * @return The MSB of the register. */ unsigned int getRegisterMSB() const; /*! * Finds the highest bit reserved by the register i.e. MSB or highest bit found in fields. * - * @return The highest bit index in the register. + * @return The highest bit index in the register. */ unsigned int findHighestReservedBit() const; @@ -143,18 +143,18 @@ class RegisterGraphItem : public MemoryVisualizationItem /*! * Checks if there is empty memory space between the given child and the last known used bit index. * - * @param [in] current The currently iterated child. - * @param [in] lastBitIndexInUse The last known used bit index. + * @param [in] current The currently iterated child. + * @param [in] lastBitIndexInUse The last known used bit index. * - * @return True, if there is empty space, otherwise false. + * @return True, if there is empty space, otherwise false. */ bool emptySpaceBeforeChild(MemoryVisualizationItem const* current, quint64 lastBitIndexInUse) const; /*! * Creates a new child for representing a free memory slot. * - * @param [in] startAddress The offset of the free memory slot. - * @param [in] lastAddress The last address of the free memory slot. + * @param [in] startAddress The offset of the free memory slot. + * @param [in] lastAddress The last address of the free memory slot. */ QMultiMap::iterator addMemoryGap(quint64 startAddress, quint64 endAddress); diff --git a/editors/ComponentEditor/memoryMaps/memorymapdelegate.h b/editors/ComponentEditor/memoryMaps/memorymapdelegate.h index 344256735..471cad760 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapdelegate.h +++ b/editors/ComponentEditor/memoryMaps/memorymapdelegate.h @@ -26,9 +26,9 @@ class MemoryMapDelegate : public MemoryBlockDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder for expression editor. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder for expression editor. + * @param [in] parent Pointer to the owner of the delegate. */ MemoryMapDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -41,11 +41,11 @@ class MemoryMapDelegate : public MemoryBlockDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -53,17 +53,17 @@ class MemoryMapDelegate : public MemoryBlockDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -72,9 +72,9 @@ class MemoryMapDelegate : public MemoryBlockDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True if the cells in the column allow expressions, otherwise false. + * @return True if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; @@ -92,21 +92,21 @@ class MemoryMapDelegate : public MemoryBlockDelegate /*! * Get the column for block name. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Get the column for block base address. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const override final; /*! * Get the column for block is present. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const override final; }; diff --git a/editors/ComponentEditor/memoryMaps/memorymapeditor.h b/editors/ComponentEditor/memoryMaps/memorymapeditor.h index f7e75cb18..6e4e2b63d 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapeditor.h +++ b/editors/ComponentEditor/memoryMaps/memorymapeditor.h @@ -43,13 +43,13 @@ class MemoryMapEditor : public QGroupBox /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parameterFinder The parameter finder for component. - * @param [in] expressionParser The expression parser. - * @param [in] blockInterface Interface for address blocks. - * @param [in] blocks Pointer to the available address blocks. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parameterFinder The parameter finder for component. + * @param [in] expressionParser The expression parser. + * @param [in] blockInterface Interface for address blocks. + * @param [in] blocks Pointer to the available address blocks. + * @param [in] parent The parent of this editor. */ MemoryMapEditor(QSharedPointer component, LibraryInterface* handler, @@ -84,57 +84,57 @@ class MemoryMapEditor : public QGroupBox /*! * Emits an error message for the user. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Emits a notice message for the user. * - * @param [in] msg [Description]. + * @param [in] msg [Description]. */ void noticeMessage(const QString& msg) const; /*! * Increases the number of references to the given parameter. * - * @param [in] id The target parameter. + * @param [in] id The target parameter. */ void increaseReferences(QString id); /*! * Decreases the number of references to the given parameter. * - * @param [in] id The target parameter. + * @param [in] id The target parameter. */ void decreaseReferences(QString id); /*! * Informs of an added child. * - * @param [in] index The index of the new child. + * @param [in] index The index of the new child. */ void childAdded(int index); /*! * Informs of a removed child. * - * @param [in] index The index of the removed child. + * @param [in] index The index of the removed child. */ void childRemoved(int index); /*! * Assign new address unit bits for address blocks. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); /* * Informs of address block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void addressBlockNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/memoryMaps/memorymapmodel.h b/editors/ComponentEditor/memoryMaps/memorymapmodel.h index a208b98a7..4a8cbb572 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapmodel.h +++ b/editors/ComponentEditor/memoryMaps/memorymapmodel.h @@ -33,11 +33,11 @@ class MemoryMapModel : public MemoryBlockModel /*! * The constructor. * - * @param [in] blockInterface Interface for address blocks; - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent Pointer to the owner of this model. + * @param [in] blockInterface Interface for address blocks; + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent Pointer to the owner of this model. */ MemoryMapModel(AddressBlockInterface* blockInterface, QSharedPointer expressionParser, QSharedPointer parameterFinder, Document::Revision docRevision, QObject *parent); @@ -50,57 +50,57 @@ class MemoryMapModel : public MemoryBlockModel /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const override; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const override final; @@ -109,45 +109,45 @@ class MemoryMapModel : public MemoryBlockModel /*! * Checks if the column index is valid for expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if the column can have expressions, otherwise false. + * @return True, if the column can have expressions, otherwise false. */ bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * validates the data in the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const override final; /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const override final; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const override final; /*! * Gets the value for the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant valueForIndex(QModelIndex const& index) const override final; @@ -160,28 +160,28 @@ class MemoryMapModel : public MemoryBlockModel /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Get the index of the base address column. * - * @return Index of the base address column. + * @return Index of the base address column. */ virtual int baseAddressColumn() const override final; /*! * Get the index of the is present column. * - * @return Index of the is present column. + * @return Index of the is present column. */ virtual int isPresentColumn() const override final; /*! * Get the index of the description column. * - * @return Index of the description column. + * @return Index of the description column. */ virtual int descriptionColumn() const override final; diff --git a/editors/ComponentEditor/memoryMaps/memorymapsdelegate.h b/editors/ComponentEditor/memoryMaps/memorymapsdelegate.h index 8899e0e86..9cb93c35c 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapsdelegate.h +++ b/editors/ComponentEditor/memoryMaps/memorymapsdelegate.h @@ -27,10 +27,10 @@ class MemoryMapsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder for expression editor. - * @param [in] remapStateNames A list of names of the component remap states. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder for expression editor. + * @param [in] remapStateNames A list of names of the component remap states. + * @param [in] parent Pointer to the owner of the delegate. */ MemoryMapsDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QStringList remapStateNames, QObject *parent); @@ -41,11 +41,11 @@ class MemoryMapsDelegate : public ExpressionDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -53,33 +53,33 @@ class MemoryMapsDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index The index of the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index The index of the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index The inex of the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index The inex of the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; /*! * Update the list of remap state names. * - * @param [in] newRemapStateNames The new list of remap state names. + * @param [in] newRemapStateNames The new list of remap state names. */ void updateRemapStateNames(QStringList newRemapStateNames); /*! * Paint the memory maps. * - * @param [in] painter The used painter. - * @param [in] option Available style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option Available style options. + * @param [in] index The current index. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -91,9 +91,9 @@ class MemoryMapsDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True if the cells in the column allow expressions, otherwise false. + * @return True if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/memoryMaps/memorymapseditor.h b/editors/ComponentEditor/memoryMaps/memorymapseditor.h index 002a011ce..a01fa51bd 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapseditor.h +++ b/editors/ComponentEditor/memoryMaps/memorymapseditor.h @@ -51,12 +51,12 @@ class MemoryMapsEditor : public ItemEditor /*! * The constructor. * - * @param [in] mapInterface Interface for memory maps. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The used expression parser. - * @param [in] handler The instance managing the library. - * @param [in] parent The owner of this editor. + * @param [in] mapInterface Interface for memory maps. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The used expression parser. + * @param [in] handler The instance managing the library. + * @param [in] parent The owner of this editor. */ MemoryMapsEditor(MemoryMapInterface* mapInterface, QSharedPointer component, @@ -76,7 +76,7 @@ class MemoryMapsEditor : public ItemEditor /*! * The size hint for the editor. * - * @return QSize contains the size hint. + * @return QSize contains the size hint. */ virtual QSize sizeHint() const; @@ -88,40 +88,40 @@ class MemoryMapsEditor : public ItemEditor /*! * Emitted when address unit bits are changed. * - * @param [in] memoryMapIndex The index of the changed memory map. + * @param [in] memoryMapIndex The index of the changed memory map. */ void changeInAddressUnitBitsOnRow(int memoryMapIndex); /*! * Inform of the added memory remap. * - * @param [in] memoryRemapIndex The index of the new memory remap. - * @param [in] parentMemoryMapName Name of the owner of the new memory remap. + * @param [in] memoryRemapIndex The index of the new memory remap. + * @param [in] parentMemoryMapName Name of the owner of the new memory remap. */ void memoryRemapAdded(int memoryRemapIndex, QString const& parentMemoryMapName); /*! * Inform of the removed memory remap. * - * @param [in] memoryRemapIndex The index of the removed memory remap. - * @param [in] parentMemoryMapName Name of the owner of the removed memory remap. + * @param [in] memoryRemapIndex The index of the removed memory remap. + * @param [in] parentMemoryMapName Name of the owner of the removed memory remap. */ void memoryRemapRemoved(int memoryRemapIndex, QString const& parentMemoryMapName); /* * Informs of memory map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory remap name change. * - * @param [in] parentName Name of the containing memory map. - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] parentName Name of the containing memory map. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); @@ -146,7 +146,7 @@ private slots: /*! * Gets the names of the components remap states. * - * @return A list containing all the names of the remap states. + * @return A list containing all the names of the remap states. */ QStringList getRemapStateNames() const; diff --git a/editors/ComponentEditor/memoryMaps/memorymapsmodel.h b/editors/ComponentEditor/memoryMaps/memorymapsmodel.h index 8f683ecfa..6bf106fe5 100644 --- a/editors/ComponentEditor/memoryMaps/memorymapsmodel.h +++ b/editors/ComponentEditor/memoryMaps/memorymapsmodel.h @@ -46,12 +46,12 @@ class MemoryMapsModel : public QAbstractItemModel, public ParameterizableTable /*! * The constructor. * - * @param [in] parameterFinder The instance used to find parameters. - * @param [in] expressionParser The used expression parser. - * @param [in] mapInterface Interface for memory maps. - * @param [in] docRevision The IP-XACT standard revision to use. - * @param [in] ROWHEIGHT Height for rows. - * @param [in] parent The owner of the model. + * @param [in] parameterFinder The instance used to find parameters. + * @param [in] expressionParser The used expression parser. + * @param [in] mapInterface Interface for memory maps. + * @param [in] docRevision The IP-XACT standard revision to use. + * @param [in] ROWHEIGHT Height for rows. + * @param [in] parent The owner of the model. */ MemoryMapsModel( QSharedPointer parameterFinder, QSharedPointer expressionParser, MemoryMapInterface* mapInterface, @@ -71,86 +71,86 @@ class MemoryMapsModel : public QAbstractItemModel, public ParameterizableTable /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent of the index that's row count is requested. + * @param [in] parent Identifies the parent of the index that's row count is requested. * - * @return The number of rows an item has. + * @return The number of rows an item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has. * - * @param [in] parent Identifies the parent of the index that's column count is requested. + * @param [in] parent Identifies the parent of the index that's column count is requested. * - * @return The number of columns an item has. + * @return The number of columns an item has. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index The item's model index. + * @param [in] index The item's model index. * - * @return The possible operations for the item. + * @return The possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for the specified header. * - * @param [in] section The row / column number of the header. - * @param [in] orientation Specifies the orientation of the header. - * @param [in] role The type of the requested data. + * @param [in] section The row / column number of the header. + * @param [in] orientation Specifies the orientation of the header. + * @param [in] role The type of the requested data. * - * @return The requested data. + * @return The requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for the specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return The data for the item. + * @return The data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for the specified item. * - * @param [in] index The index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role Specifies what kind of data should be saved. + * @param [in] index The index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role Specifies what kind of data should be saved. * - * @return True, if saving was successful, false otherwise. + * @return True, if saving was successful, false otherwise. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ virtual QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex() ) const; /*! * Get the model index of the parent of the object. * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelindex that identifies the parent of the given object. + * @return QModelindex that identifies the parent of the given object. */ virtual QModelIndex parent(const QModelIndex &child) const; /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -159,42 +159,42 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for the new item. + * @param [in] index The index identifying the position for the new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to be removed. + * @param [in] index The index identifying the item to be removed. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Add a new memory remap item. * - * @param [in] index The parent index of the new memory remap item. + * @param [in] index The parent index of the new memory remap item. */ virtual void onAddMemoryRemap(const QModelIndex& index); /*! * Copy the selected items matching the selected indexes. * - * @param [in] indexList A list of the selected indexes. + * @param [in] indexList A list of the selected indexes. */ void onCopyRows(QModelIndexList const& indexList); /*! * Paste the selected items. * - * @param [in] index The owner of the pasted memory remap items. + * @param [in] index The owner of the pasted memory remap items. */ void onPasteRows(QModelIndex const& index); /*! * Remove all memory remaps from the selected memory map. * - * @param [in] itemIndex Index of the selected memory map. + * @param [in] itemIndex Index of the selected memory map. */ void onRemoveAllChildItemsFrom(QModelIndex const& itemIndex); @@ -226,31 +226,31 @@ public slots: /*! * Informs of an increase in references for a given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void increaseReferences(QString const& id); /*! * Informs of a decrease in references for a given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void decreaseReferences(QString const& id); /* * Informs of memory map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory remap name change. * - * @param [in] parentName Name of the containing memory map. - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] parentName Name of the containing memory map. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); @@ -259,27 +259,27 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in an index. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the index is valid, otherwise false. + * @return True, if the data in the index is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; @@ -288,77 +288,77 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Increaser the number of references when creating a new memory remap. * - * @param [in] memoryMapName Name of the memory map. + * @param [in] memoryMapName Name of the memory map. */ void increaseReferencesWithNewRemap(QString const& memoryMapName); /*! * Decrease the number of references when removing a memory remap. * - * @param [in] mapName Name of the memory map containing the selected memory remap. - * @param [in] remapName Name of the removed memory remap. + * @param [in] mapName Name of the memory map containing the selected memory remap. + * @param [in] remapName Name of the removed memory remap. */ void decreaseReferencesWithRemovedMemoryMap(QString const& mapName, QString const& remapName); /*! * Create a parent index for the index of a memory remap. * - * @param [in] childItem The memory remap. + * @param [in] childItem The memory remap. * - * @return The parent index of the memory remap child item. + * @return The parent index of the memory remap child item. */ QModelIndex createParentIndexForMemoryRemap(MemoryRemap* childItem) const; /*! * Check if the index is valid in the model. * - * @param [in] index The index whose validity is being checked. + * @param [in] index The index whose validity is being checked. * - * @return True, if the index is valid, false otherwise. + * @return True, if the index is valid, false otherwise. */ bool isIndexValid(QModelIndex const& index) const; /*! * Increase the number of references in the referenced parameters. * - * @param [in] mapExpressions List of expressions contained within the selected map. - * @param [in] referenceCalculator The used reference calculator. + * @param [in] mapExpressions List of expressions contained within the selected map. + * @param [in] referenceCalculator The used reference calculator. */ void increaseReferencesInPastedMap(QStringList mapExpressions, ReferenceCalculator& referenceCalculator); /*! * Get the memory map and remap names associated with the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Pair containing the memory map and memory remap names. + * @return Pair containing the memory map and memory remap names. */ QPair getIndexedMapRemapNames(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/memoryMaps/registerdelegate.h b/editors/ComponentEditor/memoryMaps/registerdelegate.h index 1772e8fdf..48413e6cd 100644 --- a/editors/ComponentEditor/memoryMaps/registerdelegate.h +++ b/editors/ComponentEditor/memoryMaps/registerdelegate.h @@ -30,9 +30,9 @@ class RegisterDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for expression editor. - * @param [in] parent Pointer to the owner of the delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for expression editor. + * @param [in] parent Pointer to the owner of the delegate. */ RegisterDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -43,11 +43,11 @@ class RegisterDelegate : public ExpressionDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; @@ -55,17 +55,17 @@ class RegisterDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; @@ -74,9 +74,9 @@ class RegisterDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True if the cells in the column allow expressions, otherwise false. + * @return True if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/memoryMaps/registereditor.h b/editors/ComponentEditor/memoryMaps/registereditor.h index a64175929..489ef8c93 100644 --- a/editors/ComponentEditor/memoryMaps/registereditor.h +++ b/editors/ComponentEditor/memoryMaps/registereditor.h @@ -38,12 +38,12 @@ class RegisterEditor : public QGroupBox /*! * The constructor. * - * @param [in] fields Pointer to the available fields. - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] fieldInterface Interface for fields. - * @param [in] parent Pointer to the parent of this editor. + * @param [in] fields Pointer to the available fields. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] fieldInterface Interface for fields. + * @param [in] parent Pointer to the parent of this editor. */ RegisterEditor(QSharedPointer > > fields, QSharedPointer component, @@ -67,8 +67,8 @@ class RegisterEditor : public QGroupBox /* * Informs of field name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void fieldNameChanged(QString const& oldName, QString const& newName); @@ -87,42 +87,42 @@ class RegisterEditor : public QGroupBox /*! * Sends an error message forward. * - * @param [in] message The error message. + * @param [in] message The error message. */ void errorMessage(QString const& message) const; /*! * Sends a notification forward. * - * @param [in] message The notification. + * @param [in] message The notification. */ void noticeMessage(QString const& message) const; /*! * Increase the amount of references made to the given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void increaseReferences(QString const& id) const; /*! * Decrease the amount of references made to the given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void decreaseReferences(QString const& id) const; /*! * Informs that a new item has been created. * - * @param [in] index The index of the new item. + * @param [in] index The index of the new item. */ void childAdded(int index); /*! * Informs that an item has been removed. * - * @param [in] index The index of the removed item. + * @param [in] index The index of the removed item. */ void childRemoved(int index); diff --git a/editors/ComponentEditor/memoryMaps/registerfiledelegate.h b/editors/ComponentEditor/memoryMaps/registerfiledelegate.h index b34f5b22e..2c420f5a1 100644 --- a/editors/ComponentEditor/memoryMaps/registerfiledelegate.h +++ b/editors/ComponentEditor/memoryMaps/registerfiledelegate.h @@ -25,9 +25,9 @@ class RegisterFileDelegate: public ExpressionDelegate /*! * The constructor * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent Pointer to the owner of this delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent Pointer to the owner of this delegate. */ RegisterFileDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QObject *parent); @@ -45,9 +45,9 @@ class RegisterFileDelegate: public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/memoryMaps/registerfileeditor.h b/editors/ComponentEditor/memoryMaps/registerfileeditor.h index 43c3f2f9b..441e9c653 100644 --- a/editors/ComponentEditor/memoryMaps/registerfileeditor.h +++ b/editors/ComponentEditor/memoryMaps/registerfileeditor.h @@ -36,13 +36,13 @@ class RegisterFileEditor : public QGroupBox /*! * The constructor. * - * @param [in] registerFile The register file to edit. - * @param [in] component The component containing the register file. - * @param [in] handler The available IP-XACT library. - * @param [in] parameterFinder Finder for parameters. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] registerFileValidator Validator for register files. - * @param [in] parent The parent widget. + * @param [in] registerFile The register file to edit. + * @param [in] component The component containing the register file. + * @param [in] handler The available IP-XACT library. + * @param [in] parameterFinder Finder for parameters. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] registerFileValidator Validator for register files. + * @param [in] parent The parent widget. */ RegisterFileEditor(QSharedPointer > > registerFile, QSharedPointer component, @@ -78,42 +78,42 @@ class RegisterFileEditor : public QGroupBox /*! * Sends an error message forward. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Sends a notification message forward. * - * @param [in] msg The notification message. + * @param [in] msg The notification message. */ void noticeMessage(const QString& msg) const; /*! * Increase the amount of references made to the given parameter. * - * @param [in] id The id of the given parameter. + * @param [in] id The id of the given parameter. */ void increaseReferences(QString id) const; /*! * Decrease the amount of references made to the given parameter. * - * @param [in] id The id the given parameter. + * @param [in] id The id the given parameter. */ void decreaseReferences(QString id) const; /*! * Informs that a new item has been created. * - * @param [in] index The index of the new item. + * @param [in] index The index of the new item. */ void childAdded(int index); /*! * Informs that an item has been removed. * - * @param [in] index The index of the removed item. + * @param [in] index The index of the removed item. */ void childRemoved(int index); diff --git a/editors/ComponentEditor/memoryMaps/registerfilemodel.h b/editors/ComponentEditor/memoryMaps/registerfilemodel.h index 16a505a36..a0ab371a4 100644 --- a/editors/ComponentEditor/memoryMaps/registerfilemodel.h +++ b/editors/ComponentEditor/memoryMaps/registerfilemodel.h @@ -43,12 +43,12 @@ class RegisterFileModel : public ReferencingTableModel, public ParameterizableTa /*! * The constructor. * - * @param [in] registerData The register data containing the register files to edit. - * @param [in] expressionParser The expression parser. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] registerValidator Validator for registers. - * @param [in] parent The owner of the model. + * @param [in] registerData The register data containing the register files to edit. + * @param [in] expressionParser The expression parser. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] registerValidator Validator for registers. + * @param [in] parent The owner of the model. */ RegisterFileModel(QSharedPointer > > registerData, QSharedPointer expressionParser, @@ -69,66 +69,66 @@ class RegisterFileModel : public ReferencingTableModel, public ParameterizableTa /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of displayed columns. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -137,37 +137,37 @@ class RegisterFileModel : public ReferencingTableModel, public ParameterizableTa /*! * Check if the column is valid for containing expressions. * - * @param [in] index The index of the column. + * @param [in] index The index of the column. * - * @return True, if the column is valid for expressions, otherwise false. + * @return True, if the column is valid for expressions, otherwise false. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return Expression or plain value for the given index. + * @return Expression or plain value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in the index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets all the references to the selected id from the selected register. * - * @param [in] row The row of the selected register. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected register. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the target parameter. + * @return The amount of references made to the target parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -176,28 +176,28 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Change the value for address unit bits. * - * @param [in] newAddressUnitbits The new value for address unit bits. + * @param [in] newAddressUnitbits The new value for address unit bits. */ void addressUnitBitsChanged(int newAddressUnitbits); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -232,30 +232,30 @@ public slots: /*! * Get the value for the corresponding index. * - * @param [in] index The index whose value is being searched for. + * @param [in] index The index whose value is being searched for. */ QVariant valueForIndex(const QModelIndex& index) const; /*! * Decrease the number of references made from a removed register. * - * @param [in] removedRegister The removed register. + * @param [in] removedRegister The removed register. */ void decreaseReferencesWithRemovedRegister(QSharedPointer removedRegister); /*! * Get all the names of the registers and register files in register data. * - * @return The names of the registers and register files. + * @return The names of the registers and register files. */ QStringList getAllNames() const; /*! * Increase the number of references made in the copied register. * - * @param [in] pastedRegisterFile The copied register file. - * @param [in] gatherer Register expressions gatherer. - * @param [in] referenceCalculator The reference calculator. + * @param [in] pastedRegisterFile The copied register file. + * @param [in] gatherer Register expressions gatherer. + * @param [in] referenceCalculator The reference calculator. */ void increaseReferencesInPastedRegisterFile(QSharedPointer pastedRegisterFile, RegisterFileExpressionsGatherer& gatherer, ReferenceCalculator& referenceCalculator); diff --git a/editors/ComponentEditor/memoryMaps/registertablemodel.h b/editors/ComponentEditor/memoryMaps/registertablemodel.h index ee48ac1b9..1932c14ed 100644 --- a/editors/ComponentEditor/memoryMaps/registertablemodel.h +++ b/editors/ComponentEditor/memoryMaps/registertablemodel.h @@ -42,11 +42,11 @@ class RegisterTableModel : public ReferencingTableModel, public ParameterizableT /*! * The constructor. * - * @param [in] fieldInterface Interface for fields. - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] docRevision The IP-XACT standard revision in use. - * @param [in] parent Pointer to the owner of the model. + * @param [in] fieldInterface Interface for fields. + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] docRevision The IP-XACT standard revision in use. + * @param [in] parent Pointer to the owner of the model. */ RegisterTableModel(FieldInterface* fieldInterface, QSharedPointer expressionParser, QSharedPointer parameterFinder, Document::Revision docRevision, QObject *parent); @@ -60,66 +60,66 @@ class RegisterTableModel : public ReferencingTableModel, public ParameterizableT /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the list of acceptable mime types. * - * @return The list of acceptable mime types. + * @return The list of acceptable mime types. */ virtual QStringList mimeTypes() const; @@ -128,37 +128,37 @@ class RegisterTableModel : public ReferencingTableModel, public ParameterizableT /*! * Check if the column index is valid for expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, otherwise false. + * @return True, if column can have expressions, otherwise false. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return Expression or plain value in the given index. + * @return Expression or plain value in the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made on the selected row to the selected parameter. * - * @param [in] row The row of the selected item. - * @param [in] valueID The selected parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The selected parameter. * - * @return The amount of references made on the selected row to the selected parameter. + * @return The amount of references made on the selected row to the selected parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -167,21 +167,21 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); /*! * Copy the items in the selected rows. * - * @param [in] indexList List of indexes pointing to the selected rows. + * @param [in] indexList List of indexes pointing to the selected rows. */ void onCopyRows(QModelIndexList indexList); @@ -206,8 +206,8 @@ public slots: /* * Informs of field name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void fieldNameChanged(QString const& oldName, QString const& newName); @@ -226,50 +226,50 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Decrease the number of references when removing a field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. */ void decreaseReferencesWithRemovedField(QString const& fieldName); /*! * Increase the number of references made in the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. */ void increaseReferencesInPastedField(QString const& fieldName); /*! * Calculates the parameters used in the selected field. * - * @param [in] fieldName Name of the selected field. + * @param [in] fieldName Name of the selected field. * - * @return A map containing pairs of referenced ids and the number of references made to them. + * @return A map containing pairs of referenced ids and the number of references made to them. */ QMap getReferencedParameters(QString const& fieldName) const; @@ -277,7 +277,7 @@ public slots: * Check if the column of a given index is displaying values stored directly in the field according * to the 2014 IP-XACT standard revision. * - * @param [in] index Description + * @param [in] index Description * * @return True, if the column is a std14 column, otherwise false. */ @@ -290,7 +290,7 @@ public slots: * multiple field access policies. If the field has one field access policy, the values displayed will be * the values of that field access policy. The values are empty if the field has no field access policies. * - * @param [in] index The index to get the value of. + * @param [in] index The index to get the value of. * * @return The index value. */ @@ -301,9 +301,9 @@ public slots: * field access policies when using std 2022. Set the data for either the first field access policy of the * if using std22 or the field itself if using std14. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] fieldName The name of the field. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] fieldName The name of the field. * * @return True, if the setting the data succeeded, otherwise false. */ diff --git a/editors/ComponentEditor/modes/FieldSliceDelegate.h b/editors/ComponentEditor/modes/FieldSliceDelegate.h index 451404fa9..e2516d5bb 100644 --- a/editors/ComponentEditor/modes/FieldSliceDelegate.h +++ b/editors/ComponentEditor/modes/FieldSliceDelegate.h @@ -33,10 +33,10 @@ class FieldSliceDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] portNameList The list of available port names. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent of the object. + * @param [in] portNameList The list of available port names. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent of the object. */ FieldSliceDelegate(QSharedPointer > > memoryMaps, QSharedPointer > > addressSpaces, @@ -55,27 +55,27 @@ class FieldSliceDelegate : public ExpressionDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const final; /*! Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const final; diff --git a/editors/ComponentEditor/modes/FieldSliceEditor.h b/editors/ComponentEditor/modes/FieldSliceEditor.h index b88ebe1de..39993e834 100644 --- a/editors/ComponentEditor/modes/FieldSliceEditor.h +++ b/editors/ComponentEditor/modes/FieldSliceEditor.h @@ -37,12 +37,12 @@ class FieldSliceEditor : public QWidget /*! The constructor * - * @param [in] component The component being edited. + * @param [in] component The component being edited. * @param [in] mode The mode being edited. - * @param [in] validator The validator for FieldSlice. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] handler The instance managing the library. - * @param [in] parent The parent of this editor. + * @param [in] validator The validator for FieldSlice. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] handler The instance managing the library. + * @param [in] parent The parent of this editor. */ FieldSliceEditor(QSharedPointer component, QSharedPointer mode, @@ -66,14 +66,14 @@ class FieldSliceEditor : public QWidget /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void increaseReferences(QString const& parameterId); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] parameterId The id of the parameter being referenced. + * @param [in] parameterId The id of the parameter being referenced. */ void decreaseReferences(QString const& parameterId); diff --git a/editors/ComponentEditor/modes/FieldSliceModel.h b/editors/ComponentEditor/modes/FieldSliceModel.h index 5b1843e38..f16a43ba6 100644 --- a/editors/ComponentEditor/modes/FieldSliceModel.h +++ b/editors/ComponentEditor/modes/FieldSliceModel.h @@ -43,7 +43,7 @@ class FieldSliceModel : public ReferencingTableModel, public ParameterizableTabl * * @param [in] mode The mode being edited. * @param [in] validator The validator for the Field slices in the mode. - * @param [in] parent The owner of this model. + * @param [in] parent The owner of this model. */ FieldSliceModel(QSharedPointer mode, QSharedPointer validator, @@ -59,54 +59,54 @@ class FieldSliceModel : public ReferencingTableModel, public ParameterizableTabl /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving was successful. + * @return True if saving was successful. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -115,13 +115,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); @@ -136,9 +136,9 @@ public slots: /*! * Validates the data for the column. * - * @param [in] index The column of the item to validate. + * @param [in] index The column of the item to validate. * - * @return True, if the data of the item is valid for the column, false otherwise. + * @return True, if the data of the item is valid for the column, false otherwise. */ virtual bool validateIndex(QModelIndex const& index) const final; diff --git a/editors/ComponentEditor/modes/ModesEditor.h b/editors/ComponentEditor/modes/ModesEditor.h index 4dec03d3e..3bb8cb022 100644 --- a/editors/ComponentEditor/modes/ModesEditor.h +++ b/editors/ComponentEditor/modes/ModesEditor.h @@ -36,10 +36,10 @@ class ModesEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator for Modes. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator for Modes. + * @param [in] parent The parent of this editor. */ ModesEditor(QSharedPointer component, LibraryInterface* handler, QWidget* parent = 0); diff --git a/editors/ComponentEditor/modes/ModesModel.h b/editors/ComponentEditor/modes/ModesModel.h index 26993a382..9f127987c 100644 --- a/editors/ComponentEditor/modes/ModesModel.h +++ b/editors/ComponentEditor/modes/ModesModel.h @@ -36,8 +36,8 @@ class ModesModel : public QAbstractTableModel /*! The constructor * - * @param [in] component The component being edited. - * @param [in] parent The owner of this model. + * @param [in] component The component being edited. + * @param [in] parent The owner of this model. */ ModesModel(QSharedPointer component, QObject* parent); @@ -51,54 +51,54 @@ class ModesModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving was successful. + * @return True if saving was successful. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -107,13 +107,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); @@ -124,13 +124,13 @@ public slots: /*! Emitted when a new Mode is added to the model. * - * @param [in] index The index of the added Mode. + * @param [in] index The index of the added Mode. */ void modeAdded(int index); /*! Emitted when a Mode is removed from the model. * - * @param [in] index The index of the removed Mode. + * @param [in] index The index of the removed Mode. */ void modeRemoved(int index); diff --git a/editors/ComponentEditor/modes/PortSliceDelegate.h b/editors/ComponentEditor/modes/PortSliceDelegate.h index fcf5ce2bc..510b358be 100644 --- a/editors/ComponentEditor/modes/PortSliceDelegate.h +++ b/editors/ComponentEditor/modes/PortSliceDelegate.h @@ -33,10 +33,10 @@ class PortSliceDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] portNameList The list of available port names. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent of the object. + * @param [in] portNameList The list of available port names. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent of the object. */ PortSliceDelegate(QStringList const& portNameList, QAbstractItemModel* completionModel, @@ -54,27 +54,27 @@ class PortSliceDelegate : public ExpressionDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const final; /*! Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const final; @@ -83,7 +83,7 @@ class PortSliceDelegate : public ExpressionDelegate /*! * Set the component ports. * - * @param [in] componentPorts All the ports of the component. + * @param [in] componentPorts All the ports of the component. */ void setComponentPorts(QStringList const& componentPorts); @@ -92,7 +92,7 @@ public slots: /*! * Set the currently available port names. * - * @param [in] newPorts The currently available port names. + * @param [in] newPorts The currently available port names. */ void setNewPortNames(QStringList const& newPorts); @@ -106,9 +106,9 @@ public slots: /*! * Checks if the cells in given column accept expression as an input value. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells accept expressions, otherwise false. + * @return True, if the cells accept expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; diff --git a/editors/ComponentEditor/modes/PortSliceEditor.h b/editors/ComponentEditor/modes/PortSliceEditor.h index aed17f735..42767a5b7 100644 --- a/editors/ComponentEditor/modes/PortSliceEditor.h +++ b/editors/ComponentEditor/modes/PortSliceEditor.h @@ -37,11 +37,11 @@ class PortSliceEditor : public QWidget /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator for PortSlice. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator for PortSlice. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent of this editor. */ PortSliceEditor(QSharedPointer component, QSharedPointer mode, @@ -70,14 +70,14 @@ class PortSliceEditor : public QWidget /*! * Increase the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter with a matching id. * - * @param [in] id Id of the parameter, whose references are being increased. + * @param [in] id Id of the parameter, whose references are being increased. */ void decreaseReferences(QString const& id); diff --git a/editors/ComponentEditor/modes/PortSliceModel.h b/editors/ComponentEditor/modes/PortSliceModel.h index 0261e3dad..0de570af4 100644 --- a/editors/ComponentEditor/modes/PortSliceModel.h +++ b/editors/ComponentEditor/modes/PortSliceModel.h @@ -43,8 +43,8 @@ class PortSliceModel : public ReferencingTableModel, public ParameterizableTable * * @param [in] mode The mode being edited. * @param [in] validator The validator for the port slices in the mode. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The owner of this model. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The owner of this model. */ PortSliceModel(QSharedPointer mode, QSharedPointer validator, @@ -60,54 +60,54 @@ class PortSliceModel : public ReferencingTableModel, public ParameterizableTable /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving was successful. + * @return True if saving was successful. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -116,13 +116,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); @@ -136,37 +136,37 @@ public slots: /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if the column can accept expressions, false otherwise. + * @return True, if the column can accept expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * Gets the expression for the index, or the plain value, if an expression is not available. * - * @param [in] index The index of the item. + * @param [in] index The index of the item. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const final; /*! * Validates the data for the column. * - * @param [in] index The column of the item to validate. + * @param [in] index The column of the item to validate. * - * @return True, if the data of the item is valid for the column, false otherwise. + * @return True, if the data of the item is valid for the column, false otherwise. */ virtual bool validateIndex(QModelIndex const& index) const final; diff --git a/editors/ComponentEditor/modes/SingleModeEditor.h b/editors/ComponentEditor/modes/SingleModeEditor.h index 72782e478..ce2552eca 100644 --- a/editors/ComponentEditor/modes/SingleModeEditor.h +++ b/editors/ComponentEditor/modes/SingleModeEditor.h @@ -42,11 +42,11 @@ class SingleModeEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component that contains the view. - * @param [in] Mode The remap state being edited. - * @param [in] libHandler The instance that manages the library. - * @param [in] expressions Changes the referenced ids to parameter names. - * @param [in] parent The owner of this editor. + * @param [in] component The component that contains the view. + * @param [in] Mode The remap state being edited. + * @param [in] libHandler The instance that manages the library. + * @param [in] expressions Changes the referenced ids to parameter names. + * @param [in] parent The owner of this editor. */ SingleModeEditor(QSharedPointer component, QSharedPointer mode, @@ -74,7 +74,7 @@ class SingleModeEditor : public ItemEditor /*! * The show event for this editor. * - * @param [in] event The show event. + * @param [in] event The show event. */ void showEvent(QShowEvent * event) final; diff --git a/editors/ComponentEditor/otherClockDrivers/clockdriversdelegate.h b/editors/ComponentEditor/otherClockDrivers/clockdriversdelegate.h index 69902f99e..b40785a73 100644 --- a/editors/ComponentEditor/otherClockDrivers/clockdriversdelegate.h +++ b/editors/ComponentEditor/otherClockDrivers/clockdriversdelegate.h @@ -25,7 +25,7 @@ class ClockDriversDelegate : public QStyledItemDelegate /*! The constructor * - * @param [in] parent The owner of this instance. + * @param [in] parent The owner of this instance. */ ClockDriversDelegate(QObject *parent); @@ -34,27 +34,27 @@ class ClockDriversDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/otherClockDrivers/otherclockdriverseditor.h b/editors/ComponentEditor/otherClockDrivers/otherclockdriverseditor.h index 1099b6eb0..f1ebcc541 100644 --- a/editors/ComponentEditor/otherClockDrivers/otherclockdriverseditor.h +++ b/editors/ComponentEditor/otherClockDrivers/otherclockdriverseditor.h @@ -38,10 +38,10 @@ class OtherClockDriversEditor : public ItemEditor /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] clockValidator Validator used for other clock drivers. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] clockValidator Validator used for other clock drivers. + * @param [in] parent The owner of this widget. * */ OtherClockDriversEditor(QSharedPointer component, LibraryInterface* handler, diff --git a/editors/ComponentEditor/otherClockDrivers/otherclockdriversmodel.h b/editors/ComponentEditor/otherClockDrivers/otherclockdriversmodel.h index 4f2b00e51..45ec9b0ac 100644 --- a/editors/ComponentEditor/otherClockDrivers/otherclockdriversmodel.h +++ b/editors/ComponentEditor/otherClockDrivers/otherclockdriversmodel.h @@ -32,9 +32,9 @@ class OtherClockDriversModel : public QAbstractTableModel /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] clockValidator Validator used for other clock drivers. - * @param [in] parent The owner of this model + * @param [in] component The component being edited. + * @param [in] clockValidator Validator used for other clock drivers. + * @param [in] parent The owner of this model */ OtherClockDriversModel(QSharedPointer component, QSharedPointer clockValidator, QObject *parent); @@ -45,61 +45,61 @@ class OtherClockDriversModel : public QAbstractTableModel /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns in the model * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * hierarchical model. * - * @return Always returns 9 + * @return Always returns 9 */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Get the data for the headers * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed + * @return QVariant containing the data to be displayed */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; @@ -108,7 +108,7 @@ public slots: /*! * Remove a row from the model * - * @param [in] row Specifies the row to remove + * @param [in] row Specifies the row to remove */ void onRemoveRow(int row); @@ -120,14 +120,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(QModelIndex const& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(QModelIndex const& index); @@ -153,9 +153,9 @@ public slots: /*! * Validate the data contained within a given index. * - * @param [in] index The index of the data being validated. + * @param [in] index The index of the data being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/parameterReferenceTree/ComponentParameterReferenceTree.h b/editors/ComponentEditor/parameterReferenceTree/ComponentParameterReferenceTree.h index ab606dd7c..53a46fd0f 100644 --- a/editors/ComponentEditor/parameterReferenceTree/ComponentParameterReferenceTree.h +++ b/editors/ComponentEditor/parameterReferenceTree/ComponentParameterReferenceTree.h @@ -58,10 +58,10 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * The constructor. * - * @param [in] component The component whose references to display. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] referenceCounter Calculator for parameter references. - * @param [in] parent The parent widget. + * @param [in] component The component whose references to display. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] referenceCounter Calculator for parameter references. + * @param [in] parent The parent widget. */ ComponentParameterReferenceTree(QSharedPointer component, QSharedPointer expressionFormatter, @@ -79,7 +79,7 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Set a new component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void setComponent(QSharedPointer newComponent); @@ -103,8 +103,8 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create references for file builders. * - * @param [in] fileBuilders The selected file builders. - * @param [in] parentItem The parent item of the file builders item. + * @param [in] fileBuilders The selected file builders. + * @param [in] parentItem The parent item of the file builders item. */ void createReferencesForFileBuilders(QSharedPointer > > fileBuilders, QTreeWidgetItem* parentItem); @@ -112,16 +112,16 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create references for a single file builder. * - * @param [in] fileBuilder The selected file builder. - * @param [in] parentItem The parent item. + * @param [in] fileBuilder The selected file builder. + * @param [in] parentItem The parent item. */ void createReferencesForSingleFileBuilder(QSharedPointer fileBuilder, QTreeWidgetItem* parentItem); /*! * Create references from the selected files. * - * @param [in] fileList A list of files with possible references. - * @param [in] parentItem The parent item. + * @param [in] fileList A list of files with possible references. + * @param [in] parentItem The parent item. */ void createReferencesForFiles(QSharedPointer > > fileList, QTreeWidgetItem* parentItem); @@ -129,16 +129,16 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create references for a single file. * - * @param [in] selectedFile The selected file. - * @param [in] parentItem The parent item. + * @param [in] selectedFile The selected file. + * @param [in] parentItem The parent item. */ void createReferencesForSingleFile(QSharedPointer selectedFile, QTreeWidgetItem* parentItem); /*! * Create the references for model parameters. * - * @param [in] parameters The model parameters to create references for. - * @param [in] parentItem The parent item for references. + * @param [in] parameters The model parameters to create references for. + * @param [in] parentItem The parent item for references. */ void createReferencesForModuleParameters(QSharedPointer > > parameters, QTreeWidgetItem* parentItem); @@ -151,21 +151,21 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create references for component instantiations. * - * @param [in] topInstantiationsItem The parent tree item. + * @param [in] topInstantiationsItem The parent tree item. */ void createReferencesForComponentInstantiations(QTreeWidgetItem* topInstantiationsItem); /*! * Create references for design configuration instantiations. * - * @param [in] topInstantiationsItem The parent tree item. + * @param [in] topInstantiationsItem The parent tree item. */ void createReferencesForDesignConfigurationInstantiations(QTreeWidgetItem* topInstantiationsItem); /*! * Create references for design instantiations. * - * @param [in] topInstantiationsItem The parent tree item. + * @param [in] topInstantiationsItem The parent tree item. */ void createReferencesForDesignInstantiations(QTreeWidgetItem* topInstantiationsItem); @@ -182,24 +182,24 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create the references for a single address space. * - * @param [in] addressSpace The address space to create references for. - * @param [in] parent The parent tree item of the new address space item. + * @param [in] addressSpace The address space to create references for. + * @param [in] parent The parent tree item of the new address space item. */ void createItemsForAddressSpace(QSharedPointer addressSpace, QTreeWidgetItem* parent); /*! * Create the references for segments within an address space. * - * @param [in] addressSpace The address space to create references for. - * @param [in] parent The parent tree item of the new segment items. + * @param [in] addressSpace The address space to create references for. + * @param [in] parent The parent tree item of the new segment items. */ void createReferencesForSegments(QSharedPointer addressSpace, QTreeWidgetItem* parent); /*! * Create the references a segment within an address space. * - * @param [in] segment The segment to create references for. - * @param [in] parent The parent tree item of the segment items. + * @param [in] segment The segment to create references for. + * @param [in] parent The parent tree item of the segment items. */ void createItemsForSegment(QSharedPointer segment, QTreeWidgetItem* parent); @@ -211,8 +211,8 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create the references for a single abstract memory map. * - * @param [in] memoryMap The memory map / memory remap. - * @param [in] topMemoryMapItem The parent tree item of the new memory map tree item. + * @param [in] memoryMap The memory map / memory remap. + * @param [in] topMemoryMapItem The parent tree item of the new memory map tree item. */ void createReferencesForSingleMemoryMap(QSharedPointer memoryMap, QTreeWidgetItem* memoryRemapItem); @@ -220,8 +220,8 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create the references for a single address block. * - * @param [in] addressBlock The address block. - * @param [in] middleAddressBlocksItem The parent tree item of the new address block tree item. + * @param [in] addressBlock The address block. + * @param [in] middleAddressBlocksItem The parent tree item of the new address block tree item. */ void createReferencesForSingleAddressBlock(QSharedPointer addressBlock, QTreeWidgetItem* middleAddressBlocksItem); @@ -229,9 +229,9 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create the references for registers. * - * @param [in] targetID The selected parameter ID. - * @param [in] registerData Selected register data. - * @param [in] parentItem Parent tree item of the new register items. + * @param [in] targetID The selected parameter ID. + * @param [in] registerData Selected register data. + * @param [in] parentItem Parent tree item of the new register items. */ void createReferencesForRegisters(QString const& targetID, QSharedPointer > > registerData, QTreeWidgetItem* parentItem); @@ -239,16 +239,16 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create the references for a single register. * - * @param [in] targetRegister The register. - * @param [in] parentItem The parent tree item of the new register tree item. + * @param [in] targetRegister The register. + * @param [in] parentItem The parent tree item of the new register tree item. */ void createReferencesForSingleRegister(QSharedPointer targetRegister, QTreeWidgetItem* parentItem); /*! * Create the references for a single register file * - * @param [in] targetFile The selected register file. - * @param [in] parentItem Parent tree item of the new register file tree item. + * @param [in] targetFile The selected register file. + * @param [in] parentItem Parent tree item of the new register file tree item. */ void createReferencesForSingleRegisterFile(QSharedPointer targetFile, QTreeWidgetItem* parentItem); @@ -292,8 +292,8 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create tree items for a region that is referencing this parameter. * - * @param [in] region The referencing region. - * @param [in] parent The parent of the upcoming item. + * @param [in] region The referencing region. + * @param [in] parent The parent of the upcoming item. */ void createItemsForRegion(QSharedPointer region, QTreeWidgetItem* parent); @@ -305,65 +305,65 @@ class ComponentParameterReferenceTree : public ParameterReferenceTree /*! * Create tree items for a port that is referencing this parameter. * - * @param [in] port The referencing port. - * @param [in] parent The parent of the upcoming item. + * @param [in] port The referencing port. + * @param [in] parent The parent of the upcoming item. */ void createItemsForPort(QSharedPointer port, QTreeWidgetItem* parent); /*! * Create tree items for a memory map that is referencing this parameter. * - * @param [in] targetMap The referencing memory map. - * @param [in] parent The parent of the upcoming item. + * @param [in] targetMap The referencing memory map. + * @param [in] parent The parent of the upcoming item. */ void createItemsForMemoryMap(QSharedPointer targetMap, QTreeWidgetItem* parent); /*! * Create tree items for an address block that is referencing this parameter. * - * @param [in] targetAddressBlock The referencing address block. - * @param [in] parent The parent for the upcoming item. + * @param [in] targetAddressBlock The referencing address block. + * @param [in] parent The parent for the upcoming item. */ void createItemsForAddressBlock(QSharedPointer targetAddressBlock, QTreeWidgetItem* parent); /*! * Create tree items for a register that is referencing this parameter. * - * @param [in] targetRegister The referencing register. - * @param [in] parent The parent of the upcoming item. + * @param [in] targetRegister The referencing register. + * @param [in] parent The parent of the upcoming item. */ void createItemsForRegister(QSharedPointer targetRegister, QTreeWidgetItem* parent); /*! * Create tree items for a base register that is referencing this parameter. * - * @param [in] baseRegister The referencing base register. - * @param [in] parent The parent of the upcoming item. + * @param [in] baseRegister The referencing base register. + * @param [in] parent The parent of the upcoming item. */ void createItemsForBaseRegister(QSharedPointer baseRegister, QTreeWidgetItem* parent); /*! * Create tree items for a register file that is referencing this parameter. * - * @param [in] targetFile The referencing register file. - * @param [in] parent The parent of the upcoming item. + * @param [in] targetFile The referencing register file. + * @param [in] parent The parent of the upcoming item. */ void createItemsForRegisterFile(QSharedPointer targetFile, QTreeWidgetItem* parent); /*! * Create tree items for a register field that is referencing this parameter. * - * @param [in] targetField The referencing register field. - * @param [in] parent The parent of the new item. + * @param [in] targetField The referencing register field. + * @param [in] parent The parent of the new item. */ void createItemsForField(QSharedPointer targetField, QTreeWidgetItem* parent); /*! * Create tree items for field resets that is referencing the selected parameter. * - * @param [in] targetID ID of the selected parameter. - * @param [in] fieldResets Reset values of the selected field. - * @param [in] fieldItem The parent field item for the reset items. + * @param [in] targetID ID of the selected parameter. + * @param [in] fieldResets Reset values of the selected field. + * @param [in] fieldItem The parent field item for the reset items. */ void createItemsForFieldResets(QString const& targetID, QSharedPointer > > fieldResets, QTreeWidgetItem* fieldItem); diff --git a/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTree.h b/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTree.h index 4886c9075..e8da5e691 100644 --- a/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTree.h +++ b/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTree.h @@ -40,8 +40,8 @@ class ParameterReferenceTree : public QTreeWidget /*! * The constructor. * - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] parent The parent widget. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] parent The parent widget. */ ParameterReferenceTree(QSharedPointer formatter, QWidget* parent = 0); @@ -53,7 +53,7 @@ class ParameterReferenceTree : public QTreeWidget /*! * Setup the parameter reference tree for the selected parameter. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. */ void openReferenceTree(QString const& parameterID); @@ -62,15 +62,15 @@ class ParameterReferenceTree : public QTreeWidget /*! * Get the ID of the selected parameter. * - * @return ID of the selected parameter. + * @return ID of the selected parameter. */ QString getTargetID() const; /*! * Create the references for parameters. * - * @param [in] parameters List of parameters containing a reference. - * @param [in] parentItem The parent item for references. + * @param [in] parameters List of parameters containing a reference. + * @param [in] parentItem The parent item for references. */ void createParameterReferences(QSharedPointer > > parameters, QTreeWidgetItem* parentItem); @@ -78,8 +78,8 @@ class ParameterReferenceTree : public QTreeWidget /*! * Create references for configurable element values. * - * @param [in] elements List of the configurable element values. - * @param [in] parent The parent tree item. + * @param [in] elements List of the configurable element values. + * @param [in] parent The parent tree item. */ void createReferencesForConfigurableElementValues( QSharedPointer > > elements, QTreeWidgetItem* parent); @@ -87,43 +87,43 @@ class ParameterReferenceTree : public QTreeWidget /*! * Create a tree widget item to the top of the tree. * - * @param [in] itemName The name of the upcoming item. + * @param [in] itemName The name of the upcoming item. * - * @return A pointer to the new tree item. + * @return A pointer to the new tree item. */ QTreeWidgetItem* createTopItem(QString const& itemName); /*! * Create a tree item between two items. * - * @param [in] itemnName The name of the upcoming item. - * @param [in] parent The parent of the upcoming item. + * @param [in] itemnName The name of the upcoming item. + * @param [in] parent The parent of the upcoming item. * - * @return A pointer to the new tree item. + * @return A pointer to the new tree item. */ QTreeWidgetItem* createMiddleItem(QString const& itemnName, QTreeWidgetItem* parent); /*! * Create tree items for a parameter that is referencing this parameter. * - * @param [in] parameter The referencing parameter. - * @param [in] parent The parent of the upcoming item. + * @param [in] parameter The referencing parameter. + * @param [in] parent The parent of the upcoming item. */ void createItemsForParameter(QSharedPointer parameter, QTreeWidgetItem* parent); /*! * Create a referencing tree item. * - * @param [in] itemName The name of the upcoming tree item. - * @param [in] expression The expression where the upcoming tree item references this parameter. - * @param [in] parent The parent of the upcoming item. + * @param [in] itemName The name of the upcoming tree item. + * @param [in] expression The expression where the upcoming tree item references this parameter. + * @param [in] parent The parent of the upcoming item. */ void createItem(QString const& itemName, QString const& expression, QTreeWidgetItem* parent); /*! * Colour the background of the selected item grey. * - * @param [in] item The selected item. + * @param [in] item The selected item. */ void colourItemGrey(QTreeWidgetItem* item); diff --git a/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTreeWindow.h b/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTreeWindow.h index f6c7250a2..4cbb0cbab 100644 --- a/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTreeWindow.h +++ b/editors/ComponentEditor/parameterReferenceTree/ParameterReferenceTreeWindow.h @@ -30,8 +30,8 @@ class ParameterReferenceTreeWindow : public QDialog /*! * The constructor. * - * @param [in] parameterReferenceTree Tree containing the references made to the selected parameter. - * @param [in] parent Parent widget. + * @param [in] parameterReferenceTree Tree containing the references made to the selected parameter. + * @param [in] parent Parent widget. */ ParameterReferenceTreeWindow(ParameterReferenceTree* parameterReferenceTree, QWidget* parent = 0); @@ -45,8 +45,8 @@ public slots: /*! * Handles the creation and opening of the parameter reference tree. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& parameterID, QString const& parameterName); diff --git a/editors/ComponentEditor/parameters/Array/ArrayDelegate.h b/editors/ComponentEditor/parameters/Array/ArrayDelegate.h index 6a2bcd4ba..5c36aa920 100644 --- a/editors/ComponentEditor/parameters/Array/ArrayDelegate.h +++ b/editors/ComponentEditor/parameters/Array/ArrayDelegate.h @@ -29,10 +29,10 @@ class ArrayDelegate : public ChoiceCreatorDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] finder The parameter finder to search for the parameters. - * @param [in] selectedChoice The currently active choice. - * @param [in] parent The parent object. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] finder The parameter finder to search for the parameters. + * @param [in] selectedChoice The currently active choice. + * @param [in] parent The parent object. */ ArrayDelegate(QAbstractItemModel* completionModel, QSharedPointer finder, @@ -52,32 +52,32 @@ class ArrayDelegate : public ChoiceCreatorDelegate /*! * Checks if the cells in given column accept expression as an input value. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells accept expressions, otherwise false. + * @return True, if the cells accept expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the name of the currently selected choice. * - * @param [in] index The index of the currently selected row. + * @param [in] index The index of the currently selected row. * - * @return The name of the selected choice. + * @return The name of the selected choice. */ virtual QString choiceNameOnRow(QModelIndex const& index) const; /*! * Gets the column number for the value column. * - * @return The number of the column for value. + * @return The number of the column for value. */ virtual int valueColumn() const; /*! * Gets the currently selected choice. * - * @param [in] index The index of the currently selected row. + * @param [in] index The index of the currently selected row. */ virtual QSharedPointer findChoice(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/parameters/Array/ArrayView.h b/editors/ComponentEditor/parameters/Array/ArrayView.h index c6773bfdc..3102afba5 100644 --- a/editors/ComponentEditor/parameters/Array/ArrayView.h +++ b/editors/ComponentEditor/parameters/Array/ArrayView.h @@ -25,7 +25,7 @@ class ArrayView : public QTableView /*! * The constructor. * - * @param [in] parent The parent of this view. + * @param [in] parent The parent of this view. */ ArrayView(QWidget* parent); @@ -37,15 +37,15 @@ class ArrayView : public QTableView /*! * Reimplemented to do nothing when keyboard search is initiated. * - * @param [in] search The found item should be the best match for this string. + * @param [in] search The found item should be the best match for this string. */ virtual void keyboardSearch(const QString &search); /*! * The event filter for this view. * - * @param [in] filterObject The object to be filtered. - * @param [in] filterEvent The event to be filtered. + * @param [in] filterObject The object to be filtered. + * @param [in] filterEvent The event to be filtered. */ virtual bool eventFilter(QObject *filterObject, QEvent *filterEvent); diff --git a/editors/ComponentEditor/parameters/Array/ParameterArrayModel.h b/editors/ComponentEditor/parameters/Array/ParameterArrayModel.h index b4aaaee2b..9da711701 100644 --- a/editors/ComponentEditor/parameters/Array/ParameterArrayModel.h +++ b/editors/ComponentEditor/parameters/Array/ParameterArrayModel.h @@ -39,14 +39,14 @@ class ParameterArrayModel : public ReferencingTableModel, public Parameterizable /*! * The constructor. * - * @param [in] sizeOfArray Size of the array to be constructed. - * @param [in] expressionParser Pointer to the expression parser. - * @param [in] parameterFinder Pointer to parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] selectedChoice The currently active choice. - * @param [in] valueBackgroundColor The colour for the background of value column. - * @param [in] arrayStartIndex The starting index of the array. - * @param [in] parent The parent of this model. + * @param [in] sizeOfArray Size of the array to be constructed. + * @param [in] expressionParser Pointer to the expression parser. + * @param [in] parameterFinder Pointer to parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] selectedChoice The currently active choice. + * @param [in] valueBackgroundColor The colour for the background of value column. + * @param [in] arrayStartIndex The starting index of the array. + * @param [in] parent The parent of this model. */ ParameterArrayModel(int sizeOfArray, QSharedPointer expressionParser, @@ -66,87 +66,87 @@ class ParameterArrayModel : public ReferencingTableModel, public Parameterizable /*! * Returns the amount of columns in the model. * - * @param [in] parent If given, the column count of the children of the given parent is returned. + * @param [in] parent If given, the column count of the children of the given parent is returned. * - * @return The amount of columns. + * @return The amount of columns. */ int columnCount(const QModelIndex &parent = QModelIndex()) const; /*! * Returns the amount of rows in the model. * - * @param [in] parent If given, the row count of the children of the given parent is returned. + * @param [in] parent If given, the row count of the children of the given parent is returned. * - * @return The amount of rows. + * @return The amount of rows. */ int rowCount(const QModelIndex &parent = QModelIndex()) const; /*! * Retrieves the header data for the given column (row headers are not supported in this model). * - * @param [in] section The column from which the index is retrieved. - * @param [in] orientation Whether the header is horizontal or vertical. - * @param [in] role The role for which the header is retrieved. + * @param [in] section The column from which the index is retrieved. + * @param [in] orientation Whether the header is horizontal or vertical. + * @param [in] role The role for which the header is retrieved. * - * @return The header data. + * @return The header data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Retrieves the data for the appropriate role at the given index. * - * @param [in] index The index of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] index The index of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The requested data. + * @return The requested data. */ QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; /*! * Sets the data at the given index. * - * @param [in] index The index at which the data is set. - * @param [in] value The new value to being set. - * @param [in] role The role for which the data is set. + * @param [in] index The index at which the data is set. + * @param [in] value The new value to being set. + * @param [in] role The role for which the data is set. * - * @return True, if data was set successfully, otherwise false. + * @return True, if data was set successfully, otherwise false. */ bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole); /*! * Returns the flags for an object at the given index. * - * @param [in] index The index of the object queried. + * @param [in] index The index of the object queried. * - * @return The relevant flags. + * @return The relevant flags. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Set the data for the array. * - * @param [in] arrayData The data to be set for the array. + * @param [in] arrayData The data to be set for the array. */ void setArrayData(QString const& arrayData); /*! * Gets the data of the array. * - * @return The data in the array in one string separated by ',' and in between {}. + * @return The data in the array in one string separated by ',' and in between {}. */ QString getArrayData(); /*! * Get the data of the array as a list of items. * - * @return The data in the array in a list of items. + * @return The data in the array in a list of items. */ QStringList getArrayDataAsList(); /*! * Set the type for the values in the array. * - * @param [in] parameterType The new type for the parameters. + * @param [in] parameterType The new type for the parameters. */ void setParameterType(QString const& parameterType); @@ -159,37 +159,37 @@ class ParameterArrayModel : public ReferencingTableModel, public Parameterizable /*! * Checks if the column is valid for expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if the column is valid for expressions, otherwise false. + * @return True, if the column is valid for expressions, otherwise false. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index of the value to get. + * @param [in] index The index of the value to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Gets all the references to an id from the selected array index. * - * @param [in] row The index of the selected array value. - * @param [in] valueID The parameter whose references are being searched for. + * @param [in] row The index of the selected array value. + * @param [in] valueID The parameter whose references are being searched for. * - * @return The amount of references made to the selected parameter. + * @return The amount of references made to the selected parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; /*! * Validates the data in the array at index corresponding to the given column. * - * @param [in] index The index of the array value. + * @param [in] index The index of the array value. * - * @return True, if the value is valid for the column. + * @return True, if the value is valid for the column. */ virtual bool validateIndex(QModelIndex const& index) const; @@ -203,27 +203,27 @@ class ParameterArrayModel : public ReferencingTableModel, public Parameterizable /*! * Check if the index is valid. * - * @param [in] index The index being checked. + * @param [in] index The index being checked. * - * @return True if the index is not valid, otherwise false. + * @return True if the index is not valid, otherwise false. */ bool indexIsNotValid(QModelIndex const& index) const; /*! * Gets the value of the array in the given index. * - * @param [in] index The index of the value. + * @param [in] index The index of the value. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Make the values in the array match the values of the choice. * - * @param [in] row The index of the value to be matched to choice. + * @param [in] row The index of the value to be matched to choice. * - * @return The value of the choice corresponding to the given value. + * @return The value of the choice corresponding to the given value. */ QString evaluateValueWithChoice(const int& row) const; diff --git a/editors/ComponentEditor/parameters/ChoiceCreatorDelegate.h b/editors/ComponentEditor/parameters/ChoiceCreatorDelegate.h index d767b6fe1..fc04d2235 100644 --- a/editors/ComponentEditor/parameters/ChoiceCreatorDelegate.h +++ b/editors/ComponentEditor/parameters/ChoiceCreatorDelegate.h @@ -30,9 +30,9 @@ class ChoiceCreatorDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] finder Pointer to the parameter finder, used in expression editor. - * @param [in] parent Pointer to the owner of this delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] finder Pointer to the parameter finder, used in expression editor. + * @param [in] parent Pointer to the owner of this delegate. */ ChoiceCreatorDelegate(QAbstractItemModel* completionModel, QSharedPointer finder, QObject* parent = 0); @@ -47,77 +47,77 @@ class ChoiceCreatorDelegate : public ExpressionDelegate /*! * Set the choices for this delegate. * - * @param [in] choices The currently available choices. + * @param [in] choices The currently available choices. */ void setChoices(QSharedPointer > > choices); /*! * Gets the currently available choices. * - * @return The currently available choices. + * @return The currently available choices. */ QSharedPointer > > getChoices() const; /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if cells in the column accept expressions, otherwise false. + * @return True, if cells in the column accept expressions, otherwise false. */ bool columnAcceptsExpression(int column) const = 0; /*! * Finds the name of the choice corresponding to the given index. * - * @param [in] index The index of the row to get the choice name from. + * @param [in] index The index of the row to get the choice name from. * - * @return The name of the choice on the row. + * @return The name of the choice on the row. */ virtual QString choiceNameOnRow(QModelIndex const& index) const = 0; /*! * Gets the choice used on the row identified by the given index. * - * @param [in] index The index of the row to find the choice from. + * @param [in] index The index of the row to find the choice from. * - * @return The choice of the given row. + * @return The choice of the given row. */ virtual QSharedPointer findChoice(QModelIndex const& index) const; /*! * Get the choice items for the combo editor. * - * @param [in] index Index of the edited item. + * @param [in] index Index of the edited item. * - * @return List of choice items for the combo editor. + * @return List of choice items for the combo editor. */ QStringList getChoiceComboItems(QModelIndex const& index) const; /*! * Get the enumeration text for the enumeration value. * - * @param [in] index Index of the edited item. - * @param [in] enumerationValue The selected enumeration value. + * @param [in] index Index of the edited item. + * @param [in] enumerationValue The selected enumeration value. * - * @return The selected enumeration text. + * @return The selected enumeration text. */ QString findEnumerationText(QModelIndex const& index, QString const& enumerationValue) const; /*! * Get the enumeration value for the enumeration text. * - * @param [in] index Index of the edited item. - * @param [in] enumerationText The selected enumeration text. + * @param [in] index Index of the edited item. + * @param [in] enumerationText The selected enumeration text. * - * @return The selected enumeration value. + * @return The selected enumeration value. */ QString findEnumerationValue(QModelIndex const& index, QString const& enumerationText) const; /*! * Get the column of the possible place for enumeration selector. * - * @return The column number for the column that's value can be given as an enumeration. + * @return The column number for the column that's value can be given as an enumeration. */ virtual int valueColumn() const = 0; diff --git a/editors/ComponentEditor/parameters/ComponentParameterModel.h b/editors/ComponentEditor/parameters/ComponentParameterModel.h index ff5cbbbb5..b0c0fa7d8 100644 --- a/editors/ComponentEditor/parameters/ComponentParameterModel.h +++ b/editors/ComponentEditor/parameters/ComponentParameterModel.h @@ -31,8 +31,8 @@ class ComponentParameterModel : public ReferencingTableModel, public Parameteriz /*! * The constructor. * - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of this model. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of this model. */ ComponentParameterModel(QSharedPointer parameterFinder, QObject *parent); @@ -42,46 +42,46 @@ class ComponentParameterModel : public ReferencingTableModel, public Parameteriz /*! * Finds the number of rows in the model. * - * @param [in] parent The parent index whose row count to find. + * @param [in] parent The parent index whose row count to find. * - * @return The number of rows in the model. + * @return The number of rows in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Finds the number of columns in the model. * - * @param [in] parent The parent index whose column count to find. + * @param [in] parent The parent index whose column count to find. * - * @return The number of columns in the model. + * @return The number of columns in the model. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Finds the flags for the given index. * - * @param [in] index The index whose flags to find. + * @param [in] index The index whose flags to find. * - * @return Flags describing allowed actions for the index. + * @return Flags describing allowed actions for the index. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Finds the parent index for the given child. * - * @param [in] child The index whose parent index to find. + * @param [in] child The index whose parent index to find. * - * @return The index for the parent. + * @return The index for the parent. */ virtual QModelIndex parent(QModelIndex const& child) const; /*! * Finds the data in the model for the given index. * - * @param [in] index The index whose data to find. - * @param [in] role The role describing which aspect of the data to find. + * @param [in] index The index whose data to find. + * @param [in] role The role describing which aspect of the data to find. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; @@ -97,37 +97,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in a parameter corresponding to a given column. * - * @param [in] index The index whose data to validate + * @param [in] index The index whose data to validate * - * @return True, if the data in the parameter is valid, otherwise false. + * @return True, if the data in the parameter is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Get all the references to the selected parameter from the selected row. * - * @param [in] row The selected row. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The selected row. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references to the selected parameter. + * @return The amount of references to the selected parameter. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; diff --git a/editors/ComponentEditor/parameters/ParameterDelegate.h b/editors/ComponentEditor/parameters/ParameterDelegate.h index 7eac4d62f..2de09b544 100644 --- a/editors/ComponentEditor/parameters/ParameterDelegate.h +++ b/editors/ComponentEditor/parameters/ParameterDelegate.h @@ -34,11 +34,11 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * The constructor. * - * @param [in] choices The choices available for model parameter value. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] finder The parameter finder to user for expression editors. - * @param [in] expressionFormatter The expression formatter for changing ids to parameter names. - * @param [in] parent The parent of the object. + * @param [in] choices The choices available for model parameter value. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] finder The parameter finder to user for expression editors. + * @param [in] expressionFormatter The expression formatter for changing ids to parameter names. + * @param [in] parent The parent of the object. */ ParameterDelegate(QSharedPointer > > choices, QAbstractItemModel* completionModel, QSharedPointer finder, @@ -49,27 +49,27 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -77,18 +77,18 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * Paint the delegate. * - * @param [in] painter The painter used. - * @param [in] option Style option in use. - * @param [in] index Index of model. + * @param [in] painter The painter used. + * @param [in] option Style option in use. + * @param [in] index Index of model. */ virtual void paint(QPainter *painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -100,8 +100,8 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * Open the reference tree of the selected parameter. * - * @param [in] id The ID of the selected parameter. - * @param [in] name Name of the selected parameter. + * @param [in] id The ID of the selected parameter. + * @param [in] name Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& name) const; @@ -113,143 +113,143 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * Gets the column for name. * - * @return The column index for editing name. + * @return The column index for editing name. */ virtual int nameColumn() const; /*! * Gets the column for choices. * - * @return The column for editing choice selection. + * @return The column for editing choice selection. */ virtual int choiceColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int formatColumn() const; /*! * Gets the column for the left value of bit width vector. * - * @return The column for editing the left value of the bit width vector. + * @return The column for editing the left value of the bit width vector. */ virtual int bitWidthLeftColumn() const; /*! * Gets the column for the right value of bit width vector. * - * @return The column for editing the right value of the bit width vector. + * @return The column for editing the right value of the bit width vector. */ virtual int bitWidthRightColumn() const; /*! * Gets the column for minimum value. * - * @return The column for editing the minimum value. + * @return The column for editing the minimum value. */ virtual int minimumColumn() const; /*! * Gets the column for maximum value. * - * @return The column for editing the maximum value. + * @return The column for editing the maximum value. */ virtual int maximumColumn() const; /*! * Gets the column for values. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int valueColumn() const; /*! * Gets the column for resolve. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int resolveColumn() const; /*! * Gets the column for description. * - * @return The column for description. + * @return The column for description. */ virtual int descriptionColumn() const; /*! * Gets the column for array left. * - * @return The column index for array left. + * @return The column index for array left. */ virtual int arrayLeftColumn() const; /*! * Gets the column for array right. * - * @return The column index for array right. + * @return The column index for array right. */ virtual int arrayRightColumn() const; /*! * Gets the column for usage count. * - * @return The column index for usage count. + * @return The column index for usage count. */ virtual int usageCountColumn() const; /*! * Gets the column index for the id of the parameter. * - * @return The column index for the parameter id. + * @return The column index for the parameter id. */ virtual int idColumn() const; /*! * Checks if the cells in given column accept expression as an input value. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells accept expressions, otherwise false. + * @return True, if the cells accept expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Finds the name of the choice on the row identified by the given index. * - * @param [in] index The index on whose row to find the choice name. + * @param [in] index The index on whose row to find the choice name. * - * @return The name of the choice on the row. + * @return The name of the choice on the row. */ QString choiceNameOnRow(QModelIndex const& index) const; /*! * Creates an editor for selecting a choice. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return An editor for selecting a choice. + * @return An editor for selecting a choice. */ QWidget* createChoiceSelector(QWidget* parent) const; /*! * Creates an editor for selecting a format for parameter value. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return An editor for selecting a format. + * @return An editor for selecting a format. */ QWidget* createFormatSelector(QWidget* parent) const; /*! * Creates an editor for selecting resolve attribute of a parameter. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return An editor for selecting resolve attribute. + * @return An editor for selecting resolve attribute. */ QWidget* createResolveSelector(QWidget* parent) const; @@ -264,9 +264,9 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * Check if the value should be an array. * - * @param [in] index The index of the current value. + * @param [in] index The index of the current value. * - * @return True, if the value is an array, otherwise false. + * @return True, if the value is an array, otherwise false. */ bool valueIsArray(QModelIndex const& index) const; @@ -274,9 +274,9 @@ class ParameterDelegate : public ChoiceCreatorDelegate * Repositions the editor if there is not enough space under the default position. The editor is then resized * to use the available space. * - * @param [in] editor The editor to reposition. - * @param [in] option The style options for the editor. - * @param [in] index The current index. + * @param [in] editor The editor to reposition. + * @param [in] option The style options for the editor. + * @param [in] index The current index. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -284,8 +284,8 @@ class ParameterDelegate : public ChoiceCreatorDelegate /*! * Gets the size of the array. * - * @param [in] arrayLeftValue The left value of the array. - * @param [in] arrayRightValue The right value of the array. + * @param [in] arrayLeftValue The left value of the array. + * @param [in] arrayRightValue The right value of the array. */ int getArraySize(int arrayLeftValue, int arrayRightValue) const; diff --git a/editors/ComponentEditor/parameters/ParameterEditorHeaderView.h b/editors/ComponentEditor/parameters/ParameterEditorHeaderView.h index 602301cfd..d2bdd875e 100644 --- a/editors/ComponentEditor/parameters/ParameterEditorHeaderView.h +++ b/editors/ComponentEditor/parameters/ParameterEditorHeaderView.h @@ -24,8 +24,8 @@ class ParameterEditorHeaderView : public QHeaderView /*! * The constructor for the header. * - * @param [in] orientation The headers orientation. - * @param [in] parent The parent of the header. + * @param [in] orientation The headers orientation. + * @param [in] parent The parent of the header. */ ParameterEditorHeaderView(Qt::Orientation orientation, QWidget* parent = 0); @@ -36,37 +36,37 @@ class ParameterEditorHeaderView : public QHeaderView /*! * The re-implemented paint section. * - * @param [in] painter The given painter. - * @param [in] rect The given rectangle. - * @param [in] logicalIndex Specifies the section. + * @param [in] painter The given painter. + * @param [in] rect The given rectangle. + * @param [in] logicalIndex Specifies the section. */ virtual void paintSection(QPainter *painter, const QRect &rect, int logicalIndex) const; /*! * Gets the description column. * - * @return The index of description column. + * @return The index of description column. */ virtual int descriptionColumn() const; /*! * Gets the value column. * - * @return The index of value column. + * @return The index of value column. */ virtual int valueColumn() const; /*! * Gets the maximum value column. * - * @return The index of maximum value column. + * @return The index of maximum value column. */ virtual int maximumColumn() const; /*! * Gets the column index for array right. * - * @return The index of array right column. + * @return The index of array right column. */ virtual int arrayRightColumn() const; diff --git a/editors/ComponentEditor/parameters/ParametersView.h b/editors/ComponentEditor/parameters/ParametersView.h index 44355fdbb..d5873e9ec 100644 --- a/editors/ComponentEditor/parameters/ParametersView.h +++ b/editors/ComponentEditor/parameters/ParametersView.h @@ -26,7 +26,7 @@ class ParametersView : public EditableTableView /*! * The constructor. * - * @param [in] parent Pointer to the owner of this view. + * @param [in] parent Pointer to the owner of this view. */ ParametersView(QWidget* parent); @@ -40,15 +40,15 @@ class ParametersView : public EditableTableView /*! * Recalculate references made to the parameters contained in the selected indexes. * - * @param [in] selectedIndexes The selected indexes. + * @param [in] selectedIndexes The selected indexes. */ void recalculateReferenceToIndexes(QModelIndexList selectedIndexes); /*! * Open the reference tree of the selected parameter. * - * @param [in] id The ID of the selected parameter. - * @param [in] name Name of the selected parameter. + * @param [in] id The ID of the selected parameter. + * @param [in] name Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& name); @@ -84,14 +84,14 @@ private slots: /*! * Add the recalculate references action to the context menu. * - * @param [in] menu The context menu for the actions. + * @param [in] menu The context menu for the actions. */ void addRecalculateReferencesActionForContextMenu(QMenu& menu); /*! * Add the open reference tree to the context menu. * - * @param [in] menu The context menu for the actions. + * @param [in] menu The context menu for the actions. */ void addOpenReferenceTreeActionForContextMenu(QMenu& menu); diff --git a/editors/ComponentEditor/parameters/parameterseditor.h b/editors/ComponentEditor/parameters/parameterseditor.h index 61b560695..a711523a2 100644 --- a/editors/ComponentEditor/parameters/parameterseditor.h +++ b/editors/ComponentEditor/parameters/parameterseditor.h @@ -37,13 +37,13 @@ class ParametersEditor : public ParameterItemEditor /*! * The constructor. * - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance managing the library. - * @param [in] parameterFinder Pointer to the instance searching for parameters. - * @param [in] expressionParser Expression parser for configurable elements. - * @param [in] expressionFormatter Pointer to the instance formatting the expressions. - * @param [in] parameterInterface Interface for accessing parameters. - * @param [in] parent Pointer to the owner of this widget. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance managing the library. + * @param [in] parameterFinder Pointer to the instance searching for parameters. + * @param [in] expressionParser Expression parser for configurable elements. + * @param [in] expressionFormatter Pointer to the instance formatting the expressions. + * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parent Pointer to the owner of this widget. */ ParametersEditor(QSharedPointer component, LibraryInterface* handler, diff --git a/editors/ComponentEditor/parameters/parametersmodel.h b/editors/ComponentEditor/parameters/parametersmodel.h index 1da878f0a..b91c4372f 100644 --- a/editors/ComponentEditor/parameters/parametersmodel.h +++ b/editors/ComponentEditor/parameters/parametersmodel.h @@ -39,10 +39,10 @@ class ParametersModel : public AbstractParameterModel /*! * The constructor * - * @param [in] parameterInterface Interface for accessing parameters. - * @param [in] expressionParser Expression parser for configurable elements. - * @param [in] parameterFinder The parameter finder. - * @param [in] parent The owner of this model. + * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] expressionParser Expression parser for configurable elements. + * @param [in] parameterFinder The parameter finder. + * @param [in] parent The owner of this model. */ ParametersModel(ParametersInterface* parameterInterface, QSharedPointer expressionParser, @@ -57,9 +57,9 @@ class ParametersModel : public AbstractParameterModel /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of columns currently in the model. + * @return Number of columns currently in the model. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; @@ -73,14 +73,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void onAddItem(QModelIndex const& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ virtual void onRemoveItem(QModelIndex const& index); @@ -89,105 +89,105 @@ public slots: /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int nameColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int displayNameColumn() const; /*! * Gets the column for value format. * - * @return The column for editing format selection. + * @return The column for editing format selection. */ virtual int typeColumn() const; /*! * Gets the column for the left value of bit width vector. * - * @return The column for editing the left value of the bit width vector. + * @return The column for editing the left value of the bit width vector. */ virtual int bitWidthLeftColumn() const; /*! * Gets the column for the right value of bit width vector. * - * @return The column for editing the right value of the bit width vector. + * @return The column for editing the right value of the bit width vector. */ virtual int bitWidthRightColumn() const; /*! * Gets the column for minimum value. * - * @return The column for editing the minimum value. + * @return The column for editing the minimum value. */ virtual int minimumColumn() const; /*! * Gets the column for maximum value. * - * @return The column for editing the maximum value. + * @return The column for editing the maximum value. */ virtual int maximumColumn() const; /*! * Gets the column for choices. * - * @return The column for editing choice selection. + * @return The column for editing choice selection. */ virtual int choiceColumn() const; /*! * Gets the column for values. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int valueColumn() const; /*! * Gets the column for resolve. * - * @return The column for editing value selection. + * @return The column for editing value selection. */ virtual int resolveColumn() const; /*! * Gets the column for array left. * - * @return The column for editing array left. + * @return The column for editing array left. */ virtual int arrayLeftColumn() const; /*! * Gets the column for array right. * - * @return The column for editing array right. + * @return The column for editing array right. */ virtual int arrayRightColumn() const; /*! * Gets the column for description. * - * @return The column for editing description. + * @return The column for editing description. */ virtual int descriptionColumn() const; /*! * Gets the column index for parameter ids. * - * @return The column index for parameter ids. + * @return The column index for parameter ids. */ virtual int idColumn() const; /*! * Gets the column index for usage count. * - * @return The column index for usage count. + * @return The column index for usage count. */ virtual int usageCountColumn() const; diff --git a/editors/ComponentEditor/ports/MasterPortsEditor.h b/editors/ComponentEditor/ports/MasterPortsEditor.h index 2f43c10f4..25e648b8c 100644 --- a/editors/ComponentEditor/ports/MasterPortsEditor.h +++ b/editors/ComponentEditor/ports/MasterPortsEditor.h @@ -46,13 +46,13 @@ class MasterPortsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance that manages the library. - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] editorConstructor Constructor for required modules. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance that manages the library. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] editorConstructor Constructor for required modules. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this widget. */ MasterPortsEditor(QSharedPointer component, LibraryInterface* handler, @@ -69,7 +69,7 @@ class MasterPortsEditor : public ItemEditor /*! * Check for the validity of the edited ports. * - * @return True if all ports are in valid state. + * @return True if all ports are in valid state. */ virtual bool isValid() const; @@ -81,30 +81,30 @@ class MasterPortsEditor : public ItemEditor /*! * Enable/disable the import/export csv functionality for the view. * - * @param [in] allow If true then import/export is enabled. + * @param [in] allow If true then import/export is enabled. */ void setAllowImportExport(bool allow); /*! * Sets the edited component. * - * @param [in] component The component whose ports to edit. + * @param [in] component The component whose ports to edit. */ void setComponent(QSharedPointer component); /*! * Get the port for the selected index. * - * @param [in] portIndex The selected index. + * @param [in] portIndex The selected index. * - * @return Port from the selected index. + * @return Port from the selected index. */ QSharedPointer getIndexedPort(QModelIndex const& portIndex) const; /*! * Get the current amount of visible ports in the editor. * - * @return The amount of visible ports. + * @return The amount of visible ports. */ int getAmountOfPorts() const; @@ -117,21 +117,21 @@ class MasterPortsEditor : public ItemEditor /*! * Handler for new interface creation for new bus definition. * - * @param [in] selectedPorts Ports to be mapped in the interface. + * @param [in] selectedPorts Ports to be mapped in the interface. */ void createNewInteface(QStringList const& selectedPorts); /*! * Handler for new interface creation for existing bus definition. * - * @param [in] selectedPorts Ports to be mapped in the interface. + * @param [in] selectedPorts Ports to be mapped in the interface. */ void createInterface(QStringList const& selectedPorts); /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] itemIndex Index of the selected port. + * @param [in] itemIndex Index of the selected port. */ void changeExtensionsEditorItem(QModelIndex const& itemIndex); @@ -155,8 +155,8 @@ private slots: /*! * Handle port creation from the selected abstraction definition of a bus interface. * - * @param [in] busName Name of the selected bus interface. - * @param [in] abstractionString VLNV string of the abstraction definition. + * @param [in] busName Name of the selected bus interface. + * @param [in] abstractionString VLNV string of the abstraction definition. */ void onCreatePortsFromAbstraction(std::string const& busName, QString const& abstractionString); diff --git a/editors/ComponentEditor/ports/PortSummaryDelegate.h b/editors/ComponentEditor/ports/PortSummaryDelegate.h index 4dfcac6c2..bf589bb79 100644 --- a/editors/ComponentEditor/ports/PortSummaryDelegate.h +++ b/editors/ComponentEditor/ports/PortSummaryDelegate.h @@ -32,11 +32,11 @@ class PortSummaryDelegate : public PortsDelegate /*! * The constructor. * - * @param [in] component Component containing the edited ports. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] typeValidator Validator for port type definitions. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited ports. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] typeValidator Validator for port type definitions. + * @param [in] parent The parent object. */ using PortsDelegate::PortsDelegate; @@ -50,16 +50,16 @@ class PortSummaryDelegate : public PortsDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ bool columnAcceptsExpression(int column) const final; /*! * Gets the description column. * - * @return Column number for description. + * @return Column number for description. */ int descriptionColumn() const final; @@ -68,42 +68,42 @@ class PortSummaryDelegate : public PortsDelegate /*! * Gets the name column. * - * @return Column number for name. + * @return Column number for name. */ int nameColumn() const final; /*! * Gets the type definitions column. * - * @return Column number for type definitions. + * @return Column number for type definitions. */ int typeColumn() const final; /*! * Gets the tag group column. * - * @return Column number for tag group. + * @return Column number for tag group. */ int tagColumn() const final; /*! * Gets the ad hoc column. * - * @return Column number for ad hoc. + * @return Column number for ad hoc. */ int adHocColumn() const final; /*! * Gets the array left column. * - * @return Column number for left value of the array. + * @return Column number for left value of the array. */ int arrayLeftColumn() const final; /*! * Gets the array right column. * - * @return Column number for right value of the array. + * @return Column number for right value of the array. */ int arrayRightColumn() const final; diff --git a/editors/ComponentEditor/ports/PortSummaryEditorFactory.h b/editors/ComponentEditor/ports/PortSummaryEditorFactory.h index 78c35a649..ae2760818 100644 --- a/editors/ComponentEditor/ports/PortSummaryEditorFactory.h +++ b/editors/ComponentEditor/ports/PortSummaryEditorFactory.h @@ -43,36 +43,36 @@ class PortSummaryEditorFactory : public PortsEditorFactory /*! * Construct a ports model. * - * @param [in] parent The owner of the constructed model. + * @param [in] parent The owner of the constructed model. * - * @return The created ports model. + * @return The created ports model. */ PortsModel* createModel(QObject* parent) const final; /*! * Construct a filter. * - * @param [in] parent Owner of the filter. + * @param [in] parent Owner of the filter. * - * @return The created ports filter. + * @return The created ports filter. */ PortsFilter* createFilter(QObject* parent) const final; /*! * Construct a view. * - * @param [in] parent Owner of the view. + * @param [in] parent Owner of the view. * - * @return The created view. + * @return The created view. */ PortsView* createView(QWidget* parent) const final; /*! * Construct a delegate. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. * - * @return The created delegate. + * @return The created delegate. */ PortsDelegate* createDelegate(QObject* parent) const final; diff --git a/editors/ComponentEditor/ports/PortSummaryFilter.h b/editors/ComponentEditor/ports/PortSummaryFilter.h index 5ef8382c7..6f60c5643 100644 --- a/editors/ComponentEditor/ports/PortSummaryFilter.h +++ b/editors/ComponentEditor/ports/PortSummaryFilter.h @@ -27,8 +27,8 @@ class PortSummaryFilter : public PortsFilter /*! * Constructor. * - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] parent The parent object. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] parent The parent object. */ using PortsFilter::PortsFilter; @@ -42,7 +42,7 @@ class PortSummaryFilter : public PortsFilter /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ int nameColumn() const final { @@ -52,9 +52,9 @@ class PortSummaryFilter : public PortsFilter /*! * Check if a port is filtered. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port is accepted, false otherwise. + * @return True, if the port is accepted, false otherwise. */ bool portIsAccepted(QString const& /*portName*/) const final { diff --git a/editors/ComponentEditor/ports/PortSummaryModel.h b/editors/ComponentEditor/ports/PortSummaryModel.h index 1455c1188..30198ae7a 100644 --- a/editors/ComponentEditor/ports/PortSummaryModel.h +++ b/editors/ComponentEditor/ports/PortSummaryModel.h @@ -26,10 +26,10 @@ class PortSummaryModel : public PortsModel /*! * The constructor. * - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] signalInterface Interface for accessing abstraction signals. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] signalInterface Interface for accessing abstraction signals. + * @param [in] parent Pointer to the owner of this model. */ PortSummaryModel(QSharedPointer parameterFinder, QSharedPointer portsInterface, @@ -44,41 +44,41 @@ class PortSummaryModel : public PortsModel /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * - * @return Always returns 9. + * @return Always returns 9. */ int columnCount(const QModelIndex& parent = QModelIndex() ) const final; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const final; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -93,7 +93,7 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * * return True, if column can have expressions, false otherwise. */ @@ -104,7 +104,7 @@ public slots: /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return Expression in the given index, or plain value. */ @@ -113,16 +113,16 @@ public slots: /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ QVariant formattedExpressionForIndex(QModelIndex const& index) const final; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return The data in the given index. */ @@ -134,92 +134,92 @@ public slots: /*! * Get the column for row number. * - * @return Row number column. + * @return Row number column. */ int rowNumberColumn() const final; /*! * Get the column for name. * - * @return Name column. + * @return Name column. */ int nameColumn() const final; /*! * Get the column for type definitions. * - * @return Type definitions column. + * @return Type definitions column. */ int typeColumn() const final; /*! * Get the column for array left. * - * @return Array left column. + * @return Array left column. */ int arrayLeftColumn() const final; /*! * Get the column for array right. * - * @return Array right column. + * @return Array right column. */ int arrayRightColum() const final; /*! * Get the column for tags. * - * @return Tags column. + * @return Tags column. */ int tagColumn() const final; /*! * Get the column for ad hoc visibility. * - * @return Ad hoc visibility column. + * @return Ad hoc visibility column. */ int adHocColumn() const final; /*! * Get the column for description. * - * @return Description column. + * @return Description column. */ int descriptionColumn() const final; /*! * Check if the selected item is disabled. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is disabled, false otherwise. + * @return True, if the indexed item is disabled, false otherwise. */ bool indexedItemIsDisabled(QModelIndex const& index) const final; /*! * Check if the selected item is mandatory. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is mandatory, false otherwise. + * @return True, if the indexed item is mandatory, false otherwise. */ bool indexedItemIsMandatory(QModelIndex const& index) const final; /*! * Check if the selected item is locked. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is locked, false otherwise. + * @return True, if the indexed item is locked, false otherwise. */ bool indexedItemIsLocked(QModelIndex const& index) const final; /*! * Get a list of the locked port indexes from the selected index. * - * @param [in] portIndex Index of the selected item. + * @param [in] portIndex Index of the selected item. * - * @return List of the locked port indexes. + * @return List of the locked port indexes. */ virtual QModelIndexList getLockedPortIndexes(QModelIndex const& portIndex) const final; diff --git a/editors/ComponentEditor/ports/PortSummaryView.h b/editors/ComponentEditor/ports/PortSummaryView.h index 4d93f73a8..611fef2ab 100644 --- a/editors/ComponentEditor/ports/PortSummaryView.h +++ b/editors/ComponentEditor/ports/PortSummaryView.h @@ -30,9 +30,9 @@ class PortSummaryView : public PortsView /*! * The constructor. * - * @param [in] nameColumn Name column index of. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent widget. + * @param [in] nameColumn Name column index of. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent widget. */ PortSummaryView(int nameColumn, BusInterfaceInterface* busInterface, QWidget *parent); diff --git a/editors/ComponentEditor/ports/PortTagEditorDelegate.h b/editors/ComponentEditor/ports/PortTagEditorDelegate.h index dd65d528e..30c61e5b2 100644 --- a/editors/ComponentEditor/ports/PortTagEditorDelegate.h +++ b/editors/ComponentEditor/ports/PortTagEditorDelegate.h @@ -26,8 +26,8 @@ class PortTagEditorDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] existingPortTags The port tags that have been given in other ports. - * @param [in] parent The owner of this delegate. + * @param [in] existingPortTags The port tags that have been given in other ports. + * @param [in] parent The owner of this delegate. */ PortTagEditorDelegate(QStringList existingPortTags, QObject* parent); @@ -39,11 +39,11 @@ class PortTagEditorDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner of the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner of the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; @@ -51,17 +51,17 @@ class PortTagEditorDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved into. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved into. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; diff --git a/editors/ComponentEditor/ports/PortTypeDefinitionDelegate.h b/editors/ComponentEditor/ports/PortTypeDefinitionDelegate.h index 9f4cbc53f..a9104a52c 100644 --- a/editors/ComponentEditor/ports/PortTypeDefinitionDelegate.h +++ b/editors/ComponentEditor/ports/PortTypeDefinitionDelegate.h @@ -27,7 +27,7 @@ class PortTypeDefinitionDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ explicit PortTypeDefinitionDelegate(QObject* parent = 0); @@ -39,11 +39,11 @@ class PortTypeDefinitionDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner of the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner of the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -51,17 +51,17 @@ class PortTypeDefinitionDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/ports/PortTypeDefinitionEditor.h b/editors/ComponentEditor/ports/PortTypeDefinitionEditor.h index 2c6af9753..6c0fedb69 100644 --- a/editors/ComponentEditor/ports/PortTypeDefinitionEditor.h +++ b/editors/ComponentEditor/ports/PortTypeDefinitionEditor.h @@ -28,8 +28,8 @@ class PortTypeDefinitionEditor : public ListEditor /*! * The constructor. * - * @param [in] indexedRow Index of the type for which this editor belongs to. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] indexedRow Index of the type for which this editor belongs to. + * @param [in] parent Pointer to the owner of this editor. */ PortTypeDefinitionEditor(QModelIndex const& indexedRow, QWidget* parent); @@ -43,7 +43,7 @@ class PortTypeDefinitionEditor : public ListEditor /*! * Informs of the closing of this editor. * - * @param [in] indexedRow Index of the containing type. + * @param [in] indexedRow Index of the containing type. */ void closingEditor(QModelIndex const& indexedRow); diff --git a/editors/ComponentEditor/ports/PortWireTypeDelegate.h b/editors/ComponentEditor/ports/PortWireTypeDelegate.h index 71ab1d7a8..7e051ac55 100644 --- a/editors/ComponentEditor/ports/PortWireTypeDelegate.h +++ b/editors/ComponentEditor/ports/PortWireTypeDelegate.h @@ -30,8 +30,8 @@ class PortWireTypeDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] component Component containing the edited ports. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited ports. + * @param [in] parent The parent object. */ PortWireTypeDelegate(QSharedPointer component, QObject* parent = 0); @@ -43,18 +43,18 @@ class PortWireTypeDelegate : public QStyledItemDelegate /*! * Set a new model for types. * - * @param [in] newModel The new type model. + * @param [in] newModel The new type model. */ void setNewModel(QAbstractItemModel* newModel); /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -62,50 +62,50 @@ class PortWireTypeDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Set a new component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void setComponent(QSharedPointer newComponent); /*! * Get the size requirement for the editor. * - * @param [in] option Style options for the editor. - * @param [in] index Index of the selected editor. + * @param [in] option Style options for the editor. + * @param [in] index Index of the selected editor. */ virtual QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Paint the indexed area. * - * @param [in] painter The painter. - * @param [in] option Style options of the area. - * @param [in] index The selected index. + * @param [in] painter The painter. + * @param [in] option Style options of the area. + * @param [in] index The selected index. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Update the geometry of the editor in the selected index. * - * @param [in] editor The contained editor. - * @param [in] option Style options for the area containing the editor. - * @param [in] index The selected index. + * @param [in] editor The contained editor. + * @param [in] option Style options for the area containing the editor. + * @param [in] index The selected index. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -115,8 +115,8 @@ class PortWireTypeDelegate : public QStyledItemDelegate /*! * Set the new type definitions for the selected type. * - * @param [in] typeIndex Index of the selected type. - * @param [in] newDefinitions The new type definitions. + * @param [in] typeIndex Index of the selected type. + * @param [in] newDefinitions The new type definitions. */ void setNewDefinitions(QModelIndex const& typeIndex, QStringList newDefinitions); @@ -130,7 +130,7 @@ private slots: /*! * Handles the closing of the type definition editor. * - * @param [in] editorIndex Index of the edited type. + * @param [in] editorIndex Index of the edited type. */ void onDefinitionEditorClosed(QModelIndex const& editorIndex); @@ -143,36 +143,36 @@ private slots: /*! * Creates a selector for port type with common VHDL and Verilog types as options. * - * @param [in] parent The parent widget for the selector. + * @param [in] parent The parent widget for the selector. * - * @return The selector for port type. + * @return The selector for port type. */ QWidget* createSelectorWithCommonTypes(QWidget* parent) const; /*! * Creates a selector for view reference with the components views as options. * - * @param [in] parent The parent widget for the selector. + * @param [in] parent The parent widget for the selector. * - * @return The selector for view reference. + * @return The selector for view reference. */ QWidget* createViewSelector(QWidget* parent) const; /*! * Creates an editor for port typedef with VHDL standard libraries as options. * - * @param [in] parent The parent widget for the selector. - * @param [in] index Index of the created definition editor. + * @param [in] parent The parent widget for the selector. + * @param [in] index Index of the created definition editor. * - * @return The editor for port typedef. + * @return The editor for port typedef. */ QWidget* createDefinitionEditor(QWidget* parent, QModelIndex const& index) const; /*! * Reposition and resize the selected editor. * - * @param [in] editor The selected editor. - * @param [in] option Style options for the area containing the selected editor. + * @param [in] editor The selected editor. + * @param [in] option Style options for the area containing the selected editor. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option) const; diff --git a/editors/ComponentEditor/ports/PortWireTypeEditor.h b/editors/ComponentEditor/ports/PortWireTypeEditor.h index d46a3aa76..126ef8ad4 100644 --- a/editors/ComponentEditor/ports/PortWireTypeEditor.h +++ b/editors/ComponentEditor/ports/PortWireTypeEditor.h @@ -35,9 +35,9 @@ class PortWireTypeEditor : public QScrollArea /*! * The constructor. * - * @param [in] component Component containing the edited port. - * @param [in] typeValidator Validator for the port type definitions. - * @param [in] parent The owner of the editor. + * @param [in] component Component containing the edited port. + * @param [in] typeValidator Validator for the port type definitions. + * @param [in] parent The owner of the editor. */ PortWireTypeEditor(QSharedPointer component, QSharedPointer typeValidator, QWidget* parent); @@ -50,14 +50,14 @@ class PortWireTypeEditor : public QScrollArea /*! * Set a new component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void setComponent(QSharedPointer newComponent); /*! * Set a new port for the port wire type model. * - * @param [in] newPort The selected port. + * @param [in] newPort The selected port. */ void setPortForModel(QSharedPointer newPort); diff --git a/editors/ComponentEditor/ports/PortWireTypeModel.h b/editors/ComponentEditor/ports/PortWireTypeModel.h index d6afe1ba1..75b5d9ff8 100644 --- a/editors/ComponentEditor/ports/PortWireTypeModel.h +++ b/editors/ComponentEditor/ports/PortWireTypeModel.h @@ -32,8 +32,8 @@ class PortWireTypeModel : public QAbstractItemModel /*! * The constructor. * - * @param [in] typeValidator Validator for port type definitions. - * @param [in] parent Pointer to the owner of this model. + * @param [in] typeValidator Validator for port type definitions. + * @param [in] parent Pointer to the owner of this model. */ PortWireTypeModel(QSharedPointer typeValidator, QObject *parent); @@ -45,84 +45,84 @@ class PortWireTypeModel : public QAbstractItemModel /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Always returns 2. + * @return Always returns 2. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted. - * @param [in] orientation Only Qt::Horizontal is supported. - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted. + * @param [in] orientation Only Qt::Horizontal is supported. + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted. * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified. - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified. + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Create an index for the identified item. * - * @param [in] row Row of the item. - * @param [in] column Column of the item. - * @param [in] parent Parent index of the item. + * @param [in] row Row of the item. + * @param [in] column Column of the item. + * @param [in] parent Parent index of the item. * - * @return The created model index. + * @return The created model index. */ QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex() ) const; /*! * Create a parent index for the selected item. * - * @param [in] child The selected item. + * @param [in] child The selected item. */ QModelIndex parent(const QModelIndex &child) const; /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Change the currently edited port. * - * @param [in] newPort The new port. + * @param [in] newPort The new port. */ void onChangePortSelection(QSharedPointer newPort); @@ -131,28 +131,28 @@ public slots: /*! * Handles the addition of new port types. * - * @param [in] indexList List of type indexes for creating new types. + * @param [in] indexList List of type indexes for creating new types. */ void onAddItems(QModelIndexList const& indexList); /*! * Handles the addition of new port type view references. * - * @param [in] indexList List of type indexes to contain the new view references. + * @param [in] indexList List of type indexes to contain the new view references. */ void onAddViewReferences(QModelIndexList const& indexList); /*! * Handles the removal of items from the model. * - * @param [in] indexList Identifies the items that should be removed. + * @param [in] indexList Identifies the items that should be removed. */ void onRemoveSelectedItems(QModelIndexList const& indexList); /*! * Handles the removal of all the view references from the selected types. * - * @param [in] indexList Identifies the type containing the removed view references. + * @param [in] indexList Identifies the type containing the removed view references. */ void onRemoveAllViewsFromSelectedTypes(QModelIndexList const& indexList); @@ -182,35 +182,35 @@ public slots: /*! * Get the view references of the selected port type. * - * @param [in] typeIndex Index of the selected type. + * @param [in] typeIndex Index of the selected type. * - * @return The list of view references of the selected port type. + * @return The list of view references of the selected port type. */ QSharedPointer getViewsForType(QModelIndex const& typeIndex) const; /*! * Get the type definitions of the selected port type. * - * @param [in] typeIndex Index of the selected type. + * @param [in] typeIndex Index of the selected type. * - * @return The list of type definitions of the selected port type. + * @return The list of type definitions of the selected port type. */ QSharedPointer getTypeDefinitionsForType(QModelIndex const& typeIndex) const; /*! * Get the selected wire type definition. * - * @param [in] index Index of the selected wire type definition. + * @param [in] index Index of the selected wire type definition. */ QSharedPointer getIndexedWireTypeDefinition(QModelIndex index) const; /*! * Get the color for valid and invalid indexes. * - * @param [in] index The selected index. - * @param [in] typeDefinition The indexed type definition. + * @param [in] index The selected index. + * @param [in] typeDefinition The indexed type definition. * - * @return Black color for valid indexes, red for invalid. + * @return Black color for valid indexes, red for invalid. */ QVariant blackForValidRedForInvalid(QModelIndex const& index, QSharedPointer typeDefinition) const; @@ -218,8 +218,8 @@ public slots: /*! * Validate the selected index. * - * @param [in] index The selected index. - * @param [in] typeDefinition The indexed type definition. + * @param [in] index The selected index. + * @param [in] typeDefinition The indexed type definition. */ bool validateIndex(QModelIndex const& index, QSharedPointer typeDefinition) const; diff --git a/editors/ComponentEditor/ports/PortWireTypeView.h b/editors/ComponentEditor/ports/PortWireTypeView.h index 107f81a77..b6c682935 100644 --- a/editors/ComponentEditor/ports/PortWireTypeView.h +++ b/editors/ComponentEditor/ports/PortWireTypeView.h @@ -26,7 +26,7 @@ class PortWireTypeView : public EditableTreeView /*! * The constructor. * - * @param [in] parent Pointer to the owner of this view. + * @param [in] parent Pointer to the owner of this view. */ PortWireTypeView(QWidget* parent); @@ -47,7 +47,7 @@ class PortWireTypeView : public EditableTreeView /*! * Handles the context menu events. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event); diff --git a/editors/ComponentEditor/ports/PortsEditorFactory.h b/editors/ComponentEditor/ports/PortsEditorFactory.h index 6535c690f..b74ee6523 100644 --- a/editors/ComponentEditor/ports/PortsEditorFactory.h +++ b/editors/ComponentEditor/ports/PortsEditorFactory.h @@ -69,36 +69,36 @@ class PortsEditorFactory /*! * Construct a ports model. * - * @param [in] parent The owner of the constructed model. + * @param [in] parent The owner of the constructed model. * - * @return The created ports model. + * @return The created ports model. */ virtual PortsModel* createModel(QObject* parent = 0) const = 0; /*! * Construct a filter. * - * @param [in] parent Owner of the filter. + * @param [in] parent Owner of the filter. * - * @return The created ports filter. + * @return The created ports filter. */ virtual PortsFilter* createFilter(QObject* parent) const = 0; /*! * Construct a view. * - * @param [in] parent Owner of the view. + * @param [in] parent Owner of the view. * - * @return The created view. + * @return The created view. */ virtual PortsView* createView(QWidget* parent) const = 0; /*! * Construct a delegate. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. * - * @return The created delegate. + * @return The created delegate. */ virtual PortsDelegate* createDelegate(QObject* parent) const = 0; diff --git a/editors/ComponentEditor/ports/PortsFilter.h b/editors/ComponentEditor/ports/PortsFilter.h index a48b6b96b..a47851971 100644 --- a/editors/ComponentEditor/ports/PortsFilter.h +++ b/editors/ComponentEditor/ports/PortsFilter.h @@ -29,8 +29,8 @@ class PortsFilter : public QSortFilterProxyModel /*! * Constructor. * - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] parent The parent object. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] parent The parent object. */ PortsFilter(QSharedPointer portInterface, QObject* parent = 0); @@ -51,7 +51,7 @@ public slots: /*! * Handle the item change for the extensions editor. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. */ void onHandleExtensionsEditorItemChange(QModelIndex const& index); @@ -60,7 +60,7 @@ public slots: /*! * Change the item in the extensions editor. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. */ void changeExtensionsEditorItem(QModelIndex const& index); @@ -69,17 +69,17 @@ public slots: /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const override; /*! * Get the interface for accessing the component ports. * - * @return Interface for accessing the component ports. + * @return Interface for accessing the component ports. */ QSharedPointer getInterface() const; @@ -88,16 +88,16 @@ public slots: /*! * Get the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const = 0; /*! * Check if a port is filtered. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port is accepted, false otherwise. + * @return True, if the port is accepted, false otherwise. */ virtual bool portIsAccepted(QString const& portName) const = 0; diff --git a/editors/ComponentEditor/ports/PortsView.h b/editors/ComponentEditor/ports/PortsView.h index c25ec56c5..d2b1e6e51 100644 --- a/editors/ComponentEditor/ports/PortsView.h +++ b/editors/ComponentEditor/ports/PortsView.h @@ -32,9 +32,9 @@ class PortsView : public EditableTableView /*! * The constructor. * - * @param [in] nameColumn Name column index of. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent widget. + * @param [in] nameColumn Name column index of. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent widget. */ PortsView(int nameColumn, BusInterfaceInterface* busInterface, QWidget *parent); @@ -52,15 +52,15 @@ class PortsView : public EditableTableView /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] itemIndex Index of the selected port. + * @param [in] itemIndex Index of the selected port. */ void changeExtensionsEditorItem(QModelIndex const& itemIndex); /*! * Create ports from the signals of the selected abstraction definition. * - * @param [in] busName Name of the bus interface containing the abstraction definition. - * @param [in] abstractionVLNV VLNV string of the selected abstraction definition. + * @param [in] busName Name of the bus interface containing the abstraction definition. + * @param [in] abstractionVLNV VLNV string of the selected abstraction definition. */ void createPortsFromAbstraction(std::string const& busName, QString const& abstractionVLNV); @@ -95,8 +95,8 @@ private slots: /*! * Handler for index change events. * - * @param [in] current The current index. - * @param [in] previous The previous index. + * @param [in] current The current index. + * @param [in] previous The previous index. */ virtual void currentChanged(const QModelIndex ¤t, const QModelIndex &previous); diff --git a/editors/ComponentEditor/ports/TransactionalPortsDelegate.h b/editors/ComponentEditor/ports/TransactionalPortsDelegate.h index a0066ffc4..f1b97105e 100644 --- a/editors/ComponentEditor/ports/TransactionalPortsDelegate.h +++ b/editors/ComponentEditor/ports/TransactionalPortsDelegate.h @@ -32,11 +32,11 @@ class TransactionalPortsDelegate : public PortsDelegate /*! * The constructor. * - * @param [in] component Component containing the edited ports. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] typeValidator Validator for port type definitions. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited ports. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] typeValidator Validator for port type definitions. + * @param [in] parent The parent object. */ TransactionalPortsDelegate(QSharedPointer component, QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QSharedPointer typeValidator, @@ -50,11 +50,11 @@ class TransactionalPortsDelegate : public PortsDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -62,17 +62,17 @@ class TransactionalPortsDelegate : public PortsDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -85,16 +85,16 @@ class TransactionalPortsDelegate : public PortsDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the description column. * - * @return Column number for description. + * @return Column number for description. */ virtual int descriptionColumn() const; @@ -103,69 +103,69 @@ class TransactionalPortsDelegate : public PortsDelegate /*! * Gets the name column. * - * @return Column number for name. + * @return Column number for name. */ virtual int nameColumn() const; /*! * Gets the type definitions column. * - * @return Column number for type definitions. + * @return Column number for type definitions. */ virtual int typeColumn() const; /*! * Gets the tag group column. * - * @return Column number for tag group. + * @return Column number for tag group. */ virtual int tagColumn() const; /*! * Gets the ad hoc column. * - * @return Column number for ad hoc. + * @return Column number for ad hoc. */ virtual int adHocColumn() const; /*! * Gets the array left column. * - * @return Column number for left value of the array. + * @return Column number for left value of the array. */ virtual int arrayLeftColumn() const; /*! * Gets the array right column. * - * @return Column number for right value of the array. + * @return Column number for right value of the array. */ virtual int arrayRightColumn() const; /*! * Creates a selector for port initiative. * - * @param [in] parent The parent widget for the selector. + * @param [in] parent The parent widget for the selector. * - * @return The selector for port initiative. + * @return The selector for port initiative. */ QWidget* createSelectorForInitiative(QWidget* parent) const; /*! * Creates a selector for port kind. * - * @param [in] parent The parent widget for the selector. + * @param [in] parent The parent widget for the selector. * - * @return The selector for port kind. + * @return The selector for port kind. */ QWidget* createSelectorForKind(QWidget* parent) const; /*! * Creates an editor for port protocol. * - * @param [in] parent The parent widget for the editor. + * @param [in] parent The parent widget for the editor. * - * @return The editor for port protocol. + * @return The editor for port protocol. */ QWidget* createProtocolEditor(QWidget* parent) const; }; diff --git a/editors/ComponentEditor/ports/TransactionalPortsEditorFactory.h b/editors/ComponentEditor/ports/TransactionalPortsEditorFactory.h index de8ae3862..3002b3132 100644 --- a/editors/ComponentEditor/ports/TransactionalPortsEditorFactory.h +++ b/editors/ComponentEditor/ports/TransactionalPortsEditorFactory.h @@ -43,36 +43,36 @@ class TransactionalPortsEditorFactory : public PortsEditorFactory /*! * Construct a ports model. * - * @param [in] parent The owner of the constructed model. + * @param [in] parent The owner of the constructed model. * - * @return The created ports model. + * @return The created ports model. */ PortsModel* createModel(QObject* parent = 0) const final; /*! * Construct a filter. * - * @param [in] parent Owner of the filter. + * @param [in] parent Owner of the filter. * - * @return The created ports filter. + * @return The created ports filter. */ PortsFilter* createFilter(QObject* parent = 0) const final; /*! * Construct a view. * - * @param [in] parent Owner of the view. + * @param [in] parent Owner of the view. * - * @return The created view. + * @return The created view. */ PortsView* createView(QWidget* parent) const final; /*! * Construct a delegate. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. * - * @return The created delegate. + * @return The created delegate. */ PortsDelegate* createDelegate(QObject* parent) const final; diff --git a/editors/ComponentEditor/ports/TransactionalPortsFilter.h b/editors/ComponentEditor/ports/TransactionalPortsFilter.h index a19cbf95e..3df817cc0 100644 --- a/editors/ComponentEditor/ports/TransactionalPortsFilter.h +++ b/editors/ComponentEditor/ports/TransactionalPortsFilter.h @@ -26,8 +26,8 @@ class TransactionalPortsFilter : public PortsFilter /*! * Constructor. * - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] parent The parent object. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] parent The parent object. */ TransactionalPortsFilter(QSharedPointer portInterface, QObject* parent = 0); @@ -45,16 +45,16 @@ class TransactionalPortsFilter : public PortsFilter /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Check if a port is filtered. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port is accepted, false otherwise. + * @return True, if the port is accepted, false otherwise. */ virtual bool portIsAccepted(QString const& portName) const override final; }; diff --git a/editors/ComponentEditor/ports/TransactionalPortsModel.h b/editors/ComponentEditor/ports/TransactionalPortsModel.h index 3abc92f33..2cd224c3d 100644 --- a/editors/ComponentEditor/ports/TransactionalPortsModel.h +++ b/editors/ComponentEditor/ports/TransactionalPortsModel.h @@ -26,10 +26,10 @@ class TransactionalPortsModel : public PortsModel /*! * The constructor. * - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] signalInterface Interface for accessing abstraction signals. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] signalInterface Interface for accessing abstraction signals. + * @param [in] parent Pointer to the owner of this model. */ TransactionalPortsModel(QSharedPointer parameterFinder, QSharedPointer portsInterface, @@ -44,41 +44,41 @@ class TransactionalPortsModel : public PortsModel /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * - * @return Always returns 9. + * @return Always returns 9. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); @@ -91,7 +91,7 @@ class TransactionalPortsModel : public PortsModel /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * * return True, if column can have expressions, false otherwise. */ @@ -102,7 +102,7 @@ class TransactionalPortsModel : public PortsModel /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return Expression in the given index, or plain value. */ @@ -111,25 +111,25 @@ class TransactionalPortsModel : public PortsModel /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const override final; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const override final; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return The data in the given index. */ @@ -138,7 +138,7 @@ class TransactionalPortsModel : public PortsModel /*! * Validates the data in the cell given by the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * * return True, if the data in the parameter is valid, false otherwise. */ @@ -149,92 +149,92 @@ class TransactionalPortsModel : public PortsModel /*! * Get the column for row number. * - * @return Row number column. + * @return Row number column. */ virtual int rowNumberColumn() const override final; /*! * Get the column for name. * - * @return Name column. + * @return Name column. */ virtual int nameColumn() const override final; /*! * Get the column for type definitions. * - * @return Type definitions column. + * @return Type definitions column. */ virtual int typeColumn() const override final; /*! * Get the column for array left. * - * @return Array left column. + * @return Array left column. */ virtual int arrayLeftColumn() const override final; /*! * Get the column for array right. * - * @return Array right column. + * @return Array right column. */ virtual int arrayRightColum() const override final; /*! * Get the column for tags. * - * @return Tags column. + * @return Tags column. */ virtual int tagColumn() const override final; /*! * Get the column for ad hoc visibility. * - * @return Ad hoc visibility column. + * @return Ad hoc visibility column. */ virtual int adHocColumn() const override final; /*! * Get the column for description. * - * @return Description column. + * @return Description column. */ virtual int descriptionColumn() const override final; /*! * Check if the selected item is disabled. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is disabled, false otherwise. + * @return True, if the indexed item is disabled, false otherwise. */ virtual bool indexedItemIsDisabled(QModelIndex const& index) const override final; /*! * Check if the selected item is mandatory. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is mandatory, false otherwise. + * @return True, if the indexed item is mandatory, false otherwise. */ virtual bool indexedItemIsMandatory(QModelIndex const& index) const override final; /*! * Check if the selected item is locked. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is locked, false otherwise. + * @return True, if the indexed item is locked, false otherwise. */ virtual bool indexedItemIsLocked(QModelIndex const& index) const override final; /*! * Get a list of the locked port indexes from the selected index. * - * @param [in] portIndex Index of the selected item. + * @param [in] portIndex Index of the selected item. * - * @return List of the locked port indexes. + * @return List of the locked port indexes. */ virtual QModelIndexList getLockedPortIndexes(QModelIndex const& portIndex) const override final; diff --git a/editors/ComponentEditor/ports/TypedPortEditor.h b/editors/ComponentEditor/ports/TypedPortEditor.h index 694b9aa04..62055a034 100644 --- a/editors/ComponentEditor/ports/TypedPortEditor.h +++ b/editors/ComponentEditor/ports/TypedPortEditor.h @@ -44,13 +44,13 @@ class TypedPortEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance that manages the library. - * @param [in] editorFactory The factory for creating editor content. - * @param [in] portType Type of the edited ports: wire/transactional/structured. - * @param [in] portsInterface Interface for accessing ports. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance that manages the library. + * @param [in] editorFactory The factory for creating editor content. + * @param [in] portType Type of the edited ports: wire/transactional/structured. + * @param [in] portsInterface Interface for accessing ports. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this widget. */ TypedPortEditor(QSharedPointer component, LibraryInterface* handler, @@ -68,7 +68,7 @@ class TypedPortEditor : public ItemEditor /*! * Check for the validity of the edited ports. * - * @return True if all ports are in valid state. + * @return True if all ports are in valid state. */ bool isValid() const; @@ -80,7 +80,7 @@ class TypedPortEditor : public ItemEditor /*! * Enable/disable the import/export csv functionality for the view. * - * @param [in] allow If true then import/export is enabled. + * @param [in] allow If true then import/export is enabled. */ void setAllowImportExport(bool allow); @@ -103,21 +103,21 @@ private slots: /*! * Handler for new interface creation for new bus definition. * - * @param [in] selectedPorts Ports to be mapped in the interface. + * @param [in] selectedPorts Ports to be mapped in the interface. */ void onCreateNewInteface(QStringList const& selectedPorts); /*! * Handler for new interface creation for existing bus definition. * - * @param [in] selectedPorts Ports to be mapped in the interface. + * @param [in] selectedPorts Ports to be mapped in the interface. */ void onCreateInterface(QStringList const& selectedPorts); /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] itemIndex Index of the selected port. + * @param [in] itemIndex Index of the selected port. */ void changeExtensionsEditorItem(QModelIndex const& itemIndex); @@ -127,8 +127,8 @@ private slots: /*! * Open the bus interface wizard. * - * @param [in] busIf The new bus interface. - * @param [in] wizard The selected interface wizard. + * @param [in] busIf The new bus interface. + * @param [in] wizard The selected interface wizard. */ void openBusInterfaceWizard(QSharedPointer busIf, BusInterfaceWizard& wizard); diff --git a/editors/ComponentEditor/ports/WirePortsDelegate.h b/editors/ComponentEditor/ports/WirePortsDelegate.h index d52eeb4f7..a132a3200 100644 --- a/editors/ComponentEditor/ports/WirePortsDelegate.h +++ b/editors/ComponentEditor/ports/WirePortsDelegate.h @@ -32,11 +32,11 @@ class WirePortsDelegate : public PortsDelegate /*! * The constructor. * - * @param [in] component Component containing the edited ports. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] typeValidator Validator for port type definitions. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited ports. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] typeValidator Validator for port type definitions. + * @param [in] parent The parent object. */ WirePortsDelegate(QSharedPointer component, QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QSharedPointer typeValidator, @@ -50,11 +50,11 @@ class WirePortsDelegate : public PortsDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -62,17 +62,17 @@ class WirePortsDelegate : public PortsDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index sModel index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index sModel index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -85,16 +85,16 @@ class WirePortsDelegate : public PortsDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the description column. * - * @return Column number for description. + * @return Column number for description. */ virtual int descriptionColumn() const; @@ -103,51 +103,51 @@ class WirePortsDelegate : public PortsDelegate /*! * Gets the name column. * - * @return Column number for name. + * @return Column number for name. */ virtual int nameColumn() const; /*! * Gets the type definitions column. * - * @return Column number for type definitions. + * @return Column number for type definitions. */ virtual int typeColumn() const; /*! * Gets the tag group column. * - * @return Column number for tag group. + * @return Column number for tag group. */ virtual int tagColumn() const; /*! * Gets the ad hoc column. * - * @return Column number for ad hoc. + * @return Column number for ad hoc. */ virtual int adHocColumn() const; /*! * Gets the array left column. * - * @return Column number for left value of the array. + * @return Column number for left value of the array. */ virtual int arrayLeftColumn() const; /*! * Gets the array right column. * - * @return Column number for right value of the array. + * @return Column number for right value of the array. */ virtual int arrayRightColumn() const; /*! * Creates a selector for port direction. * - * @param [in] parent The parent widget for the selector. + * @param [in] parent The parent widget for the selector. * - * @return The selector for port direction. + * @return The selector for port direction. */ QWidget* createSelectorForDirection(QWidget* parent) const; }; diff --git a/editors/ComponentEditor/ports/WirePortsEditorFactory.h b/editors/ComponentEditor/ports/WirePortsEditorFactory.h index d1f52b926..cfcc6d4f8 100644 --- a/editors/ComponentEditor/ports/WirePortsEditorFactory.h +++ b/editors/ComponentEditor/ports/WirePortsEditorFactory.h @@ -44,36 +44,36 @@ class WirePortsEditorFactory : public PortsEditorFactory /*! * Construct a ports model. * - * @param [in] parent The owner of the constructed model. + * @param [in] parent The owner of the constructed model. * - * @return The created ports model. + * @return The created ports model. */ PortsModel* createModel(QObject* parent = 0) const final; /*! * Construct a filter. * - * @param [in] parent Owner of the filter. + * @param [in] parent Owner of the filter. * - * @return The created ports filter. + * @return The created ports filter. */ PortsFilter* createFilter(QObject* parent) const final; /*! * Construct a view. * - * @param [in] parent Owner of the view. + * @param [in] parent Owner of the view. * - * @return The created view. + * @return The created view. */ PortsView* createView(QWidget* parent) const final; /*! * Construct a delegate. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. * - * @return The created delegate. + * @return The created delegate. */ PortsDelegate* createDelegate(QObject* parent) const final; }; diff --git a/editors/ComponentEditor/ports/WirePortsFilter.h b/editors/ComponentEditor/ports/WirePortsFilter.h index a2822a414..32c7edb60 100644 --- a/editors/ComponentEditor/ports/WirePortsFilter.h +++ b/editors/ComponentEditor/ports/WirePortsFilter.h @@ -26,8 +26,8 @@ class WirePortsFilter : public PortsFilter /*! * Constructor. * - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] parent The parent object. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] parent The parent object. */ WirePortsFilter(QSharedPointer portInterface, QObject* parent = 0); @@ -45,16 +45,16 @@ class WirePortsFilter : public PortsFilter /*! * Get the index of the name column. * - * @return Index of the name column. + * @return Index of the name column. */ virtual int nameColumn() const override final; /*! * Check if a port is filtered. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the port is accepted, false otherwise. + * @return True, if the port is accepted, false otherwise. */ virtual bool portIsAccepted(QString const& portName) const override final; }; diff --git a/editors/ComponentEditor/ports/WirePortsModel.h b/editors/ComponentEditor/ports/WirePortsModel.h index 704d7b3e1..8be3e628c 100644 --- a/editors/ComponentEditor/ports/WirePortsModel.h +++ b/editors/ComponentEditor/ports/WirePortsModel.h @@ -26,10 +26,10 @@ class WirePortsModel : public PortsModel /*! * The constructor. * - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] portsInterface Interface for accessing the component ports. - * @param [in] signalInterface Interface for accessing abstraction signals. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] portsInterface Interface for accessing the component ports. + * @param [in] signalInterface Interface for accessing abstraction signals. + * @param [in] parent Pointer to the owner of this model. */ WirePortsModel(QSharedPointer parameterFinder, QSharedPointer portsInterface, @@ -44,41 +44,41 @@ class WirePortsModel : public PortsModel /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * - * @return Always returns 9. + * @return Always returns 9. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); @@ -91,7 +91,7 @@ class WirePortsModel : public PortsModel /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * * return True, if column can have expressions, false otherwise. */ @@ -102,7 +102,7 @@ class WirePortsModel : public PortsModel /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return Expression in the given index, or plain value. */ @@ -111,25 +111,25 @@ class WirePortsModel : public PortsModel /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const override final; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const override final; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return The data in the given index. */ @@ -138,7 +138,7 @@ class WirePortsModel : public PortsModel /*! * Validates the data in the cell given by the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * * return True, if the data in the parameter is valid, false otherwise. */ @@ -149,92 +149,92 @@ class WirePortsModel : public PortsModel /*! * Get the column for row number. * - * @return Row number column. + * @return Row number column. */ virtual int rowNumberColumn() const override final; /*! * Get the column for name. * - * @return Name column. + * @return Name column. */ virtual int nameColumn() const override final; /*! * Get the column for type definitions. * - * @return Type definitions column. + * @return Type definitions column. */ virtual int typeColumn() const override final; /*! * Get the column for array left. * - * @return Array left column. + * @return Array left column. */ virtual int arrayLeftColumn() const override final; /*! * Get the column for array right. * - * @return Array right column. + * @return Array right column. */ virtual int arrayRightColum() const override final; /*! * Get the column for tags. * - * @return Tags column. + * @return Tags column. */ virtual int tagColumn() const override final; /*! * Get the column for ad hoc visibility. * - * @return Ad hoc visibility column. + * @return Ad hoc visibility column. */ virtual int adHocColumn() const override final; /*! * Get the column for description. * - * @return Description column. + * @return Description column. */ virtual int descriptionColumn() const override final; /*! * Check if the selected item is disabled. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is disabled, false otherwise. + * @return True, if the indexed item is disabled, false otherwise. */ virtual bool indexedItemIsDisabled(QModelIndex const& index) const override final; /*! * Check if the selected item is mandatory. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is mandatory, false otherwise. + * @return True, if the indexed item is mandatory, false otherwise. */ virtual bool indexedItemIsMandatory(QModelIndex const& index) const override final; /*! * Check if the selected item is locked. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is locked, false otherwise. + * @return True, if the indexed item is locked, false otherwise. */ virtual bool indexedItemIsLocked(QModelIndex const& index) const override final; /*! * Get a list of the locked port indexes from the selected index. * - * @param [in] portIndex Index of the selected item. + * @param [in] portIndex Index of the selected item. * - * @return List of the locked port indexes. + * @return List of the locked port indexes. */ virtual QModelIndexList getLockedPortIndexes(QModelIndex const& portIndex) const override final; diff --git a/editors/ComponentEditor/ports/portsdelegate.h b/editors/ComponentEditor/ports/portsdelegate.h index 7c09704bb..2aeab5190 100644 --- a/editors/ComponentEditor/ports/portsdelegate.h +++ b/editors/ComponentEditor/ports/portsdelegate.h @@ -33,11 +33,11 @@ class PortsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] component Component containing the edited ports. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] typeValidator Validator for port type definitions. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited ports. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] typeValidator Validator for port type definitions. + * @param [in] parent The parent object. */ PortsDelegate(QSharedPointer component, QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QSharedPointer typeValidator, @@ -51,11 +51,11 @@ class PortsDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -63,17 +63,17 @@ class PortsDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -81,18 +81,18 @@ class PortsDelegate : public ExpressionDelegate /*! * Renders an item in the given index. * - * @param [in] painter The painter to use for rendering. - * @param [in] option The style options for the rendering. - * @param [in] index The index to the data being rendered. + * @param [in] painter The painter to use for rendering. + * @param [in] option The style options for the rendering. + * @param [in] index The index to the data being rendered. */ virtual void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -100,7 +100,7 @@ class PortsDelegate : public ExpressionDelegate /*! * Set a new component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void setComponent(QSharedPointer newComponent); @@ -120,12 +120,12 @@ class PortsDelegate : public ExpressionDelegate /*! * Handler for preprocessing events that starts editing. * - * @param [in] event The event that triggered the editing. - * @param [in] model The underlying model to edit. - * @param [in] option Style options for rendering the item. - * @param [in] index The index being edited. + * @param [in] event The event that triggered the editing. + * @param [in] model The underlying model to edit. + * @param [in] option Style options for rendering the item. + * @param [in] index The index being edited. * - * @return True, if the delegate handles the event, otherwise false. + * @return True, if the delegate handles the event, otherwise false. */ virtual bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); @@ -133,16 +133,16 @@ class PortsDelegate : public ExpressionDelegate /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the description column. * - * @return Description column index. + * @return Description column index. */ virtual int descriptionColumn() const = 0; @@ -151,70 +151,70 @@ class PortsDelegate : public ExpressionDelegate /*! * Get the name column index. * - * @return Name column index. + * @return Name column index. */ virtual int nameColumn() const = 0; /*! * Get the type definition column index. * - * @return Type definition column index. + * @return Type definition column index. */ virtual int typeColumn() const = 0; /*! * Get the tag group column index. * - * @return Tag group column index. + * @return Tag group column index. */ virtual int tagColumn() const = 0; /*! * Get the adhoc column index. * - * @return Adhoc column index. + * @return Adhoc column index. */ virtual int adHocColumn() const = 0; /*! * Get the array left column index. * - * @return Array left column index. + * @return Array left column index. */ virtual int arrayLeftColumn() const = 0; /*! * Get the array right column index. * - * @return Array right column index. + * @return Array right column index. */ virtual int arrayRightColumn() const = 0; /*! * Creates a port type editor. * - * @param [in] parent Parent widget for the editor. + * @param [in] parent Parent widget for the editor. * - * @return The editor for port types. + * @return The editor for port types. */ QWidget* createTypeEditor(QWidget* parent) const; /*! * Create a list editor used in defining tags for the ports. * - * @param [in] currentIndex The currently selected index. - * @param [in] parent The owner of the new editor. + * @param [in] currentIndex The currently selected index. + * @param [in] parent The owner of the new editor. * - * @return The list editor for port tags. + * @return The list editor for port tags. */ QWidget* createListEditorForPortTags(const QModelIndex& currentIndex, QWidget* parent) const; /*! * Reposition and resize the selected editor. * - * @param [in] editor The selected editor. - * @param [in] option Style options for the area containing the editor. - * @param [in] index Index of the editor. + * @param [in] editor The selected editor. + * @param [in] option Style options for the area containing the editor. + * @param [in] index Index of the editor. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -222,7 +222,7 @@ class PortsDelegate : public ExpressionDelegate /*! * Get the row count for the port type editor. * - * @param [in] index Index of the selected port. + * @param [in] index Index of the selected port. */ int getRowCountForPortTypes(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/ports/portseditor.h b/editors/ComponentEditor/ports/portseditor.h index ec12c144d..2d0525c03 100644 --- a/editors/ComponentEditor/ports/portseditor.h +++ b/editors/ComponentEditor/ports/portseditor.h @@ -41,13 +41,13 @@ class PortsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance that manages the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] portValidator Validator used for ports. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance that manages the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] portValidator Validator used for ports. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this widget. */ PortsEditor(QSharedPointer component, LibraryInterface* handler, @@ -65,7 +65,7 @@ class PortsEditor : public ItemEditor /*! * Check for the validity of the edited ports. * - * @return True if all ports are in valid state. + * @return True if all ports are in valid state. */ bool isValid() const; @@ -77,7 +77,7 @@ class PortsEditor : public ItemEditor /*! * Sets the edited component. * - * @param [in] component The component whose ports to edit. + * @param [in] component The component whose ports to edit. */ void setComponent(QSharedPointer component); @@ -100,7 +100,7 @@ private slots: /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] itemIndex Index of the selected port. + * @param [in] itemIndex Index of the selected port. */ void changeExtensionsEditorItem(QModelIndex const& itemIndex); diff --git a/editors/ComponentEditor/ports/portsmodel.h b/editors/ComponentEditor/ports/portsmodel.h index 10088a35a..5903e8772 100644 --- a/editors/ComponentEditor/ports/portsmodel.h +++ b/editors/ComponentEditor/ports/portsmodel.h @@ -40,10 +40,10 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * The constructor. * - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] portInterface Interface for accessing the component ports. - * @param [in] signalInterface Interface for accessing abstraction signals. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] portInterface Interface for accessing the component ports. + * @param [in] signalInterface Interface for accessing abstraction signals. + * @param [in] parent Pointer to the owner of this model. */ PortsModel(QSharedPointer parameterFinder, QSharedPointer portInterface, @@ -58,66 +58,66 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid. + * @param [in] parent Model index of the parent of the item. Must be invalid. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Check if the model is in valid state or not. * - * @return True if all items in model are valid. + * @return True if all items in model are valid. */ bool isValid() const; /*! * Get the index of the identified port. * - * @param [in] portName Name of the identified port. + * @param [in] portName Name of the identified port. * - * @return QModelIndex of first column of the specified port. Invalid index if named port is not found. + * @return QModelIndex of first column of the specified port. Invalid index if named port is not found. */ virtual QModelIndex index(QString const& portName) const; @@ -129,10 +129,10 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Handle port creation from abstraction definition signals. * - * @param [in] abstraction The selected abstraction definition. - * @param [in] busMode Interface mode of the selected bus interface. - * @param [in] busMonitorMode Monitored bus interface of the selected bus interface. - * @param [in] systemGroup System group of the selected bus interface. + * @param [in] abstraction The selected abstraction definition. + * @param [in] busMode Interface mode of the selected bus interface. + * @param [in] busMonitorMode Monitored bus interface of the selected bus interface. + * @param [in] systemGroup System group of the selected bus interface. */ void onCreatePortsFromAbstraction(QSharedPointer abstraction, General::InterfaceMode const& busMode, @@ -148,14 +148,14 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the used port interface. * - * @return The port interface. + * @return The port interface. */ QSharedPointer getInterface() const; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * * return True, if column can have expressions, false otherwise. */ @@ -166,7 +166,7 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return Expression in the given index, or plain value. */ @@ -175,25 +175,25 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get the formatted value of an expression in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The formatted value of an expression in the selected index. + * @return The formatted value of an expression in the selected index. */ virtual QVariant formattedExpressionForIndex(QModelIndex const& index) const = 0; /*! * Get the expression of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The expression of the selected index. + * @return The expression of the selected index. */ virtual QVariant expressionForIndex(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * * return The data in the given index. */ @@ -202,7 +202,7 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Validates the data in the cell given by the column. * - * @param [in] index The index being validated. + * @param [in] index The index being validated. * * return True, if the data in the parameter is valid, false otherwise. */ @@ -211,28 +211,28 @@ class PortsModel : public ReferencingTableModel, public ParameterizableTable /*! * Get all the references made to the selected parameter from the selected row. * - * @param [in] row The selected row. - * @param [in] valueID The target parameter. + * @param [in] row The selected row. + * @param [in] valueID The target parameter. * - * @return Number of references made to the selected id from the selected row. + * @return Number of references made to the selected id from the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const override; /*! * Checks if given index is locked. * - * @param [in] index The index to check. + * @param [in] index The index to check. * - * @return True if the index is locked, otherwise false. + * @return True if the index is locked, otherwise false. */ bool isLocked(QModelIndex const& index) const; /*! * Get the icon path of the selected index. * - * @param [in] portIndex The selected index. + * @param [in] portIndex The selected index. * - * @return The icon path for the selected index. + * @return The icon path for the selected index. */ QString getIconPath(int const& portIndex) const; @@ -241,7 +241,7 @@ public slots: /*! * Remove a row from the model. * - * @param [in] row Specifies the row to remove + * @param [in] row Specifies the row to remove */ void onRemoveRow(int row); @@ -254,14 +254,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); @@ -285,7 +285,7 @@ public slots: /*! * Change the vendor extensions editor data. * - * @param [in] index Index of the selected port. + * @param [in] index Index of the selected port. */ void portExtensionDataChanged(QModelIndex const& index); @@ -304,148 +304,148 @@ public slots: /*! * Get the column for row number. * - * @return Row number column. + * @return Row number column. */ virtual int rowNumberColumn() const = 0; /*! * Get the column for name. * - * @return Name column. + * @return Name column. */ virtual int nameColumn() const = 0; /*! * Get the column for type definitions. * - * @return Type definitions column. + * @return Type definitions column. */ virtual int typeColumn() const = 0; /*! * Get the column for array left. * - * @return Array left column. + * @return Array left column. */ virtual int arrayLeftColumn() const = 0; /*! * Get the column for array right. * - * @return Array right column. + * @return Array right column. */ virtual int arrayRightColum() const = 0; /*! * Get the column for tags. * - * @return Tags column. + * @return Tags column. */ virtual int tagColumn() const = 0; /*! * Get the column for ad hoc visibility. * - * @return Ad hoc visibility column. + * @return Ad hoc visibility column. */ virtual int adHocColumn() const = 0; /*! * Get the column for description. * - * @return Description column. + * @return Description column. */ virtual int descriptionColumn() const = 0; /*! * Check if the selected item is disabled. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is disabled, false otherwise. + * @return True, if the indexed item is disabled, false otherwise. */ virtual bool indexedItemIsDisabled(QModelIndex const& index) const = 0; /*! * Check if the selected item is mandatory. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is mandatory, false otherwise. + * @return True, if the indexed item is mandatory, false otherwise. */ virtual bool indexedItemIsMandatory(QModelIndex const& index) const = 0; /*! * Check if the selected item is locked. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return True, if the indexed item is locked, false otherwise. + * @return True, if the indexed item is locked, false otherwise. */ virtual bool indexedItemIsLocked(QModelIndex const& index) const = 0; /*! * Get a list of the locked port indexes from the selected index. * - * @param [in] portIndex Index of the selected item. + * @param [in] portIndex Index of the selected item. * - * @return List of the locked port indexes. + * @return List of the locked port indexes. */ virtual QModelIndexList getLockedPortIndexes(QModelIndex const& portIndex) const = 0; /*! * Add a new wire or transactional port. * - * @param [in] port The selected port. + * @param [in] port The selected port. */ virtual void addNewPort() = 0; /*! * Locks the name, direction and type columns of a port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. */ void lockPort(QString const& portName); /*! * Unlocks the name, direction and type columns of a port. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. */ void unlockPort(QString const& portName); /*! * Locks the given index disabling editing. * - * @param [in] index The index to lock. + * @param [in] index The index to lock. */ void lockIndex(QModelIndex const& index); /*! * Unlocks the given index disabling editing. * - * @param [in] index The index to unlock. + * @param [in] index The index to unlock. */ void unlockIndex(QModelIndex const& index); /*! * Checks if given row is locked. * - * @param [in] row The row to check. + * @param [in] row The row to check. * - * @return True if the row is locked, otherwise false. + * @return True if the row is locked, otherwise false. */ bool rowIsLocked(int row) const; /*! * Check if the selected interface modes match. * - * @param [in] busMode Interface mode of the selected bus interface. - * @param [in] busSystemGroup System group of the selected bus interface. - * @param [in] signalMode Interface mode of the selected signal. - * @param [in] signalSystemGroup System group of the selected signal. + * @param [in] busMode Interface mode of the selected bus interface. + * @param [in] busSystemGroup System group of the selected bus interface. + * @param [in] signalMode Interface mode of the selected signal. + * @param [in] signalSystemGroup System group of the selected signal. * - * @return True, if the interface modes match, false otherwise. + * @return True, if the interface modes match, false otherwise. */ bool modesMatch(General::InterfaceMode const& busMode, QString const& busSystemGroup, General::InterfaceMode const& signalMode, QString const& signalSystemGroup) const; @@ -453,10 +453,10 @@ public slots: /*! * Get the direction for a port created from a signal. * - * @param [in] busMode Interface mode of the selected bus interface. - * @param [in] signalDirection Direction of the selected signal. + * @param [in] busMode Interface mode of the selected bus interface. + * @param [in] signalDirection Direction of the selected signal. * - * @return Direction for the port created from the selected signal. + * @return Direction for the port created from the selected signal. */ DirectionTypes::Direction getDirectionFromSignal(General::InterfaceMode const& busMode, DirectionTypes::Direction const& signalDirection) const; @@ -464,10 +464,10 @@ public slots: /*! * Get the initiative for a port created from a signal. * - * @param [in] busMode Interface mode of the selected bus interface. - * @param [in] signalInitiative Initiative of the selected signal. + * @param [in] busMode Interface mode of the selected bus interface. + * @param [in] signalInitiative Initiative of the selected signal. * - * @return Initiative for the port created from the selected signal. + * @return Initiative for the port created from the selected signal. */ QString getInitiativeFromSignal(General::InterfaceMode const& busMode, QString const& signalInitiative) const; diff --git a/editors/ComponentEditor/powerDomains/PowerDomainsDelegate.h b/editors/ComponentEditor/powerDomains/PowerDomainsDelegate.h index 66f283880..56b4bb35d 100644 --- a/editors/ComponentEditor/powerDomains/PowerDomainsDelegate.h +++ b/editors/ComponentEditor/powerDomains/PowerDomainsDelegate.h @@ -29,10 +29,10 @@ class PowerDomainsDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] component Component containing the edited PowerDomains. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder The parameter finder to use for for expression editor. - * @param [in] parent The parent object. + * @param [in] component Component containing the edited PowerDomains. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder The parameter finder to use for for expression editor. + * @param [in] parent The parent object. */ PowerDomainsDelegate(QSharedPointer > > powerDomains, QAbstractItemModel* completionModel, @@ -51,11 +51,11 @@ class PowerDomainsDelegate : public ExpressionDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -63,17 +63,17 @@ class PowerDomainsDelegate : public ExpressionDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -93,16 +93,16 @@ class PowerDomainsDelegate : public ExpressionDelegate /*! * Checks if the given column supPowerDomains expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column allow expressions, otherwise false. + * @return True, if the cells in the column allow expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; /*! * Gets the description column. * - * @return Description column index. + * @return Description column index. */ virtual int descriptionColumn() const; diff --git a/editors/ComponentEditor/powerDomains/PowerDomainsEditor.h b/editors/ComponentEditor/powerDomains/PowerDomainsEditor.h index 3e485eb67..08e8ad65c 100644 --- a/editors/ComponentEditor/powerDomains/PowerDomainsEditor.h +++ b/editors/ComponentEditor/powerDomains/PowerDomainsEditor.h @@ -38,11 +38,11 @@ class PowerDomainsEditor : public ItemEditor /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator used for power domains. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator used for power domains. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The owner of this widget. * */ PowerDomainsEditor(QSharedPointer component, LibraryInterface* handler, diff --git a/editors/ComponentEditor/powerDomains/PowerDomainsModel.h b/editors/ComponentEditor/powerDomains/PowerDomainsModel.h index 7bbf8582a..b9c514247 100644 --- a/editors/ComponentEditor/powerDomains/PowerDomainsModel.h +++ b/editors/ComponentEditor/powerDomains/PowerDomainsModel.h @@ -35,10 +35,10 @@ class PowerDomainsModel : public ReferencingTableModel, public ParameterizableTa /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] validator The validator used for power domains. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The owner of this model + * @param [in] component The component being edited. + * @param [in] validator The validator used for power domains. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The owner of this model */ PowerDomainsModel(QSharedPointer component, QSharedPointer validator, @@ -57,61 +57,61 @@ class PowerDomainsModel : public ReferencingTableModel, public ParameterizableTa /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ int rowCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Get the number of columns in the model * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not * hierarchical model. * - * @return The number of columns in the model. + * @return The number of columns in the model. */ int columnCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! * Get the data for the headers * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed + * @return QVariant containing the data to be displayed */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole) final; /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const final; @@ -121,7 +121,7 @@ public slots: /*! * Remove a row from the model * - * @param [in] row Specifies the row to remove + * @param [in] row Specifies the row to remove */ void onRemoveRow(int row); @@ -133,14 +133,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(QModelIndex const& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(QModelIndex const& index); @@ -160,28 +160,28 @@ public slots: /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const final; /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ bool isValidExpressionColumn(QModelIndex const& index) const final; /*! * Gets the expression for the given index or the plain value if expression is not available. * - * @param [in] index The index whose expression to get. + * @param [in] index The index whose expression to get. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ QVariant expressionOrValueForIndex(QModelIndex const& index) const final; @@ -191,9 +191,9 @@ public slots: /*! * Validate the data contained within a given index. * - * @param [in] index The index of the data being validated. + * @param [in] index The index of the data being validated. * - * @return True, if the data is valid, otherwise false. + * @return True, if the data is valid, otherwise false. */ bool validateIndex(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/referenceCounter/ComponentParameterReferenceCounter.h b/editors/ComponentEditor/referenceCounter/ComponentParameterReferenceCounter.h index 1047904d7..55dadbb57 100644 --- a/editors/ComponentEditor/referenceCounter/ComponentParameterReferenceCounter.h +++ b/editors/ComponentEditor/referenceCounter/ComponentParameterReferenceCounter.h @@ -63,8 +63,8 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * The constructor. * - * @param [in] parameterFinder Locator for component parameters. - * @param [in] component The containing component. + * @param [in] parameterFinder Locator for component parameters. + * @param [in] component The containing component. */ ComponentParameterReferenceCounter(QSharedPointer parameterFinder, QSharedPointer component); @@ -81,36 +81,36 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Set a new component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. */ void setComponent(QSharedPointer newComponent); /*! * Count the references made to the selected parameter in the file sets. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the file sets. + * @return The amount of references made to the selected parameter in the file sets. */ int countReferencesInFileSets(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected file set. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] fileSet The selected file set. + * @param [in] parameterID ID of the selected parameter. + * @param [in] fileSet The selected file set. * - * @return The amount of references made to the selected parameter in the selected file set. + * @return The amount of references made to the selected parameter in the selected file set. */ int countReferencesInSingleFileSet(QString const& parameterID, QSharedPointer fileSet) const; /*! * Count the references made to the selected parameter in the selected file builders. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] builders The selected file builders. + * @param [in] parameterID ID of the selected parameter. + * @param [in] builders The selected file builders. * - * @return The amount of references made to the selected parameter in the selected file builders. + * @return The amount of references made to the selected parameter in the selected file builders. */ int countReferencesInFileBuilders(QString const& parameterID, QSharedPointer > > builders) const; @@ -118,20 +118,20 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected file builder. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] builder The selected file builder. + * @param [in] parameterID ID of the selected parameter. + * @param [in] builder The selected file builder. * - * @return The amount of references made to the selected parameter in the selected file builder. + * @return The amount of references made to the selected parameter in the selected file builder. */ int countReferencesInSingleFileBuilder(QString const& parameterID, QSharedPointer builder) const; /*! * Count the references made to the selected parameter in the selected files. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] files The selected files. + * @param [in] parameterID ID of the selected parameter. + * @param [in] files The selected files. * - * @return The amount of references made to the selected parameter in the selected files. + * @return The amount of references made to the selected parameter in the selected files. */ int countReferencesInFiles(QString const& parameterID, QSharedPointer > > files) const; @@ -139,20 +139,20 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected file. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] file The selected file. + * @param [in] parameterID ID of the selected parameter. + * @param [in] file The selected file. * - * @return The amount of references made to the selected parameter in the selected file. + * @return The amount of references made to the selected parameter in the selected file. */ int countReferencesInSingleFile(QString const& parameterID, QSharedPointer file) const; /*! * Count the references made to the selected parameter in the selected build command. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] buildCommand The selected build command. + * @param [in] parameterID ID of the selected parameter. + * @param [in] buildCommand The selected build command. * - * @return The amount of references made to the selected parameter in the selected build command. + * @return The amount of references made to the selected parameter in the selected build command. */ int countReferencesInBuildCommand(QString const& parameterID, QSharedPointer buildCommand) const; @@ -160,59 +160,59 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the contained memory maps. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained memory maps. + * @return The amount of references made to the selected parameter in the contained memory maps. */ int countReferencesInMemoryMaps(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected memory map. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] memoryMap The selected memory map. + * @param [in] parameterID ID of the selected parameter. + * @param [in] memoryMap The selected memory map. * - * @return The amount of references made to the selected parameter in the selected memory map. + * @return The amount of references made to the selected parameter in the selected memory map. */ int countReferencesInSingleMemoryMap(QString const& parameterID, QSharedPointer memoryMap) const; /*! * Count the references made to the selected parameter in the selected base memory map. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] memoryMap The selected base memory map. + * @param [in] parameterID ID of the selected parameter. + * @param [in] memoryMap The selected base memory map. * - * @return The amount of references made to the selected parameter in the selected base memory map. + * @return The amount of references made to the selected parameter in the selected base memory map. */ int countReferencesInBaseMemoryMap(QString const& parameterID, QSharedPointer memoryMap) const; /*! * Count the references made to the selected parameter in the values of the selected memory base. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] memoryMap The selected memory base. + * @param [in] parameterID ID of the selected parameter. + * @param [in] memoryMap The selected memory base. * - * @return The amount of references made to the selected parameter in the selected memory base. + * @return The amount of references made to the selected parameter in the selected memory base. */ int countReferencesInMemoryMapValues(QString const& parameterID, QSharedPointer memoryMap) const; /*! * Count the references made to the selected parameter in the selected address blocks. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] addressBlock The selected address block. + * @param [in] parameterID ID of the selected parameter. + * @param [in] addressBlock The selected address block. * - * @return The amount of references made to the selected parameter in the selected address block. + * @return The amount of references made to the selected parameter in the selected address block. */ int countReferenceInAddressBlock(QString const& parameterID, QSharedPointer addressBlock) const; /*! * Count the references made to the selected parameter in the values of the selected address block. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] addressBlock The selected address block. + * @param [in] parameterID ID of the selected parameter. + * @param [in] addressBlock The selected address block. * - * @return The amount of references made to the selected parameter in the values of the selected address + * @return The amount of references made to the selected parameter in the values of the selected address * block. */ int countReferencesInAddressBlockValues(QString const& parameterID, QSharedPointer addressBlock) @@ -221,10 +221,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected registers. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] registers The selected registers. + * @param [in] parameterID ID of the selected parameter. + * @param [in] registers The selected registers. * - * @return The amount of references made to the selected parameter in the selected registers. + * @return The amount of references made to the selected parameter in the selected registers. */ int countReferencesInRegisters(QString const& parameterID, QSharedPointer > > registers) const; @@ -232,10 +232,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected register files. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] files The selected register files. + * @param [in] parameterID ID of the selected parameter. + * @param [in] files The selected register files. * - * @return The amount of references made to the selected parameter in the selected register files. + * @return The amount of references made to the selected parameter in the selected register files. */ int countReferencesInRegisterFiles(QString const& parameterID, QSharedPointer > > const& files) const; @@ -243,20 +243,20 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected register. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] targetRegistesr The selected registers. + * @param [in] parameterID ID of the selected parameter. + * @param [in] targetRegistesr The selected registers. * - * @return The amount of references made to the selected parameter in the selected register. + * @return The amount of references made to the selected parameter in the selected register. */ int countReferencesInSingleRegister(QString const& parameterID, QSharedPointer targetRegister) const; /*! * Count the references made to the selected parameter in the selected register file. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] targetFile The selected register file. + * @param [in] parameterID ID of the selected parameter. + * @param [in] targetFile The selected register file. * - * @return The amount of references made to the selected parameter in the selected register file. + * @return The amount of references made to the selected parameter in the selected register file. */ int countReferencesInSingleRegisterFile(QString const& parameterID, QSharedPointer targetFile) const; @@ -264,10 +264,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected base register. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] baseRegister The selected base register. + * @param [in] parameterID ID of the selected parameter. + * @param [in] baseRegister The selected base register. * - * @return The amount of references made to the selected parameter in the selected base register. + * @return The amount of references made to the selected parameter in the selected base register. */ int countReferencesInSingleBaseRegister(QString const& parameterID, QSharedPointer baseRegister) const; @@ -275,10 +275,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected fields. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] fields The selected fields. + * @param [in] parameterID ID of the selected parameter. + * @param [in] fields The selected fields. * - * @return The amount of references made to the selected parameter in the selected fields. + * @return The amount of references made to the selected parameter in the selected fields. */ int countReferencesInFields(QString const& parameterID, QSharedPointer > > fields) const; @@ -286,20 +286,20 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected field. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] registerField The selected field. + * @param [in] parameterID ID of the selected parameter. + * @param [in] registerField The selected field. * - * @return The amount of references made to the selected parameter in the selected field. + * @return The amount of references made to the selected parameter in the selected field. */ int countReferencesInSingleField(QString const& parameterID, QSharedPointer registerField) const; /*! * Count the references made to the selected parameter in the resets of the selected field. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] resets Reset values of the selected field. + * @param [in] parameterID ID of the selected parameter. + * @param [in] resets Reset values of the selected field. * - * @return The amount of references made to the selected parameter in the resets of the selected field. + * @return The amount of references made to the selected parameter in the resets of the selected field. */ int countReferencesInFieldResets(QString const& parameterID, QSharedPointer > > resets) const; @@ -307,18 +307,18 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected field reset. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] fieldReset The selected field reset. + * @param [in] parameterID ID of the selected parameter. + * @param [in] fieldReset The selected field reset. * - * @return The amount of references made to the selected parameter in the selected field reset. + * @return The amount of references made to the selected parameter in the selected field reset. */ int countReferencesInSingleFieldReset(QString const& parameterID, QSharedPointer fieldReset) const; /*! * Count the references made to the selected parameter in the field access policies in the selected field. * - * @param [in] parameterID ID of the selected parameter - * @param [in] accessPolicies Field access policies of the selected field. + * @param [in] parameterID ID of the selected parameter + * @param [in] accessPolicies Field access policies of the selected field. * * @return The number of references made to the selected parameters in the field access policies. */ @@ -328,29 +328,29 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the contained address spaces. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained address spaces. + * @return The amount of references made to the selected parameter in the contained address spaces. */ int countReferencesInAddressSpaces(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected address space. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] space The selected address space. + * @param [in] parameterID ID of the selected parameter. + * @param [in] space The selected address space. * - * @return The amount of references made to the selected parameter in the selected address space. + * @return The amount of references made to the selected parameter in the selected address space. */ int countReferencesInSingleAddressSpace(QString const& parameterID, QSharedPointer space) const; /*! * Count the references made to the selected parameter in the selected address space values. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] space The selected address space. + * @param [in] parameterID ID of the selected parameter. + * @param [in] space The selected address space. * - * @return The amount of references made to the selected parameter in the selected address space values. + * @return The amount of references made to the selected parameter in the selected address space values. */ int countReferencesInSingleAddressSpaceItems(QString const& parameterID, QSharedPointer space) const; @@ -358,10 +358,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected segments. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] segments The selected segments. + * @param [in] parameterID ID of the selected parameter. + * @param [in] segments The selected segments. * - * @return The amount of references made to the selected parameter in the selected segments. + * @return The amount of references made to the selected parameter in the selected segments. */ int countReferencesInSegments(QString const& parameterID, QSharedPointer > > segments) const; @@ -369,29 +369,29 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected segment. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] segment The selected segment. + * @param [in] parameterID ID of the selected parameter. + * @param [in] segment The selected segment. * - * @return The amount of references made to the selected parameter in the selected segment. + * @return The amount of references made to the selected parameter in the selected segment. */ int countReferencesInSingleSegment(QString const& parameterID, QSharedPointer segment) const; /*! * Count the references made to the selected parameter in the contained instantiations. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained instantiations. + * @return The amount of references made to the selected parameter in the contained instantiations. */ int countReferencesInInstantiations(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected component instantiations. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instantiations The selected component instantiations. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instantiations The selected component instantiations. * - * @return The amount of references made to the selected parameter in the selected component + * @return The amount of references made to the selected parameter in the selected component * instantiations. */ int countReferencesInComponentInstantiations(QString const& parameterID, @@ -400,10 +400,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected component instantiation. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instantiation The selected component instantiation. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instantiation The selected component instantiation. * - * @return The amount of references made to the selected parameter in the selected component + * @return The amount of references made to the selected parameter in the selected component * instantiation. */ int countReferencesInSingleComponentInstantiation(QString const& parameterID, @@ -412,10 +412,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected module parameters. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] moduleParameters The selected module parameters. + * @param [in] parameterID ID of the selected parameter. + * @param [in] moduleParameters The selected module parameters. * - * @return The amount of references made to the selected parameter in the selected module parameters. + * @return The amount of references made to the selected parameter in the selected module parameters. */ int countReferencesInModuleParameters(QString const& parameterID, QSharedPointer > > moduleParameters) const; @@ -423,10 +423,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected design configuration instantiations. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instantiations The selected design configuration instantiations. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instantiations The selected design configuration instantiations. * - * @return The amount of references made to the selected parameter in the selected design configuration + * @return The amount of references made to the selected parameter in the selected design configuration * instantiations. */ int countReferencesInDesignConfigurationInstantiations(QString const& parameterID, @@ -435,10 +435,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected design configuration instantiation. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instantiation The selected design configuration instantiation. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instantiation The selected design configuration instantiation. * - * @return The amount of references made to the selected parameter in the selected design configuration + * @return The amount of references made to the selected parameter in the selected design configuration * instantiation. */ int countReferencesInSingleDesignConfigurationInstantiation(QString const& parameterID, @@ -447,19 +447,19 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected design instantiations. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the selected design instantiations. + * @return The amount of references made to the selected parameter in the selected design instantiations. */ int countReferencesInDesignInstantiations(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected design instantiation. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instantiation The selected design instantiation. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instantiation The selected design instantiation. * - * @return The amount of references made to the selected parameter in the selected design instantiation. + * @return The amount of references made to the selected parameter in the selected design instantiation. */ int countReferencesInSingleDesigninstantiation(QString const& parameterID, QSharedPointer instantiation) const; @@ -467,38 +467,38 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the contained ports. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained ports. + * @return The amount of references made to the selected parameter in the contained ports. */ int countReferencesInPorts(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected port. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] port The selected port. + * @param [in] parameterID ID of the selected parameter. + * @param [in] port The selected port. * - * @return The amount of references made to the selected parameter in the selected port. + * @return The amount of references made to the selected parameter in the selected port. */ int countReferencesInSinglePort(QString const& parameterID, QSharedPointer port) const; /*! * Count the references made to the selected parameter in the contained bus interfaces. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained bus interfaces. + * @return The amount of references made to the selected parameter in the contained bus interfaces. */ int countReferencesInBusInterfaces(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected bus interface. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] busInterface The selected bus interface. + * @param [in] parameterID ID of the selected parameter. + * @param [in] busInterface The selected bus interface. * - * @return The amount of references made to the selected parameter in the selected bus interface. + * @return The amount of references made to the selected parameter in the selected bus interface. */ int countReferencesInSingleBusInterface(QString const& parameterID, QSharedPointer busInterface) const; @@ -506,10 +506,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected mirrored slave bus interface. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] mirroredSlave The selected mirrored slave bus interface. + * @param [in] parameterID ID of the selected parameter. + * @param [in] mirroredSlave The selected mirrored slave bus interface. * - * @return The amount of references made to the selected parameter in the selected mirrored slave bus + * @return The amount of references made to the selected parameter in the selected mirrored slave bus * interface. */ int countReferencesInMirroredSlaveInterface(QString const& parameterID, @@ -518,20 +518,20 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected master bus interface. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] master The selected master bus interface. + * @param [in] parameterID ID of the selected parameter. + * @param [in] master The selected master bus interface. * - * @return The amount of references made to the selected parameter in the selected master bus interface. + * @return The amount of references made to the selected parameter in the selected master bus interface. */ int countReferencesInMasterInterface(QString const& parameterID, QSharedPointer master) const; /*! * Count the references made to the selected parameter in the selected mirrored slave remap address. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] remapAddress The selected mirrored slave remap address. + * @param [in] parameterID ID of the selected parameter. + * @param [in] remapAddress The selected mirrored slave remap address. * - * @return The amount of references made to the selected parameter in the selected mirrored slave remap + * @return The amount of references made to the selected parameter in the selected mirrored slave remap * address. */ int countReferencesInRemapAddress(QString const& parameterID, @@ -540,117 +540,117 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the contained remap states. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained remap states. + * @return The amount of references made to the selected parameter in the contained remap states. */ int countReferencesInRemapStates(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected remap state. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] remapState The selected remap state. + * @param [in] parameterID ID of the selected parameter. + * @param [in] remapState The selected remap state. * - * @return The amount of references made to the selected parameter in the selected remap state. + * @return The amount of references made to the selected parameter in the selected remap state. */ int countReferencesInSingleRemapState(QString const& parameterID, QSharedPointer remapState) const; /*! * Count the references made to the selected parameter in the selected remap port. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] port The selected remap port. + * @param [in] parameterID ID of the selected parameter. + * @param [in] port The selected remap port. * - * @return The amount of references made to the selected parameter in the selected remap port. + * @return The amount of references made to the selected parameter in the selected remap port. */ int countReferencesInSingleRemapPort(QString const& parameterID, QSharedPointer port) const; /*! * Count the references made to the selected parameter in the contained modes. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the contained modes. + * @return The amount of references made to the selected parameter in the contained modes. */ int countReferencesInModes(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected mode. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] mode The selected mode. + * @param [in] parameterID ID of the selected parameter. + * @param [in] mode The selected mode. * - * @return The amount of references made to the selected parameter in the selected mode. + * @return The amount of references made to the selected parameter in the selected mode. */ int countReferencesInSingleMode(QString const& parameterID, QSharedPointer mode) const; /*! * Count the references made to the selected parameter in the selected mode condition. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] condition The selected condition expression. + * @param [in] parameterID ID of the selected parameter. + * @param [in] condition The selected condition expression. * - * @return The amount of references made to the selected parameter in the selected expression. + * @return The amount of references made to the selected parameter in the selected expression. */ int countReferencesInModeCondition(QString const& parameterID, QString const& condition) const; /*! * Count the references made to the selected parameter in the port slices of the selected mode. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] mode The selected mode. + * @param [in] parameterID ID of the selected parameter. + * @param [in] mode The selected mode. * - * @return The amount of references made to the selected parameter in the port slices. + * @return The amount of references made to the selected parameter in the port slices. */ int countReferencesInPortSlices(QString const& parameterID, QSharedPointer mode) const; /*! * Count the references made to the selected parameter in the field slices of the selected mode. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] mode The selected mode. + * @param [in] parameterID ID of the selected parameter. + * @param [in] mode The selected mode. * - * @return The amount of references made to the selected parameter in the selected field slice. + * @return The amount of references made to the selected parameter in the selected field slice. */ int countReferencesInFieldSlices(QString const& parameterID, QSharedPointer mode) const; /*! * Count the references made to the selected parameter in the selected port slice. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] portSlice The selected port slice. + * @param [in] parameterID ID of the selected parameter. + * @param [in] portSlice The selected port slice. * - * @return The amount of references made to the selected parameter in the port slice. + * @return The amount of references made to the selected parameter in the port slice. */ int countReferencesInSinglePortSlice(QString const& targetID, QSharedPointer portSlice) const; /*! * Count the references made to the selected parameter in the selected field slice. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] fieldSlice The selected field slice. + * @param [in] parameterID ID of the selected parameter. + * @param [in] fieldSlice The selected field slice. * - * @return The amount of references made to the selected parameter in the field slice. + * @return The amount of references made to the selected parameter in the field slice. */ int countReferencesInSingleFieldSlice(QString const& parameterID, QSharedPointer fieldSlice) const; /*! * Count the references made to the selected parameter in indirect interfaces. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the indirect interfaces. + * @return The amount of references made to the selected parameter in the indirect interfaces. */ int countReferencesInIndirectInterfaces(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected indirect interface. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] indirectInterface The selected indirect interface. + * @param [in] parameterID ID of the selected parameter. + * @param [in] indirectInterface The selected indirect interface. * - * @return The amount of references made to the selected parameter in the selected indirect interface. + * @return The amount of references made to the selected parameter in the selected indirect interface. */ int countRefrencesInSingleIndirectInterface(QString const& parameterID, QSharedPointer indirectInterface) const; @@ -658,29 +658,29 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in CPUs. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the CPUs. + * @return The amount of references made to the selected parameter in the CPUs. */ int countReferencesInCpus(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected CPU. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] cpu The selected CPU. + * @param [in] parameterID ID of the selected parameter. + * @param [in] cpu The selected CPU. * - * @return The amount of references made to the selected parameter in the selected CPU. + * @return The amount of references made to the selected parameter in the selected CPU. */ int countReferencesInSingleCpu(QString const& parameterID, QSharedPointer cpu) const; /*! * Count the references made to the selected parameter in CPU regions interfaces. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] regions The selected CPU regions. + * @param [in] parameterID ID of the selected parameter. + * @param [in] regions The selected CPU regions. * - * @return The amount of references made to the selected parameter in the CPU regions. + * @return The amount of references made to the selected parameter in the CPU regions. */ int countReferencesInRegions(QString const& parameterID, QSharedPointer > > regions) const; @@ -688,10 +688,10 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in the selected CPU region. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] region The selected CPU region. + * @param [in] parameterID ID of the selected parameter. + * @param [in] region The selected CPU region. * - * @return The amount of references made to the selected parameter in the selected CPU region. + * @return The amount of references made to the selected parameter in the selected CPU region. */ int countReferencesInSingleRegion(QString const& parameterID, QSharedPointer region) const; @@ -699,19 +699,19 @@ class ComponentParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the references made to the selected parameter in power domains. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The amount of references made to the selected parameter in the power domains. + * @return The amount of references made to the selected parameter in the power domains. */ int countReferencesInPowerDomains(QString const& parameterID) const; /*! * Count the references made to the selected parameter in the selected power domain. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] powerDomain The selected power domain. + * @param [in] parameterID ID of the selected parameter. + * @param [in] powerDomain The selected power domain. * - * @return The amount of references made to the selected parameter in the selected power domain. + * @return The amount of references made to the selected parameter in the selected power domain. */ int countReferencesInSinglePowerDomain(QString const& parameterID, QSharedPointer powerDomain) const; @@ -721,8 +721,8 @@ public slots: /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ virtual void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface) override final; @@ -732,10 +732,10 @@ public slots: /*! * Count the references made to the selected parameter in the selected write constraint. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] writeConstraint The selected write constraint. + * @param [in] parameterID ID of the selected parameter. + * @param [in] writeConstraint The selected write constraint. * - * @return The amount of references made to the selected parameter in the selected write constraint. + * @return The amount of references made to the selected parameter in the selected write constraint. */ int countReferencesInWriteConstraint(QString const& parameterID, QSharedPointer writeConstraint) const; diff --git a/editors/ComponentEditor/referenceCounter/ParameterReferenceCounter.h b/editors/ComponentEditor/referenceCounter/ParameterReferenceCounter.h index f60cfc84c..bef42d777 100644 --- a/editors/ComponentEditor/referenceCounter/ParameterReferenceCounter.h +++ b/editors/ComponentEditor/referenceCounter/ParameterReferenceCounter.h @@ -32,7 +32,7 @@ class ParameterReferenceCounter : public ReferenceCounter /*! * The constructor. * - * @param [in] parameterFinder The parameter finder. + * @param [in] parameterFinder The parameter finder. */ explicit ParameterReferenceCounter(QSharedPointer parameterFinder); @@ -50,10 +50,10 @@ class ParameterReferenceCounter : public ReferenceCounter /*! * Count the references made to the selected parameter in the selected parameters. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] parameters The selected parameters. + * @param [in] parameterID ID of the selected parameter. + * @param [in] parameters The selected parameters. * - * @return The amount of references made to the selected parameter in the selected parameters. + * @return The amount of references made to the selected parameter in the selected parameters. */ virtual int countReferencesInParameters(QString const& parameterID, QSharedPointer > > parameters) const; @@ -61,20 +61,20 @@ class ParameterReferenceCounter : public ReferenceCounter /*! * Count the references made to the selected parameter in the selected parameter. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] parameter The selected parameter. + * @param [in] parameterID ID of the selected parameter. + * @param [in] parameter The selected parameter. * - * @return The amount of references made to the selected parameter in the selected parameter. + * @return The amount of references made to the selected parameter in the selected parameter. */ int countReferencesInSingleParameter(QString const& parameterID, QSharedPointer parameter) const; /*! * Count the references made to the selected parameter in the selected configurable element values. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] configurableElements The selected configurable element values. + * @param [in] parameterID ID of the selected parameter. + * @param [in] configurableElements The selected configurable element values. * - * @return The amount of references made to the selected parameter in the selected configurable element + * @return The amount of references made to the selected parameter in the selected configurable element * values. */ int countReferencesInConfigurableElementValues(QString const& parameterId, @@ -83,10 +83,10 @@ class ParameterReferenceCounter : public ReferenceCounter /*! * Count the references made to the selected parameter in the selected configurable element value. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] element The selected configurable element value. + * @param [in] parameterID ID of the selected parameter. + * @param [in] element The selected configurable element value. * - * @return The amount of references made to the selected parameter in the selected configurable element + * @return The amount of references made to the selected parameter in the selected configurable element * value. */ int countReferencesInSingleConfigurableElementValue(QString const& parameterID, @@ -95,10 +95,10 @@ class ParameterReferenceCounter : public ReferenceCounter /*! * Count the references made to the selected parameter in the selected expression. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] expression The selected expression. + * @param [in] parameterID ID of the selected parameter. + * @param [in] expression The selected expression. * - * @return The amount of references made to the selected parameter in the selected expression. + * @return The amount of references made to the selected parameter in the selected expression. */ int countReferencesInExpression(QString const& parameterID, QString const& expression) const; @@ -107,22 +107,22 @@ public slots: /*! * Increase the reference count of the parameter matching the id. * - * @param [in] id The id of the parameter which is being referenced. + * @param [in] id The id of the parameter which is being referenced. */ virtual void increaseReferenceCount(QString const& id) override; /*! * Decrease the reference count of the parameter matching the id. * - * @param [in] id The id of the parameter which was referenced. + * @param [in] id The id of the parameter which was referenced. */ virtual void decreaseReferenceCount(QString const& id) override; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ virtual void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface) override; @@ -132,10 +132,10 @@ public slots: /*! * Count references made in the selected parameter interface to the selected ID. * - * @param [in] parameterID The selected parameter ID. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterID The selected parameter ID. + * @param [in] parameterInterface Interface for accessing parameters. * - * @return The number of references made. + * @return The number of references made. */ int countReferencesInInterfacedParameters(QString const& parameterID, AbstractParameterInterface* parameterInterface) const; diff --git a/editors/ComponentEditor/referenceCounter/ReferenceCounter.h b/editors/ComponentEditor/referenceCounter/ReferenceCounter.h index 54889107d..a46ac784c 100644 --- a/editors/ComponentEditor/referenceCounter/ReferenceCounter.h +++ b/editors/ComponentEditor/referenceCounter/ReferenceCounter.h @@ -33,22 +33,22 @@ public slots: /*! * Increase the reference count of the parameter matching the id. * - * @param [in] id The id of the parameter which is being referenced. + * @param [in] id The id of the parameter which is being referenced. */ virtual void increaseReferenceCount(QString const& id) = 0; /*! * Decrease the reference count of the parameter matching the id. * - * @param [in] id The id of the parameter which was referenced. + * @param [in] id The id of the parameter which was referenced. */ virtual void decreaseReferenceCount(QString const& id) = 0; /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ virtual void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface) = 0; diff --git a/editors/ComponentEditor/remapStates/RemapConditionDelegate.h b/editors/ComponentEditor/remapStates/RemapConditionDelegate.h index a9d669fb4..0cf543c41 100644 --- a/editors/ComponentEditor/remapStates/RemapConditionDelegate.h +++ b/editors/ComponentEditor/remapStates/RemapConditionDelegate.h @@ -33,12 +33,12 @@ class RemapConditionDelegate : public ExpressionDelegate /*! * The constructor. * - * @param [in] portNameList The list of available port names. - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] finder The parameter finder to use for expression editors. - * @param [in] expressionParser The expression parser used for calculating expressions. - * @param [in] expressionFormatter The expression formatter for changing ids to parameter names. - * @param [in] parent The parent of the object. + * @param [in] portNameList The list of available port names. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] finder The parameter finder to use for expression editors. + * @param [in] expressionParser The expression parser used for calculating expressions. + * @param [in] expressionFormatter The expression formatter for changing ids to parameter names. + * @param [in] parent The parent of the object. */ RemapConditionDelegate(QStringList const& portNameList, QAbstractItemModel* completionModel, QSharedPointer finder, QSharedPointer expressionParser, @@ -50,27 +50,27 @@ class RemapConditionDelegate : public ExpressionDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -78,9 +78,9 @@ class RemapConditionDelegate : public ExpressionDelegate /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -88,7 +88,7 @@ class RemapConditionDelegate : public ExpressionDelegate /*! * Set the component ports. * - * @param [in] componentPorts All the ports of the component. + * @param [in] componentPorts All the ports of the component. */ void setComponentPorts(QStringList const& componentPorts); @@ -97,7 +97,7 @@ public slots: /*! * Set the currently available port names. * - * @param [in] newPorts The currently available port names. + * @param [in] newPorts The currently available port names. */ void setNewPortNames(QStringList const& newPorts); @@ -111,9 +111,9 @@ public slots: /*! * Checks if the cells in given column accept expression as an input value. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells accept expressions, otherwise false. + * @return True, if the cells accept expressions, otherwise false. */ virtual bool columnAcceptsExpression(int column) const; @@ -131,24 +131,24 @@ public slots: /*! * Setup the data for the condition value editor. * - * @param [in] editor The selected editor. - * @param [in] index Index of the editor containing port. + * @param [in] editor The selected editor. + * @param [in] index Index of the editor containing port. */ void setValueAndArrayEditor(QWidget* editor, QModelIndex const& index) const; /*! * Check if the value should be an array. * - * @param [in] index The index of the current value. + * @param [in] index The index of the current value. * - * @return True, if the value is an array, otherwise false. + * @return True, if the value is an array, otherwise false. */ bool valueIsArray(QModelIndex const& index) const; /*! * Get the width of the remap port. * - * @param [in] index The index of the current remap port. + * @param [in] index The index of the current remap port. */ int getPortWidth(QModelIndex const& index) const; @@ -156,9 +156,9 @@ public slots: * Repositions the editor if there is not enough space under the default position. The editor is then resized * to use the available space. * - * @param [in] editor The editor to reposition. - * @param [in] option The style options for the editor. - * @param [in] index The current index. + * @param [in] editor The editor to reposition. + * @param [in] option The style options for the editor. + * @param [in] index The current index. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/remapStates/RemapConditionEditor.h b/editors/ComponentEditor/remapStates/RemapConditionEditor.h index 097f611d9..74a055045 100644 --- a/editors/ComponentEditor/remapStates/RemapConditionEditor.h +++ b/editors/ComponentEditor/remapStates/RemapConditionEditor.h @@ -39,11 +39,11 @@ class RemapConditionEditor : public QGroupBox /*! * The constructor. * - * @param [in] remapPorts The list containing the remap ports of this remap state. - * @param [in] component The component whose remap state is being edited. - * @param [in] parameterFinder The parameter finder used to search the components parameters. - * @param [in] expressionFormatter Changes the parameter ids to names in references. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] remapPorts The list containing the remap ports of this remap state. + * @param [in] component The component whose remap state is being edited. + * @param [in] parameterFinder The parameter finder used to search the components parameters. + * @param [in] expressionFormatter Changes the parameter ids to names in references. + * @param [in] parent Pointer to the owner of this editor. */ RemapConditionEditor(QSharedPointer > > remapPorts, QSharedPointer component, @@ -71,28 +71,28 @@ class RemapConditionEditor : public QGroupBox /*! * Prints an error message to the user. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Prints a notification to the user. * - * @param [in] msg The notification message. + * @param [in] msg The notification message. */ void noticeMessage(const QString& msg) const; /*! * Increase the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to the parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); diff --git a/editors/ComponentEditor/remapStates/RemapConditionModel.h b/editors/ComponentEditor/remapStates/RemapConditionModel.h index 3f97f1c4a..daad4ba78 100644 --- a/editors/ComponentEditor/remapStates/RemapConditionModel.h +++ b/editors/ComponentEditor/remapStates/RemapConditionModel.h @@ -38,12 +38,12 @@ class RemapConditionModel : public ReferencingTableModel, public Parameterizable /*! * The constructor. * - * @param [in] remapPorts The remap ports of the remap state. - * @param [in] componentPorts The ports of the component. - * @param [in] expressionParser Expression parse for configurable elements. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Changes the referenced ids to names. - * @param [in] parent The owner of this model. + * @param [in] remapPorts The remap ports of the remap state. + * @param [in] componentPorts The ports of the component. + * @param [in] expressionParser Expression parse for configurable elements. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Changes the referenced ids to names. + * @param [in] parent The owner of this model. */ RemapConditionModel(QSharedPointer > > remapPorts, QSharedPointer > > componentPorts, @@ -60,79 +60,79 @@ class RemapConditionModel : public ReferencingTableModel, public Parameterizable /*! * Get the number of rows in the model. * - * @param [in] parent Index of the parent of the item. + * @param [in] parent Index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns in the model * - * @param [in] parent Index of the parent of the item. + * @param [in] parent Index of the parent of the item. * - * @return Number of columns currently in the model. + * @return Number of columns currently in the model. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the data for the specified item for the specified role. * - * @param [in] index The index of the item. - * @param [in] role Specifies what kind of data is wanted. + * @param [in] index The index of the item. + * @param [in] role Specifies what kind of data is wanted. * - * @return The data for the given index. + * @return The data for the given index. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Get the data for the headers. * - * @param [in] section The column of the header. - * @param [in] orientation The orientation of the header data. - * @param [in] role Specifies the wanted data role. + * @param [in] section The column of the header. + * @param [in] orientation The orientation of the header data. + * @param [in] role Specifies the wanted data role. * - * @return The header data for the given section. + * @return The header data for the given section. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Sets the data for the given index. * - * @param [in] index The index of the item being modified. - * @param [in] value The new value for the item. - * @param [in] role The role for editing the data. + * @param [in] index The index of the item being modified. + * @param [in] value The new value for the item. + * @param [in] role The role for editing the data. * - * @return True, if data was successfully set, false otherwise. + * @return True, if data was successfully set, false otherwise. */ virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole); /*! * Get information on how specified item can be handled. * - * @param [in] index The index of the item. + * @param [in] index The index of the item. * - * @return Qt::ItemFlags determining the handling information of the item. + * @return Qt::ItemFlags determining the handling information of the item. */ virtual Qt::ItemFlags flags(const QModelIndex &index) const; /*! * Check if the model is in a valid state. * - * @return True, if the model is valid, false otherwise. + * @return True, if the model is valid, false otherwise. */ virtual bool isValid() const; /*! * Update the ports of the model. * - * @param [in] newPorts The new ports for the model. + * @param [in] newPorts The new ports for the model. */ void updatePorts(QSharedPointer > > newPorts); /*! * Get the currently available, non-selected ports. * - * @return A list of port names. + * @return A list of port names. */ QStringList getAvailablePorts(); @@ -140,13 +140,13 @@ public slots: /*! A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ virtual void onAddItem(QModelIndex const& index); /*! An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ virtual void onRemoveItem(QModelIndex const& index); @@ -160,21 +160,21 @@ public slots: /*! * Passes an error message to the user. * - * @param [in] msg The error message. + * @param [in] msg The error message. */ void errorMessage(const QString& msg) const; /*! * Passes a notification message to the user. * - * @param [in] msg The notification message. + * @param [in] msg The notification message. */ void noticeMessage(const QString& msg) const; /*! * Emitted when the list of available ports changes. * - * @param [in] availablePorts The new list of available ports. + * @param [in] availablePorts The new list of available ports. */ void newAvailablePorts(QStringList availablePorts) const; @@ -183,37 +183,37 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if the column can accept expressions, false otherwise. + * @return True, if the column can accept expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets the expression for the index, or the plain value, if an expression is not available. * - * @param [in] index The index of the item. + * @param [in] index The index of the item. * - * @return The expression for the index if available, otherwise the value for the given index. + * @return The expression for the index if available, otherwise the value for the given index. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data for the column. * - * @param [in] index The column of the item to validate. + * @param [in] index The column of the item to validate. * - * @return True, if the data of the item is valid for the column, false otherwise. + * @return True, if the data of the item is valid for the column, false otherwise. */ virtual bool validateIndex(QModelIndex const& index) const; /*! * Gets the number of all the references made to a selected id on the selected row. * - * @param [in] row The row of the selected item. - * @param [in] valueID The id of the referenced parameter. + * @param [in] row The row of the selected item. + * @param [in] valueID The id of the referenced parameter. * - * @return The amount of references made to the selected id on the selected row. + * @return The amount of references made to the selected id on the selected row. */ virtual int getAllReferencesToIdInItemOnRow(const int& row, QString const& valueID) const; @@ -233,29 +233,29 @@ public slots: /*! * Check if the remap port is already in the visible remap ports. * - * @param [in] remapStateRemapPort The remap port. - * @param [in] arrayIndex The index of the array. + * @param [in] remapStateRemapPort The remap port. + * @param [in] arrayIndex The index of the array. * - * @return True, if the remap port is already visible, false otherwise. + * @return True, if the remap port is already visible, false otherwise. */ bool remapPortIsAlreadyVisible(QSharedPointer remapStateRemapPort, int arrayIndex); /*! * Get the end of the array. * - * @param [in] remapPortName The name of the remap port. - * @param [in] newPortIndex The index of the remap port. + * @param [in] remapPortName The name of the remap port. + * @param [in] newPortIndex The index of the remap port. * - * @return The end of the array value. + * @return The end of the array value. */ QString getEndOfArray(QString const& remapPortName, int newPortIndex); /*! * Gets the value for the given index. * - * @param [in] index The index of the data. + * @param [in] index The index of the data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; @@ -267,9 +267,9 @@ public slots: /*! * Get the starting index of the array. * - * @param [in] remapPortName The name of the remap port. + * @param [in] remapPortName The name of the remap port. * - * @return The starting index of the array. + * @return The starting index of the array. */ int getArrayStartIndex(QString const& remapPortName); diff --git a/editors/ComponentEditor/remapStates/RemapStatesEditor.h b/editors/ComponentEditor/remapStates/RemapStatesEditor.h index 284324356..2c96fb008 100644 --- a/editors/ComponentEditor/remapStates/RemapStatesEditor.h +++ b/editors/ComponentEditor/remapStates/RemapStatesEditor.h @@ -32,10 +32,10 @@ class RemapStatesEditor : public ItemEditor /*! * The constructor. * - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance managing the library. - * @param [in] parameterFinder Finder used to locate parameter ids. - * @param [in] parent Pointer to the parent of this editor. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance managing the library. + * @param [in] parameterFinder Finder used to locate parameter ids. + * @param [in] parent Pointer to the parent of this editor. */ RemapStatesEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer parameterFinder, QWidget* parent = 0); @@ -67,7 +67,7 @@ public slots: /*! * Handler for widget's show event. * - * @param [in] event The given show event. + * @param [in] event The given show event. */ virtual void showEvent(QShowEvent* event); diff --git a/editors/ComponentEditor/remapStates/RemapStatesModel.h b/editors/ComponentEditor/remapStates/RemapStatesModel.h index c0d6f5416..397ee6f26 100644 --- a/editors/ComponentEditor/remapStates/RemapStatesModel.h +++ b/editors/ComponentEditor/remapStates/RemapStatesModel.h @@ -39,9 +39,9 @@ class RemapStatesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] remapStates The remap states of the component. - * @param [in] parameterFinder Finder used to locate parameter ids. - * @param [in] parent Pointer to the owner of the model. + * @param [in] remapStates The remap states of the component. + * @param [in] parameterFinder Finder used to locate parameter ids. + * @param [in] parent Pointer to the owner of the model. */ RemapStatesModel(QSharedPointer > > remapStates, QSharedPointer parameterFinder, QObject* parent); @@ -54,57 +54,57 @@ class RemapStatesModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return The number of rows the item has. + * @return The number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of displayable columns the item has. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed + * @return The number of columns to be displayed */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the item flags that define the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return The possible operations for the item as Qt::ItemFlags. + * @return The possible operations for the item as Qt::ItemFlags. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section for the header. - * @param [in] orientation Specifies if the header is horizontal or vertical. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section for the header. + * @param [in] orientation Specifies if the header is horizontal or vertical. + * @param [in] role Specifies the type of the requested data. * - * @return The requested data. + * @return The requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for the specified item. * - * @param [in] index The index of the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index The index of the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return The data for the item. + * @return The data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The index of the item used to store the data. - * @param [in] value The data to be saved. - * @param [in] role What kind of data should be saved. + * @param [in] index The index of the item used to store the data. + * @param [in] value The data to be saved. + * @param [in] role What kind of data should be saved. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); @@ -113,14 +113,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position of the new item. + * @param [in] index The index identifying the position of the new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the position of the item to be removed. + * @param [in] index The index identifying the position of the item to be removed. */ virtual void onRemoveItem(const QModelIndex& index); @@ -134,21 +134,21 @@ public slots: /*! * Emitted when a new remap state is added. * - * @param [in] index The index of the new remap state. + * @param [in] index The index of the new remap state. */ void remapStateAdded(int index); /*! * Emitted when a remap state is removed. * - * @param [in] index The index of the remap state being removed. + * @param [in] index The index of the remap state being removed. */ void remapStateRemoved(int index); /*! * Decrease the number of references to the selected parameter. * - * @param [in] id ID of the selected parameter. + * @param [in] id ID of the selected parameter. */ void decreaseReferences(QString id); @@ -162,7 +162,7 @@ public slots: /*! * Remove references from a selected remap state. * - * @param [in] remapState The selected remap state. + * @param [in] remapState The selected remap state. */ void removeReferencesFromRemapState(QSharedPointer remapState); diff --git a/editors/ComponentEditor/remapStates/SingleRemapStateEditor.h b/editors/ComponentEditor/remapStates/SingleRemapStateEditor.h index f76fb707e..982ac5623 100644 --- a/editors/ComponentEditor/remapStates/SingleRemapStateEditor.h +++ b/editors/ComponentEditor/remapStates/SingleRemapStateEditor.h @@ -30,12 +30,12 @@ class SingleRemapStateEditor : public ItemEditor /*! * The constructor. * - * @param [in] component Pointer to the component that contains the view. - * @param [in] remapState Pointer to the remap state being edited. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] parameterFinder The finder for the parameter references. - * @param [in] expressionFormatter Changes the referenced ids to parameter names. - * @param [in] parent Pointer to the owner of this editor. + * @param [in] component Pointer to the component that contains the view. + * @param [in] remapState Pointer to the remap state being edited. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] parameterFinder The finder for the parameter references. + * @param [in] expressionFormatter Changes the referenced ids to parameter names. + * @param [in] parent Pointer to the owner of this editor. */ SingleRemapStateEditor(QSharedPointer component, QSharedPointer remapState, @@ -63,7 +63,7 @@ class SingleRemapStateEditor : public ItemEditor /*! * The show event for this editor. * - * @param [in] event The show event. + * @param [in] event The show event. */ virtual void showEvent(QShowEvent * event); diff --git a/editors/ComponentEditor/remapStates/ValueOrIndexedValueEditor.h b/editors/ComponentEditor/remapStates/ValueOrIndexedValueEditor.h index 8d4c40734..47fab14f4 100644 --- a/editors/ComponentEditor/remapStates/ValueOrIndexedValueEditor.h +++ b/editors/ComponentEditor/remapStates/ValueOrIndexedValueEditor.h @@ -35,10 +35,10 @@ class ValueOrIndexedValueEditor : public QTableView /*! * The constructor. * - * @param [in] finder The used parameter finder. - * @param [in] parser The used expression parser. - * @param [in] formatter The used expression formatter. - * @param [in] parent The parent widget of this table. + * @param [in] finder The used parameter finder. + * @param [in] parser The used expression parser. + * @param [in] formatter The used expression formatter. + * @param [in] parent The parent widget of this table. */ ValueOrIndexedValueEditor(QSharedPointer finder, QSharedPointer parser, QSharedPointer formatter, Document::Revision docRevision, QWidget* parent); @@ -50,24 +50,24 @@ class ValueOrIndexedValueEditor : public QTableView /*! * Setup the array editor. * - * @param [in] value The current value of the remap condition. - * @param [in] leftBound The left bound of the array. - * @param [in] rightBound The right bound of the array. + * @param [in] value The current value of the remap condition. + * @param [in] leftBound The left bound of the array. + * @param [in] rightBound The right bound of the array. */ void setupArrayEditor(QString const& value, int const& leftBound, int const& rightBound); /*! * Get the value of the editor. * - * @return A single value, if the single editor was edited. An array if the array was edited. + * @return A single value, if the single editor was edited. An array if the array was edited. */ QString getValueData() const; /*! * The event filter for this widget. * - * @param [in] filterObject The object to be filtered. - * @param [in] filterEvent The event to be filtered. + * @param [in] filterObject The object to be filtered. + * @param [in] filterEvent The event to be filtered. */ virtual bool eventFilter(QObject* filterObject, QEvent* filterEvent); @@ -76,14 +76,14 @@ class ValueOrIndexedValueEditor : public QTableView /*! * Increase the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void increaseReferences(QString id); /*! * Decrease the amount of references to a parameter corresponding to the id. * - * @param [in] id The id of the parameter being searched for. + * @param [in] id The id of the parameter being searched for. */ void decreaseReferences(QString id); @@ -117,9 +117,9 @@ private slots: /*! * Create a parameter name completer. * - * @param [in] completerParent The parent for the completer. + * @param [in] completerParent The parent for the completer. * - * @return The created parameter name completer. + * @return The created parameter name completer. */ QCompleter* createParameterNameCompleter(QObject* completerParent) const; @@ -131,25 +131,25 @@ private slots: /*! * Calculate the formatted value for the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. * - * @return The formatted value of the selected expression. + * @return The formatted value of the selected expression. */ QString formattedValueFor(QString const& expression) const; /*! * Set the value for the single value editor. * - * @param [in] value The new value. + * @param [in] value The new value. */ void setValueToSingleEditor(QString const& value); /*! * Check if the array contains values. * - * @param [in] arrayContents The contents of the array. + * @param [in] arrayContents The contents of the array. * - * @return True, if the array contains any values, false otherwise. + * @return True, if the array contains any values, false otherwise. */ bool arrayContainsValues(QString const& arrayContents) const; diff --git a/editors/ComponentEditor/resetTypes/ResetTypesDelegate.h b/editors/ComponentEditor/resetTypes/ResetTypesDelegate.h index aff4b31b4..cff4bf5c8 100644 --- a/editors/ComponentEditor/resetTypes/ResetTypesDelegate.h +++ b/editors/ComponentEditor/resetTypes/ResetTypesDelegate.h @@ -27,7 +27,7 @@ class ResetTypesDelegate: public QStyledItemDelegate /*! * The constructor * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ ResetTypesDelegate(QObject *parent); @@ -39,11 +39,11 @@ class ResetTypesDelegate: public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -51,17 +51,17 @@ class ResetTypesDelegate: public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/resetTypes/ResetTypesEditor.h b/editors/ComponentEditor/resetTypes/ResetTypesEditor.h index 57766064a..81796781b 100644 --- a/editors/ComponentEditor/resetTypes/ResetTypesEditor.h +++ b/editors/ComponentEditor/resetTypes/ResetTypesEditor.h @@ -36,10 +36,10 @@ class ResetTypesEditor : public ItemEditor /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] validator The validator for components. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] validator The validator for components. + * @param [in] parent The parent of this editor. */ ResetTypesEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer validator, QWidget* parent = 0); diff --git a/editors/ComponentEditor/resetTypes/ResetTypesModel.h b/editors/ComponentEditor/resetTypes/ResetTypesModel.h index 7fff19cfc..f4c8ffe49 100644 --- a/editors/ComponentEditor/resetTypes/ResetTypesModel.h +++ b/editors/ComponentEditor/resetTypes/ResetTypesModel.h @@ -32,9 +32,9 @@ class ResetTypesModel : public QAbstractTableModel /*! * The constructor * - * @param [in] component The component being edited. - * @param [in] validator The validator for cpus. - * @param [in] parent The owner of this model. + * @param [in] component The component being edited. + * @param [in] validator The validator for cpus. + * @param [in] parent The owner of this model. */ ResetTypesModel(QSharedPointer component, QSharedPointer validator, QObject* parent); @@ -50,59 +50,59 @@ class ResetTypesModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ int rowCount(const QModelIndex& parent = QModelIndex()) const final; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ int columnCount(const QModelIndex& parent = QModelIndex()) const final; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const final; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving was successful. + * @return True if saving was successful. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; @@ -111,14 +111,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(const QModelIndex& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(const QModelIndex& index); diff --git a/editors/ComponentEditor/software/PropertyValueDelegate.h b/editors/ComponentEditor/software/PropertyValueDelegate.h index d890449b3..1ea461c2b 100644 --- a/editors/ComponentEditor/software/PropertyValueDelegate.h +++ b/editors/ComponentEditor/software/PropertyValueDelegate.h @@ -29,7 +29,7 @@ class PropertyValueDelegate : public QStyledItemDelegate /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ PropertyValueDelegate(QObject* parent = 0); @@ -41,18 +41,18 @@ class PropertyValueDelegate : public QStyledItemDelegate /*! * Sets the allowed properties. * - * @param [in] properties The list of allowed properties. + * @param [in] properties The list of allowed properties. */ void setAllowedProperties(QList< QSharedPointer > properties); /*! * Creates a new editor for the given item. * - * @param [in] parent The parent widget. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent The parent widget. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -60,17 +60,17 @@ class PropertyValueDelegate : public QStyledItemDelegate /*! * Sets the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Saves the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/software/PropertyValueEditor.h b/editors/ComponentEditor/software/PropertyValueEditor.h index f02725961..3b89f099d 100644 --- a/editors/ComponentEditor/software/PropertyValueEditor.h +++ b/editors/ComponentEditor/software/PropertyValueEditor.h @@ -32,7 +32,7 @@ class PropertyValueEditor : public QGroupBox /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ PropertyValueEditor(QWidget* parent); @@ -44,7 +44,7 @@ class PropertyValueEditor : public QGroupBox /*! * Sets the allowed properties. * - * @param [in] properties The list of allowed properties. + * @param [in] properties The list of allowed properties. */ void setAllowedProperties(QList< QSharedPointer > const& properties); @@ -60,7 +60,7 @@ public slots: /*! * Sets the data for editing. * - * @param [in] propertyValue The property values. + * @param [in] propertyValue The property values. */ void setData(QMap const& propertyValues); diff --git a/editors/ComponentEditor/software/PropertyValueModel.h b/editors/ComponentEditor/software/PropertyValueModel.h index eb0304de6..d09e94009 100644 --- a/editors/ComponentEditor/software/PropertyValueModel.h +++ b/editors/ComponentEditor/software/PropertyValueModel.h @@ -31,7 +31,7 @@ class PropertyValueModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ PropertyValueModel(QObject *parent); @@ -47,14 +47,14 @@ class PropertyValueModel : public QAbstractTableModel /*! * Synchronizes the model to match with the given list of allowed properties. * - * @param [in] properties The list of allowed properties. + * @param [in] properties The list of allowed properties. */ void setAllowedProperties(QList< QSharedPointer > properties); /*! * Sets the data for editing. * - * @param [in] propertyValue The property values. + * @param [in] propertyValue The property values. */ void setData(QMap const& propertyValues); @@ -66,48 +66,48 @@ class PropertyValueModel : public QAbstractTableModel /*! * Disables/enables editing. * - * @param [in] locked True if model is locked i.e. disabled, otherwise false. + * @param [in] locked True if model is locked i.e. disabled, otherwise false. */ void setLock(bool locked); /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ int rowCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid + * @param [in] parent Model index of the parent of the item. Must be invalid * because this is not hierarchical model. * - * @return Always returns 2. + * @return Always returns 2. */ int columnCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data. + * @return QVariant containing the data. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the header data. + * @return QVariant containing the header data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; @@ -115,20 +115,20 @@ class PropertyValueModel : public QAbstractTableModel /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Item flags that define how object can be handled. + * @return Item flags that define how object can be handled. */ Qt::ItemFlags flags(QModelIndex const& index) const final; /*! * Returns the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole) final; diff --git a/editors/ComponentEditor/software/SWPropertiesEditor.h b/editors/ComponentEditor/software/SWPropertiesEditor.h index 249237357..dcbcd9bec 100644 --- a/editors/ComponentEditor/software/SWPropertiesEditor.h +++ b/editors/ComponentEditor/software/SWPropertiesEditor.h @@ -37,9 +37,9 @@ class SWPropertiesEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parent The owner of the editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parent The owner of the editor. */ SWPropertiesEditor(QSharedPointer component, LibraryInterface* handler, QWidget *parent = 0); @@ -51,7 +51,7 @@ class SWPropertiesEditor : public ItemEditor /*! * Checks for the validity of the edited parameters. * - * @return True if all parameters are in valid state. + * @return True if all parameters are in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/software/apiInterface/ApiInterfaceEditor.h b/editors/ComponentEditor/software/apiInterface/ApiInterfaceEditor.h index 5192e9f09..85f73cc9d 100644 --- a/editors/ComponentEditor/software/apiInterface/ApiInterfaceEditor.h +++ b/editors/ComponentEditor/software/apiInterface/ApiInterfaceEditor.h @@ -35,10 +35,10 @@ class ApiInterfaceEditor : public ItemEditor /*! * Constructor. * - * @param [in] libHandler The library handler. - * @param [in] component The component being edited. - * @param [in] APIInterface The API interface being edited. - * @param [in] parent The parent widget. + * @param [in] libHandler The library handler. + * @param [in] component The component being edited. + * @param [in] APIInterface The API interface being edited. + * @param [in] parent The parent widget. */ ApiInterfaceEditor(LibraryInterface* libHandler, QSharedPointer component, @@ -59,7 +59,7 @@ class ApiInterfaceEditor : public ItemEditor /*! * Checks for the validity of the edited API interface. * - * @return True if the API interface is in valid state. + * @return True if the API interface is in valid state. */ bool isValid() const; diff --git a/editors/ComponentEditor/software/apiInterface/apiinterfacesdelegate.h b/editors/ComponentEditor/software/apiInterface/apiinterfacesdelegate.h index 5f5e31b64..6ec82a82a 100644 --- a/editors/ComponentEditor/software/apiInterface/apiinterfacesdelegate.h +++ b/editors/ComponentEditor/software/apiInterface/apiinterfacesdelegate.h @@ -25,7 +25,7 @@ class ApiInterfacesDelegate : public QStyledItemDelegate /*! The constructor. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ ApiInterfacesDelegate(QObject *parent); @@ -40,27 +40,27 @@ class ApiInterfacesDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/software/apiInterface/apiinterfaceseditor.h b/editors/ComponentEditor/software/apiInterface/apiinterfaceseditor.h index 9abc61a83..cd7001458 100644 --- a/editors/ComponentEditor/software/apiInterface/apiinterfaceseditor.h +++ b/editors/ComponentEditor/software/apiInterface/apiinterfaceseditor.h @@ -47,9 +47,9 @@ class ApiInterfacesEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing the library. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing the library. + * @param [in] parent The parent of this editor. */ ApiInterfacesEditor(QSharedPointer component, LibraryInterface* handler, QWidget* parent = 0); @@ -64,7 +64,7 @@ class ApiInterfacesEditor : public ItemEditor /*! Check for the validity of the editor * - * @return True if the editor is in valid state. + * @return True if the editor is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/software/apiInterface/apiinterfacesmodel.h b/editors/ComponentEditor/software/apiInterface/apiinterfacesmodel.h index 1e85bac19..ef7c7b1de 100644 --- a/editors/ComponentEditor/software/apiInterface/apiinterfacesmodel.h +++ b/editors/ComponentEditor/software/apiInterface/apiinterfacesmodel.h @@ -30,9 +30,9 @@ class ApiInterfacesModel : public QAbstractTableModel /*! The constructor * - * @param [in] component The component being edited. - * @param [in] library The library interface. - * @param [in] parent The owner of the model. + * @param [in] component The component being edited. + * @param [in] library The library interface. + * @param [in] parent The owner of the model. */ ApiInterfacesModel(QSharedPointer component, LibraryInterface* library, QObject* parent); @@ -47,87 +47,87 @@ class ApiInterfacesModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! Check if the API interface model is in a valid state. * - * @return bool True if the state is valid and writing is possible. + * @return bool True if the state is valid and writing is possible. */ bool isValid() const; /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, QModelIndex const& parent); @@ -136,13 +136,13 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); @@ -153,13 +153,13 @@ public slots: /*! Emitted when a new api interface is added to the model. * - * @param [in] index The index of the added api interface. + * @param [in] index The index of the added api interface. */ void apiAdded(int index); /*! Emitted when an api interface is removed from the model. * - * @param [in] index The index of the api interface to remove. + * @param [in] index The index of the api interface to remove. */ void apiRemoved(int index); diff --git a/editors/ComponentEditor/software/comInterface/ComInterfaceEditor.h b/editors/ComponentEditor/software/comInterface/ComInterfaceEditor.h index 75abe78fb..37c5e2128 100644 --- a/editors/ComponentEditor/software/comInterface/ComInterfaceEditor.h +++ b/editors/ComponentEditor/software/comInterface/ComInterfaceEditor.h @@ -38,10 +38,10 @@ class ComInterfaceEditor : public ItemEditor /*! The constructor * - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] comInterface The COM interface being edited. - * @param [in] parent The parent widget. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] comInterface The COM interface being edited. + * @param [in] parent The parent widget. * */ ComInterfaceEditor(LibraryInterface* libHandler, QSharedPointer component, @@ -59,7 +59,7 @@ class ComInterfaceEditor : public ItemEditor /*! * Checks for the validity of the edited COM interface. * - * @return True if the COM interface is in valid state. + * @return True if the COM interface is in valid state. */ bool isValid() const; @@ -96,7 +96,7 @@ private slots: /*! * Updates the editors for showing values associated with the given COM definition. * - * @param [in] comDefinitionVLNV The COM definition to update the editors for. + * @param [in] comDefinitionVLNV The COM definition to update the editors for. */ void updateEditorsForComDefinition(VLNV const& comDefinitionVLNV); diff --git a/editors/ComponentEditor/software/comInterface/cominterfacesdelegate.h b/editors/ComponentEditor/software/comInterface/cominterfacesdelegate.h index fdbddc99a..765c43d67 100644 --- a/editors/ComponentEditor/software/comInterface/cominterfacesdelegate.h +++ b/editors/ComponentEditor/software/comInterface/cominterfacesdelegate.h @@ -25,7 +25,7 @@ class ComInterfacesDelegate : public QStyledItemDelegate /*! The constructor. * - * @param [in] parent The owner of this delegate. + * @param [in] parent The owner of this delegate. */ ComInterfacesDelegate(QObject *parent); @@ -34,27 +34,27 @@ class ComInterfacesDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, const QModelIndex& index) const; diff --git a/editors/ComponentEditor/software/comInterface/cominterfaceseditor.h b/editors/ComponentEditor/software/comInterface/cominterfaceseditor.h index 94a25692a..2fef9b253 100644 --- a/editors/ComponentEditor/software/comInterface/cominterfaceseditor.h +++ b/editors/ComponentEditor/software/comInterface/cominterfaceseditor.h @@ -47,9 +47,9 @@ class ComInterfacesEditor : public ItemEditor /*! The constructor * - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent of this editor. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent of this editor. * */ ComInterfacesEditor(LibraryInterface* libHandler, QSharedPointer component, QWidget* parent = 0); @@ -59,7 +59,7 @@ class ComInterfacesEditor : public ItemEditor /*! Check for the validity of the editor * - * @return True if the editor is in valid state. + * @return True if the editor is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/software/comInterface/cominterfacesmodel.h b/editors/ComponentEditor/software/comInterface/cominterfacesmodel.h index 84c4d3a96..65cc1d798 100644 --- a/editors/ComponentEditor/software/comInterface/cominterfacesmodel.h +++ b/editors/ComponentEditor/software/comInterface/cominterfacesmodel.h @@ -31,9 +31,9 @@ class ComInterfacesModel : public QAbstractTableModel /*! The constructor. * - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The owner of this model. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The owner of this model. * */ ComInterfacesModel(LibraryInterface* libHandler, QSharedPointer component, QObject *parent); @@ -49,87 +49,87 @@ class ComInterfacesModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! Check if the COM interfaces model is in a valid state. * - * @return bool True if the state is valid and writing is possible. + * @return bool True if the state is valid and writing is possible. */ bool isValid() const; /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent); @@ -138,14 +138,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ virtual void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. * */ virtual void onRemoveItem(QModelIndex const& index); @@ -157,14 +157,14 @@ public slots: /*! Emitted when a new COM interface is added to the model. * - * @param [in] index The index of the added COM interface. + * @param [in] index The index of the added COM interface. * */ void comIfAdded(int index); /*! Emitted when a COM interface is removed from the model. * - * @param [in] index The index of the COM interface to remove. + * @param [in] index The index of the COM interface to remove. * */ void comIfRemoved(int index); diff --git a/editors/ComponentEditor/software/systemView/SystemViewEditor.h b/editors/ComponentEditor/software/systemView/SystemViewEditor.h index 42a5788fd..54dc2f304 100644 --- a/editors/ComponentEditor/software/systemView/SystemViewEditor.h +++ b/editors/ComponentEditor/software/systemView/SystemViewEditor.h @@ -32,11 +32,11 @@ class SystemViewEditor : public ItemEditor /*! * Constructor. * - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] component The component being edited. - * @param [in] systemView The system view being edited. - * @param [in] libHandler The library handler. - * @param [in] parent The parent widget. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] component The component being edited. + * @param [in] systemView The system view being edited. + * @param [in] libHandler The library handler. + * @param [in] parent The parent widget. */ SystemViewEditor(FileSetInterface* fileSetInterface, QSharedPointer component, QSharedPointer systemView, LibraryInterface* libHandler, QWidget* parent); @@ -47,7 +47,7 @@ class SystemViewEditor : public ItemEditor /*! * Checks for the validity of the edited API interface. * - * @return True if the API interface is in valid state. + * @return True if the API interface is in valid state. */ bool isValid() const; diff --git a/editors/ComponentEditor/software/systemView/SystemViewsDelegate.h b/editors/ComponentEditor/software/systemView/SystemViewsDelegate.h index 91c17f359..b126af0fd 100644 --- a/editors/ComponentEditor/software/systemView/SystemViewsDelegate.h +++ b/editors/ComponentEditor/software/systemView/SystemViewsDelegate.h @@ -35,7 +35,7 @@ class SystemViewsDelegate : public QStyledItemDelegate /*! The constructor. * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ SystemViewsDelegate(QObject *parent); @@ -44,28 +44,28 @@ class SystemViewsDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/software/systemView/SystemViewsEditor.h b/editors/ComponentEditor/software/systemView/SystemViewsEditor.h index 84135f71b..6877c471b 100644 --- a/editors/ComponentEditor/software/systemView/SystemViewsEditor.h +++ b/editors/ComponentEditor/software/systemView/SystemViewsEditor.h @@ -38,9 +38,9 @@ class SystemViewsEditor : public ItemEditor /*! The constructor * - * @param [in] component The component being edited. - * @param [in] handler The instance managing library. - * @param [in] parent The parent of this editor. + * @param [in] component The component being edited. + * @param [in] handler The instance managing library. + * @param [in] parent The parent of this editor. */ SystemViewsEditor(QSharedPointer component, LibraryInterface* handler, QWidget* parent = 0); @@ -49,7 +49,7 @@ class SystemViewsEditor : public ItemEditor /*! Check for the validity of the editor * - * @return True if the editor is in valid state. + * @return True if the editor is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/software/systemView/SystemViewsModel.h b/editors/ComponentEditor/software/systemView/SystemViewsModel.h index cf12f7236..bab9569df 100644 --- a/editors/ComponentEditor/software/systemView/SystemViewsModel.h +++ b/editors/ComponentEditor/software/systemView/SystemViewsModel.h @@ -31,9 +31,9 @@ class SystemViewsModel : public QAbstractTableModel /*! The constructor * - * @param [in] component The component being edited. - * @param [in] library The library interface. - * @param [in] parent The owner of the model. + * @param [in] component The component being edited. + * @param [in] library The library interface. + * @param [in] parent The owner of the model. */ SystemViewsModel(QSharedPointer component, LibraryInterface* library, QObject* parent); @@ -42,89 +42,89 @@ class SystemViewsModel : public QAbstractTableModel /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! Check if the software views model is in a valid state. * - * @return bool True if the state is valid and writing is possible. + * @return bool True if the state is valid and writing is possible. */ bool isValid() const; /*! * Returns the supported actions of a drop. * - * @return The drop actions supported by the model. + * @return The drop actions supported by the model. */ Qt::DropActions supportedDropActions() const; /*! * Returns a list of supported MIME data types. * - * @return The supported MIME types. + * @return The supported MIME types. */ QStringList mimeTypes() const; /*! * Handler for the dropped MIME data. * - * @param [in] data The data associated to the drop. - * @param [in] action The drop action. - * @param [in] row The row beneath the drop position. - * @param [in] column The column beneath the drop position. - * @param [in] parent The parent index of the drop position. + * @param [in] data The data associated to the drop. + * @param [in] action The drop action. + * @param [in] row The row beneath the drop position. + * @param [in] column The column beneath the drop position. + * @param [in] parent The parent index of the drop position. * - * @return True, if the model could handle the data, otherwise false. + * @return True, if the model could handle the data, otherwise false. */ bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent); @@ -133,14 +133,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ virtual void onAddItem(const QModelIndex& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. * */ virtual void onRemoveItem(const QModelIndex& index); @@ -152,14 +152,14 @@ public slots: /*! Emitted when a new software view is added to the model. * - * @param [in] index The index of the added software view. + * @param [in] index The index of the added software view. * */ void viewAdded(int index); /*! Emitted when a view is removed from the model. * - * @param [in] index The index of the software view to remove. + * @param [in] index The index of the software view to remove. * */ void viewRemoved(int index); diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorChoicesItem.h b/editors/ComponentEditor/treeStructure/ComponentEditorChoicesItem.h index 5042e2e48..8f50066f7 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorChoicesItem.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorChoicesItem.h @@ -31,11 +31,11 @@ class ComponentEditorChoicesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler The library interface. - * @param [in] component The currently active component. - * @param [in] expressionParser The selected expression parser. - * @param [in] parent The owner of this item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler The library interface. + * @param [in] component The currently active component. + * @param [in] expressionParser The selected expression parser. + * @param [in] parent The owner of this item. */ ComponentEditorChoicesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer expressionParser, @@ -47,35 +47,35 @@ class ComponentEditorChoicesItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check whether this item is in a valid state. * - * @return True, if the item is valid, false otherwise. + * @return True, if the item is valid, false otherwise. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorIndirectInterfacesItem.h b/editors/ComponentEditor/treeStructure/ComponentEditorIndirectInterfacesItem.h index ba3ed270e..a850b3c31 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorIndirectInterfacesItem.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorIndirectInterfacesItem.h @@ -32,16 +32,16 @@ class ComponentEditorIndirectInterfacesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this item. - * @param [in] parentWnd The parent window. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this item. + * @param [in] parentWnd The parent window. */ ComponentEditorIndirectInterfacesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -65,38 +65,38 @@ class ComponentEditorIndirectInterfacesItem : public ComponentEditorItem * * The font is bold, if bus interfaces exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const override; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const override; /*! Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const override; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor() override; /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index) override; /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewItem.h b/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewItem.h index 5291e54f5..fcdd5acce 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewItem.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewItem.h @@ -29,12 +29,12 @@ class ComponentEditorSystemViewItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] systemView The system view to edit. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] parent The parent item. + * @param [in] systemView The system view to edit. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parent The parent item. */ ComponentEditorSystemViewItem(QSharedPointer systemView, ComponentEditorTreeModel* model, @@ -51,28 +51,28 @@ class ComponentEditorSystemViewItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); @@ -84,7 +84,7 @@ class ComponentEditorSystemViewItem : public ComponentEditorItem /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions() const; diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewsItem.h b/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewsItem.h index 5e35e1132..cdd7e8177 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewsItem.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorSystemViewsItem.h @@ -29,13 +29,13 @@ class ComponentEditorSystemViewsItem : public ComponentEditorItem /*! * The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. + * @param [in] parent The parent item. */ ComponentEditorSystemViewsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -53,35 +53,35 @@ class ComponentEditorSystemViewsItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. The font is bold, if system views exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); @@ -93,9 +93,9 @@ class ComponentEditorSystemViewsItem : public ComponentEditorItem /*! * Construct the interface for accessing file sets. * - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter Formatter for expressions. - * @param [in] expressionParser Parser for expressions. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter Formatter for expressions. + * @param [in] expressionParser Parser for expressions. */ void constructFileSetInterface(QSharedPointer parameterFinder, QSharedPointer expressionParser, diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorTreeDelegate.h b/editors/ComponentEditor/treeStructure/ComponentEditorTreeDelegate.h index 407d6d93d..d45cff430 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorTreeDelegate.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorTreeDelegate.h @@ -26,9 +26,9 @@ class ComponentEditorTreeDelegate : public QItemDelegate /*! * The constructor. * - * @param [in] parent + * @param [in] parent * - * @return + * @return */ ComponentEditorTreeDelegate(QObject* parent = nullptr); @@ -44,9 +44,9 @@ class ComponentEditorTreeDelegate : public QItemDelegate /*! * Renders the item indicated by index. * - * @param [in] painter The painter to use for rendering. - * @param [in] option Options to guide the rendering. - * @param [in] index The index of the item to render. + * @param [in] painter The painter to use for rendering. + * @param [in] option Options to guide the rendering. + * @param [in] index The index of the item to render. */ void paint(QPainter* painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; diff --git a/editors/ComponentEditor/treeStructure/ComponentEditorTreeSortProxyModel.h b/editors/ComponentEditor/treeStructure/ComponentEditorTreeSortProxyModel.h index 17b3af8b3..d265afc7e 100644 --- a/editors/ComponentEditor/treeStructure/ComponentEditorTreeSortProxyModel.h +++ b/editors/ComponentEditor/treeStructure/ComponentEditorTreeSortProxyModel.h @@ -26,7 +26,7 @@ class ComponentEditorTreeProxyModel : public QSortFilterProxyModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ComponentEditorTreeProxyModel(QObject *parent = 0); @@ -38,7 +38,7 @@ class ComponentEditorTreeProxyModel : public QSortFilterProxyModel /*! * Sets the items to be hidden. * - * @param [in] hiddenItemNames The names of the items to hide. + * @param [in] hiddenItemNames The names of the items to hide. */ void setRowVisibility(QStringList hiddenItemNames); @@ -51,20 +51,20 @@ class ComponentEditorTreeProxyModel : public QSortFilterProxyModel * * Note that the corresponding summary view may sort its content into other order. * - * @param [in] left The left item in comparison left < right. - * @param [in] right The right item in comparison left < right. + * @param [in] left The left item in comparison left < right. + * @param [in] right The right item in comparison left < right. * - * @return True if left precedes right, otherwise false. + * @return True if left precedes right, otherwise false. */ bool lessThan(QModelIndex const& left, QModelIndex const& right) const; /*! * Filters the selected rows. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if row passes filters, otherwise false. + * @return True, if row passes filters, otherwise false. */ bool filterAcceptsRow(int sourceRow, QModelIndex const& sourceParent) const; @@ -77,7 +77,7 @@ class ComponentEditorTreeProxyModel : public QSortFilterProxyModel /*! * Checks if item is valid. Invalid items should not be hidden. * - * @param [in] index Index of item. + * @param [in] index Index of item. */ bool itemIsValidAndCanBeHidden(QModelIndex const& index) const; diff --git a/editors/ComponentEditor/treeStructure/ComponentInstantiationsItem.h b/editors/ComponentEditor/treeStructure/ComponentInstantiationsItem.h index 6ded03fbb..1371aa76a 100644 --- a/editors/ComponentEditor/treeStructure/ComponentInstantiationsItem.h +++ b/editors/ComponentEditor/treeStructure/ComponentInstantiationsItem.h @@ -38,17 +38,17 @@ class ComponentInstantiationsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] validator The single instantiation validator. - * @param [in] allInstantiationsValidator The validator validating all instantiations together. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] instantiationInterface Interface for accessing component instantiations. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] validator The single instantiation validator. + * @param [in] allInstantiationsValidator The validator validating all instantiations together. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] instantiationInterface Interface for accessing component instantiations. + * @param [in] parent The parent item. */ ComponentInstantiationsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer validator, @@ -65,35 +65,35 @@ class ComponentInstantiationsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; diff --git a/editors/ComponentEditor/treeStructure/DesignConfigurationInstantiationsItem.h b/editors/ComponentEditor/treeStructure/DesignConfigurationInstantiationsItem.h index e920f7ea0..310c9a052 100644 --- a/editors/ComponentEditor/treeStructure/DesignConfigurationInstantiationsItem.h +++ b/editors/ComponentEditor/treeStructure/DesignConfigurationInstantiationsItem.h @@ -37,16 +37,16 @@ class DesignConfigurationInstantiationsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] validator The instantiation validator to use. - * @param [in] parameterValidator The parameter validator to use. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] validator The instantiation validator to use. + * @param [in] parameterValidator The parameter validator to use. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent item. */ DesignConfigurationInstantiationsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer allInstantiationsValidator, @@ -61,28 +61,28 @@ class DesignConfigurationInstantiationsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/DesignInstantiationsItem.h b/editors/ComponentEditor/treeStructure/DesignInstantiationsItem.h index 89d003085..a02536de6 100644 --- a/editors/ComponentEditor/treeStructure/DesignInstantiationsItem.h +++ b/editors/ComponentEditor/treeStructure/DesignInstantiationsItem.h @@ -35,13 +35,13 @@ class DesignInstantiationsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] validator The validator for design instantiation. - * @param [in] componentParameterFinder Finder for component parameters. - * @param [in] referenceCounter Handles the usage count of parameters. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] validator The validator for design instantiation. + * @param [in] componentParameterFinder Finder for component parameters. + * @param [in] referenceCounter Handles the usage count of parameters. + * @param [in] parent The parent item. */ DesignInstantiationsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer validator, @@ -56,28 +56,28 @@ class DesignInstantiationsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/InstantiationsItem.h b/editors/ComponentEditor/treeStructure/InstantiationsItem.h index 6d4447a85..ebef3598e 100644 --- a/editors/ComponentEditor/treeStructure/InstantiationsItem.h +++ b/editors/ComponentEditor/treeStructure/InstantiationsItem.h @@ -36,14 +36,14 @@ class InstantiationsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent item. */ InstantiationsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer referenceCounter, @@ -56,35 +56,35 @@ class InstantiationsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/MemoryRemapItem.h b/editors/ComponentEditor/treeStructure/MemoryRemapItem.h index 3e82e5796..5116b1c54 100644 --- a/editors/ComponentEditor/treeStructure/MemoryRemapItem.h +++ b/editors/ComponentEditor/treeStructure/MemoryRemapItem.h @@ -39,18 +39,18 @@ class MemoryRemapItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] memoryRemap The memory remap being edited. - * @param [in] parentMemoryMap The parent memory map of the memory remap. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser to use. - * @param [in] memoryMapValidator Validator for memory maps. - * @param [in] mapInterface Interface for accessing memory maps. - * @param [in] parent The parent item. + * @param [in] memoryRemap The memory remap being edited. + * @param [in] parentMemoryMap The parent memory map of the memory remap. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser to use. + * @param [in] memoryMapValidator Validator for memory maps. + * @param [in] mapInterface Interface for accessing memory maps. + * @param [in] parent The parent item. */ MemoryRemapItem(QSharedPointer memoryRemap, QSharedPointer parentMemoryMap, @@ -79,35 +79,35 @@ class MemoryRemapItem : public ComponentEditorItem /*! * Get the tool tip for this item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return True, if the item is in a valid state, false otherwise. + * @return True, if the item is in a valid state, false otherwise. */ virtual bool isValid() const; /*! * Get the The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index of the new child. + * @param [in] index The index of the new child. */ virtual void createChild(int index) override final; @@ -116,21 +116,21 @@ class MemoryRemapItem : public ComponentEditorItem /*! * Get The visualizer of this item. * - * @return The visualizer to user for this item. + * @return The visualizer to user for this item. */ virtual ItemVisualizer* visualizer(); /*! * Set the visualizer for this item. * - * @param [in] visualizer The visualizer. + * @param [in] visualizer The visualizer. */ virtual void setVisualizer(MemoryMapsVisualizer* visualizer); /*! * Get the visualizer graphics item for the memory remap. * - * @return The graphics item. + * @return The graphics item. */ virtual QGraphicsItem* getGraphicsItem(); @@ -169,7 +169,7 @@ public slots: /*! * Change the used address unit bits in the editor. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); @@ -180,33 +180,33 @@ public slots: /* * Informs of address block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void addressBlockNameChanged(QString const& oldName, QString const& newName); /* * Informs of subspace map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void subspaceMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory remap name change. * - * @param [in] parentName Name of the containing memory map. - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] parentName Name of the containing memory map. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/ModesItem.h b/editors/ComponentEditor/treeStructure/ModesItem.h index 0d2a826be..dff69675c 100644 --- a/editors/ComponentEditor/treeStructure/ModesItem.h +++ b/editors/ComponentEditor/treeStructure/ModesItem.h @@ -33,14 +33,14 @@ class ModesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for the references. - * @param [in] parameterFinder Finds the referenced parameters. - * @param [in] expressionFormatter Changes the referenced ids to parameter names. - * @param [in] expressionParser Expression parser for remap states. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for the references. + * @param [in] parameterFinder Finds the referenced parameters. + * @param [in] expressionFormatter Changes the referenced ids to parameter names. + * @param [in] expressionParser Expression parser for remap states. + * @param [in] parent The parent item. */ ModesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -57,42 +57,42 @@ class ModesItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return The font to be used. + * @return The font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip for the item. + * @return The text for the tool tip for the item. */ virtual QString getTooltip() const; /*! * Get the text to be displayed in the tree for this item. * - * @return The text to be displayed. + * @return The text to be displayed. */ virtual QString text() const; /*! * Get the The editor of this item. * - * @return The editor to use with this item. + * @return The editor to use with this item. */ virtual ItemEditor* editor(); /*! * Create a child item. * - * @param [in] index The index of the child item. + * @param [in] index The index of the child item. */ virtual void createChild(int index); /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; diff --git a/editors/ComponentEditor/treeStructure/ParameterizableItem.h b/editors/ComponentEditor/treeStructure/ParameterizableItem.h index 53b4daea7..89faddc06 100644 --- a/editors/ComponentEditor/treeStructure/ParameterizableItem.h +++ b/editors/ComponentEditor/treeStructure/ParameterizableItem.h @@ -35,10 +35,10 @@ class ParameterizableItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ ParameterizableItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, ComponentEditorItem* parent); @@ -46,9 +46,9 @@ class ParameterizableItem : public ComponentEditorItem /*! * The constructor for root item. * - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent object. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent object. */ ParameterizableItem(LibraryInterface* libHandler, QSharedPointer component, ComponentEditorTreeModel* parent); diff --git a/editors/ComponentEditor/treeStructure/PowerDomainsItem.h b/editors/ComponentEditor/treeStructure/PowerDomainsItem.h index 64a161484..13e396904 100644 --- a/editors/ComponentEditor/treeStructure/PowerDomainsItem.h +++ b/editors/ComponentEditor/treeStructure/PowerDomainsItem.h @@ -30,12 +30,12 @@ class PowerDomainsItem: public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for tracking parameter references. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for tracking parameter references. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent item. */ PowerDomainsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -56,35 +56,35 @@ class PowerDomainsItem: public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Check the validity of this item and sub items. * - * @return True if item is in valid state. + * @return True if item is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/treeStructure/RemapStatesItem.h b/editors/ComponentEditor/treeStructure/RemapStatesItem.h index 58c085d8c..16be2a194 100644 --- a/editors/ComponentEditor/treeStructure/RemapStatesItem.h +++ b/editors/ComponentEditor/treeStructure/RemapStatesItem.h @@ -30,14 +30,14 @@ class RemapStatesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for the references. - * @param [in] parameterFinder Finds the referenced parameters. - * @param [in] expressionFormatter Changes the referenced ids to parameter names. - * @param [in] expressionParser Expression parser for remap states. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for the references. + * @param [in] parameterFinder Finds the referenced parameters. + * @param [in] expressionFormatter Changes the referenced ids to parameter names. + * @param [in] expressionParser Expression parser for remap states. + * @param [in] parent The parent item. */ RemapStatesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -56,35 +56,35 @@ class RemapStatesItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return The font to be used. + * @return The font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip for the item. + * @return The text for the tool tip for the item. */ virtual QString getTooltip() const; /*! * Get the text to be displayed in the tree for this item. * - * @return The text to be displayed. + * @return The text to be displayed. */ virtual QString text() const; /*! * Get the The editor of this item. * - * @return The editor to use with this item. + * @return The editor to use with this item. */ virtual ItemEditor* editor(); /*! * Create a child item. * - * @param [in] index The index of the child item. + * @param [in] index The index of the child item. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/ResetTypesItem.h b/editors/ComponentEditor/treeStructure/ResetTypesItem.h index 16309ae57..0f5915cb2 100644 --- a/editors/ComponentEditor/treeStructure/ResetTypesItem.h +++ b/editors/ComponentEditor/treeStructure/ResetTypesItem.h @@ -28,11 +28,11 @@ class ResetTypesItem: public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] validator Validator for component items. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] validator Validator for component items. + * @param [in] parent The parent item. */ ResetTypesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer validator, ComponentEditorItem* parent); @@ -45,35 +45,35 @@ class ResetTypesItem: public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Check the validity of this item and sub items. * - * @return True if item is in valid state. + * @return True if item is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/treeStructure/SingleComponentInstantiationItem.h b/editors/ComponentEditor/treeStructure/SingleComponentInstantiationItem.h index e0cd1be65..a624b4938 100644 --- a/editors/ComponentEditor/treeStructure/SingleComponentInstantiationItem.h +++ b/editors/ComponentEditor/treeStructure/SingleComponentInstantiationItem.h @@ -35,15 +35,15 @@ class SingleComponentInstantiationItem : public ParameterizableItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] instantiationInterface Interface for accessing component instantiations. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] instantiationInterface Interface for accessing component instantiations. + * @param [in] parent The parent item. */ SingleComponentInstantiationItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -63,14 +63,14 @@ class SingleComponentInstantiationItem : public ParameterizableItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; @@ -80,7 +80,7 @@ class SingleComponentInstantiationItem : public ParameterizableItem /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/SingleCpuItem.h b/editors/ComponentEditor/treeStructure/SingleCpuItem.h index c29acee94..4e747ea97 100644 --- a/editors/ComponentEditor/treeStructure/SingleCpuItem.h +++ b/editors/ComponentEditor/treeStructure/SingleCpuItem.h @@ -33,13 +33,13 @@ class SingleCpuItem: public ComponentEditorItem /*! * The constructor. * - * @param [in] cpu The selected cpu. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] parent The parent item. + * @param [in] cpu The selected cpu. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] parent The parent item. */ SingleCpuItem(QSharedPointer cpu, ComponentEditorTreeModel* model, @@ -64,28 +64,28 @@ class SingleCpuItem: public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! * Get the text to be displayed in the tree for this item. * - * @return The text to display. + * @return The text to display. */ QString text() const final; /*! * Check the validity of this item and sub items. * - * @return True, if the item is in a valid state, false otherwise. + * @return True, if the item is in a valid state, false otherwise. */ bool isValid() const final; /*! * Get the pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ ItemEditor* editor() final; diff --git a/editors/ComponentEditor/treeStructure/SingleDesignConfigurationInstantiationItem.h b/editors/ComponentEditor/treeStructure/SingleDesignConfigurationInstantiationItem.h index 6aacc59f0..f017316a7 100644 --- a/editors/ComponentEditor/treeStructure/SingleDesignConfigurationInstantiationItem.h +++ b/editors/ComponentEditor/treeStructure/SingleDesignConfigurationInstantiationItem.h @@ -34,16 +34,16 @@ class SingleDesignConfigurationInstantiationItem : public ParameterizableItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] instantiation The instantiation of the item. - * @param [in] validator Used to validate the instantiation. - * @param [in] parameterValidator Parameter validator to use. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] instantiation The instantiation of the item. + * @param [in] validator Used to validate the instantiation. + * @param [in] parameterValidator Parameter validator to use. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] parent The parent item. */ SingleDesignConfigurationInstantiationItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, @@ -64,14 +64,14 @@ class SingleDesignConfigurationInstantiationItem : public ParameterizableItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; @@ -81,14 +81,14 @@ class SingleDesignConfigurationInstantiationItem : public ParameterizableItem /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/SingleDesignInstantiationItem.h b/editors/ComponentEditor/treeStructure/SingleDesignInstantiationItem.h index a0a0930df..679de7f43 100644 --- a/editors/ComponentEditor/treeStructure/SingleDesignInstantiationItem.h +++ b/editors/ComponentEditor/treeStructure/SingleDesignInstantiationItem.h @@ -34,14 +34,14 @@ class SingleDesignInstantiationItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] instantiation The instantiation of the item. - * @param [in] validator Handles the validation of the design instantiation. - * @param [in] componentParameterFinder Finder for component parameters. - * @param [in] referenceCounter Handles the usage count of parameters. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] instantiation The instantiation of the item. + * @param [in] validator Handles the validation of the design instantiation. + * @param [in] componentParameterFinder Finder for component parameters. + * @param [in] referenceCounter Handles the usage count of parameters. + * @param [in] parent The parent item. */ SingleDesignInstantiationItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer instantiation, @@ -56,14 +56,14 @@ class SingleDesignInstantiationItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; @@ -73,14 +73,14 @@ class SingleDesignInstantiationItem : public ComponentEditorItem /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/SingleIndirectInterfaceItem.h b/editors/ComponentEditor/treeStructure/SingleIndirectInterfaceItem.h index 1b20bee9f..ab6f1d42e 100644 --- a/editors/ComponentEditor/treeStructure/SingleIndirectInterfaceItem.h +++ b/editors/ComponentEditor/treeStructure/SingleIndirectInterfaceItem.h @@ -33,18 +33,18 @@ class SingleIndirectInterfaceItem : public ParameterizableItem /*! * The constructor. * - * @param [in] busif The bus interface being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] validator The validator for bus interfaces. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this item. - * @param [in] parentWnd The parent window. + * @param [in] busif The bus interface being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] validator The validator for bus interfaces. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this item. + * @param [in] parentWnd The parent window. */ SingleIndirectInterfaceItem(QSharedPointer busif, ComponentEditorTreeModel* model, @@ -64,25 +64,25 @@ class SingleIndirectInterfaceItem : public ParameterizableItem /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/SingleModeItem.h b/editors/ComponentEditor/treeStructure/SingleModeItem.h index 90ed03944..abf59ff95 100644 --- a/editors/ComponentEditor/treeStructure/SingleModeItem.h +++ b/editors/ComponentEditor/treeStructure/SingleModeItem.h @@ -32,14 +32,14 @@ class SingleModeItem: public ComponentEditorItem /*! * The constructor. * - * @param [in] Mode The selected Mode. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] expressions The collection of objects for expression handling. - * @param [in] modeConditionParser The mode condition parser to use. - * @param [in] parent The parent item. + * @param [in] Mode The selected Mode. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] expressions The collection of objects for expression handling. + * @param [in] modeConditionParser The mode condition parser to use. + * @param [in] parent The parent item. */ SingleModeItem(QSharedPointer mode, ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, @@ -61,28 +61,28 @@ class SingleModeItem: public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! * Get the text to be displayed in the tree for this item. * - * @return The text to display. + * @return The text to display. */ QString text() const final; /*! * Check the validity of this item and sub items. * - * @return True, if the item is in a valid state, false otherwise. + * @return True, if the item is in a valid state, false otherwise. */ bool isValid() const final; /*! * Get the pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ ItemEditor* editor() final; diff --git a/editors/ComponentEditor/treeStructure/SingleRemapStateItem.h b/editors/ComponentEditor/treeStructure/SingleRemapStateItem.h index 89273adb8..2a3b79140 100644 --- a/editors/ComponentEditor/treeStructure/SingleRemapStateItem.h +++ b/editors/ComponentEditor/treeStructure/SingleRemapStateItem.h @@ -29,14 +29,14 @@ class SingleRemapStateItem: public ComponentEditorItem /*! * The constructor. * - * @param [in] remapState Pointer to the selected remap state. - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] parameterFinder Finds the referenced parameter ids. - * @param [in] expressionFormatter Changes the referenced ids to parameter names. - * @param [in] parent Pointer to the parent item. + * @param [in] remapState Pointer to the selected remap state. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] parameterFinder Finds the referenced parameter ids. + * @param [in] expressionFormatter Changes the referenced ids to parameter names. + * @param [in] parent Pointer to the parent item. */ SingleRemapStateItem(QSharedPointer remapState, ComponentEditorTreeModel* model, @@ -56,28 +56,28 @@ class SingleRemapStateItem: public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return True, if the item is in a valid state, false otherwise. + * @return True, if the item is in a valid state, false otherwise. */ virtual bool isValid() const; /*! * Get the pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/SubspaceMapItem.h b/editors/ComponentEditor/treeStructure/SubspaceMapItem.h index 53385f6ad..b70427deb 100644 --- a/editors/ComponentEditor/treeStructure/SubspaceMapItem.h +++ b/editors/ComponentEditor/treeStructure/SubspaceMapItem.h @@ -38,18 +38,18 @@ class SubspaceMapItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] containingMap Memory map containing the address block. - * @param [in] subspace The subspace map being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression formatter. - * @param [in] addressBlockValidator Validator used for address blocks. - * @param [in] subspaceInterface Interface for accessing subspace maps. - * @param [in] parent The parent item. + * @param [in] containingMap Memory map containing the address block. + * @param [in] subspace The subspace map being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression formatter. + * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] subspaceInterface Interface for accessing subspace maps. + * @param [in] parent The parent item. */ SubspaceMapItem(QSharedPointer containingMap, QSharedPointer subspace, @@ -76,49 +76,49 @@ class SubspaceMapItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const override final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const override final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const override final; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor() override final; /*! * Get pointer to the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer() override final; /*! * Set the visualizer for this item. * - * @param [in] visualizer The visualizer. + * @param [in] visualizer The visualizer. */ void setVisualizer(MemoryMapsVisualizer* visualizer); /*! * Get the visualizer graphics item for the address block. * - * @return QGraphicsItem* The graphics item. + * @return QGraphicsItem* The graphics item. */ virtual QGraphicsItem* getGraphicsItem() override final; @@ -135,7 +135,7 @@ class SubspaceMapItem : public ComponentEditorItem /*! * Change the address unit bits in component editor. * - * @param [in] newAddressUnitBits The new value for address unit bits. + * @param [in] newAddressUnitBits The new value for address unit bits. */ void addressUnitBitsChanged(int newAddressUnitBits); @@ -163,8 +163,8 @@ protected slots: /* * Informs of subspace map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void subspaceNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/TransactionalPortsItem.h b/editors/ComponentEditor/treeStructure/TransactionalPortsItem.h index 2711217f0..9242f44e4 100644 --- a/editors/ComponentEditor/treeStructure/TransactionalPortsItem.h +++ b/editors/ComponentEditor/treeStructure/TransactionalPortsItem.h @@ -35,15 +35,15 @@ class TransactionalPortsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] refCounter The instance for counting references. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] refCounter The instance for counting references. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent item. */ TransactionalPortsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -60,28 +60,28 @@ class TransactionalPortsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ QString text() const final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const final; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ ItemEditor* editor() final; @@ -89,7 +89,7 @@ class TransactionalPortsItem : public ComponentEditorItem * Get the font to be used for text of this item. * The font is bold, if transactional ports exist, otherwise regular. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ QFont getFont() const final; diff --git a/editors/ComponentEditor/treeStructure/TypeDefinitionsItem.h b/editors/ComponentEditor/treeStructure/TypeDefinitionsItem.h index 9e40862d7..592ffbc1d 100644 --- a/editors/ComponentEditor/treeStructure/TypeDefinitionsItem.h +++ b/editors/ComponentEditor/treeStructure/TypeDefinitionsItem.h @@ -29,10 +29,10 @@ class TypeDefinitionsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ TypeDefinitionsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, ComponentEditorItem* parent); @@ -47,35 +47,35 @@ class TypeDefinitionsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/WirePortsItem.h b/editors/ComponentEditor/treeStructure/WirePortsItem.h index da2e5987d..fb0128d70 100644 --- a/editors/ComponentEditor/treeStructure/WirePortsItem.h +++ b/editors/ComponentEditor/treeStructure/WirePortsItem.h @@ -36,15 +36,15 @@ class WirePortsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] refCounter The instance for counting references. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] refCounter The instance for counting references. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent item. */ WirePortsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -61,28 +61,28 @@ class WirePortsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ QString text() const final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const final; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ ItemEditor* editor() final; @@ -90,7 +90,7 @@ class WirePortsItem : public ComponentEditorItem * Get the font to be used for text of this item. * The font is bold, if wire ports exist, otherwise regular. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ QFont getFont() const final; diff --git a/editors/ComponentEditor/treeStructure/componenteditoraddrblockitem.h b/editors/ComponentEditor/treeStructure/componenteditoraddrblockitem.h index c964fadcb..701a268ae 100644 --- a/editors/ComponentEditor/treeStructure/componenteditoraddrblockitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditoraddrblockitem.h @@ -39,18 +39,18 @@ class ComponentEditorAddrBlockItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] containingMap Memory map containing the address block. - * @param [in] addrBlock The address block being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression formatter. - * @param [in] addressBlockValidator Validator used for address blocks. - * @param [in] blockInterface Interface for accessing address blocks. - * @param [in] parent The parent item. + * @param [in] containingMap Memory map containing the address block. + * @param [in] addrBlock The address block being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression formatter. + * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] blockInterface Interface for accessing address blocks. + * @param [in] parent The parent item. */ ComponentEditorAddrBlockItem(QSharedPointer containingMap, QSharedPointer addrBlock, @@ -76,35 +76,35 @@ class ComponentEditorAddrBlockItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const override final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const override final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const override final; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor() override final; /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index) override final; @@ -113,21 +113,21 @@ class ComponentEditorAddrBlockItem : public ComponentEditorItem /*! * Get pointer to the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer() override final; /*! * Set the visualizer for this item. * - * @param [in] visualizer The visualizer. + * @param [in] visualizer The visualizer. */ void setVisualizer(MemoryMapsVisualizer* visualizer); /*! * Get the visualizer graphics item for the address block. * - * @return QGraphicsItem* The graphics item. + * @return QGraphicsItem* The graphics item. */ virtual QGraphicsItem* getGraphicsItem() override final; @@ -144,7 +144,7 @@ class ComponentEditorAddrBlockItem : public ComponentEditorItem /*! * Change the address unit bits in component editor. * - * @param [in] newAddressUnitBits The new value for address unit bits. + * @param [in] newAddressUnitBits The new value for address unit bits. */ void addressUnitBitsChanged(int newAddressUnitBits); @@ -170,7 +170,7 @@ protected slots: /*! * Signals a change in the address unit bits. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void changeInAddressUnitBits(int newAddressUnitBits); @@ -181,16 +181,16 @@ protected slots: /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); /* * Informs of address block name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void addressBlockNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditoraddrspaceitem.h b/editors/ComponentEditor/treeStructure/componenteditoraddrspaceitem.h index 5eba41574..e665e7464 100644 --- a/editors/ComponentEditor/treeStructure/componenteditoraddrspaceitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditoraddrspaceitem.h @@ -39,17 +39,17 @@ class ComponentEditorAddrSpaceItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] addrSpace The address space being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser to use. - * @param [in] addressSpaceValidator Validator for address spaces. - * @param [in] blockInterface Interface for accessing address blocks. - * @param [in] parent The parent item. + * @param [in] addrSpace The address space being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser to use. + * @param [in] addressSpaceValidator Validator for address spaces. + * @param [in] blockInterface Interface for accessing address blocks. + * @param [in] parent The parent item. */ ComponentEditorAddrSpaceItem(QSharedPointer addrSpace, ComponentEditorTreeModel* model, @@ -75,49 +75,49 @@ class ComponentEditorAddrSpaceItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Remove the child from the given index. * - * @param [in] index Identifies the child to remove. + * @param [in] index Identifies the child to remove. */ void removeChild(int index) final; /*! * Get the visualizer graphics item for the memory map. * - * @return QGraphicsItem* The graphics item. + * @return QGraphicsItem* The graphics item. */ virtual QGraphicsItem* getGraphicsItem(); @@ -134,7 +134,7 @@ class ComponentEditorAddrSpaceItem : public ComponentEditorItem /*! * Get pointer to the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer(); @@ -163,7 +163,7 @@ protected slots: /*! * Assign new address unit bits to editor. * - * @param [in] newAddressUnitBits The new address unit bits. + * @param [in] newAddressUnitBits The new address unit bits. */ void assignNewAddressUnitBits(QString const& newAddressUnitBits); diff --git a/editors/ComponentEditor/treeStructure/componenteditoraddrspacesitem.h b/editors/ComponentEditor/treeStructure/componenteditoraddrspacesitem.h index d528526a8..1715a6ebe 100644 --- a/editors/ComponentEditor/treeStructure/componenteditoraddrspacesitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditoraddrspacesitem.h @@ -37,14 +37,14 @@ class ComponentEditorAddrSpacesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser to use. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser to use. + * @param [in] parent The parent item. */ ComponentEditorAddrSpacesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -61,42 +61,42 @@ class ComponentEditorAddrSpacesItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; @@ -105,7 +105,7 @@ private slots: /*! * Emitted when address unit bits change on an address space. * - * @param [in] spaceIndex Index of the address space being changed. + * @param [in] spaceIndex Index of the address space being changed. */ void addressUnitBitsChangedInRow(int spaceIndex); @@ -128,9 +128,9 @@ private slots: /*! * Create interface for accessing bus interfaces. * - * @param [in] parameterValidator Validator for parameters. + * @param [in] parameterValidator Validator for parameters. * - * @return Interface for accessing bus interfaces. + * @return Interface for accessing bus interfaces. */ BusInterfaceInterface* createInterfaceForBus(QSharedPointer parameterValidator); diff --git a/editors/ComponentEditor/treeStructure/componenteditorapiinterfaceitem.h b/editors/ComponentEditor/treeStructure/componenteditorapiinterfaceitem.h index 85be8f1c1..adbbb911a 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorapiinterfaceitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorapiinterfaceitem.h @@ -27,11 +27,11 @@ class ComponentEditorAPIInterfaceItem : public ComponentEditorItem /*! The constructor * - * @param [in] APIInterface Pointer to the API interface to edit. - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] APIInterface Pointer to the API interface to edit. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ ComponentEditorAPIInterfaceItem(QSharedPointer APIInterface, ComponentEditorTreeModel* model, @@ -44,25 +44,25 @@ class ComponentEditorAPIInterfaceItem : public ComponentEditorItem /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorapiinterfacesitem.h b/editors/ComponentEditor/treeStructure/componenteditorapiinterfacesitem.h index a64d52da7..335a52c8f 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorapiinterfacesitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorapiinterfacesitem.h @@ -26,10 +26,10 @@ class ComponentEditorAPIInterfacesItem : public ComponentEditorItem /*! The constructor * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ ComponentEditorAPIInterfacesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -43,31 +43,31 @@ class ComponentEditorAPIInterfacesItem : public ComponentEditorItem * * The font is bold, if API interfaces exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. * */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/componenteditorbusinterfaceitem.h b/editors/ComponentEditor/treeStructure/componenteditorbusinterfaceitem.h index 4b195681d..b1a4562d3 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorbusinterfaceitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorbusinterfaceitem.h @@ -41,19 +41,19 @@ class ComponentEditorBusInterfaceItem : public ParameterizableItem /*! * The constructor. * - * @param [in] busif The bus interface being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] validator The validator for bus interfaces. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The owner of this item. - * @param [in] parentWnd The parent window. + * @param [in] busif The bus interface being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] validator The validator for bus interfaces. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The owner of this item. + * @param [in] parentWnd The parent window. */ ComponentEditorBusInterfaceItem(QSharedPointer busif, ComponentEditorTreeModel* model, @@ -72,32 +72,32 @@ class ComponentEditorBusInterfaceItem : public ParameterizableItem /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorbusinterfacesitem.h b/editors/ComponentEditor/treeStructure/componenteditorbusinterfacesitem.h index 4de85d88a..cf3645cf0 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorbusinterfacesitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorbusinterfacesitem.h @@ -36,17 +36,17 @@ class ComponentEditorBusInterfacesItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] parent The owner of this item. - * @param [in] parentWnd The parent window. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] parent The owner of this item. + * @param [in] parentWnd The parent window. */ ComponentEditorBusInterfacesItem( BusInterfaceInterface* busInterface, @@ -68,46 +68,46 @@ class ComponentEditorBusInterfacesItem : public ComponentEditorItem * * The font is bold, if bus interfaces exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! Get the tree item that holds the editor for given bus interface. * - * @param [in] interfaceName The name of the bus interface to get the item for. + * @param [in] interfaceName The name of the bus interface to get the item for. * - * @return The tree item. + * @return The tree item. */ QSharedPointer getBusInterfaceItem(const QString& interfaceName) const; /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; diff --git a/editors/ComponentEditor/treeStructure/componenteditorchannelsitem.h b/editors/ComponentEditor/treeStructure/componenteditorchannelsitem.h index 3f70dd4b9..975a21fd0 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorchannelsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorchannelsitem.h @@ -28,11 +28,11 @@ class ComponentEditorChannelsItem : public ComponentEditorItem /*! The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] expressionParser The expression parser to use. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] expressionParser The expression parser to use. + * @param [in] parent The parent item. */ ComponentEditorChannelsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -47,31 +47,31 @@ class ComponentEditorChannelsItem : public ComponentEditorItem * * The font is bold, if channels exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorcominterfaceitem.h b/editors/ComponentEditor/treeStructure/componenteditorcominterfaceitem.h index 847232f53..44fa47b7e 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorcominterfaceitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorcominterfaceitem.h @@ -26,11 +26,11 @@ class ComponentEditorComInterfaceItem : public ComponentEditorItem /*! The constructor * - * @param [in] comInterface The COM interface being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent item. + * @param [in] comInterface The COM interface being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent item. * */ ComponentEditorComInterfaceItem(QSharedPointer comInterface, @@ -42,25 +42,25 @@ class ComponentEditorComInterfaceItem : public ComponentEditorItem /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); @@ -73,7 +73,7 @@ class ComponentEditorComInterfaceItem : public ComponentEditorItem /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions() const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorcominterfacesitem.h b/editors/ComponentEditor/treeStructure/componenteditorcominterfacesitem.h index d6776ad65..cf74bba85 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorcominterfacesitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorcominterfacesitem.h @@ -27,10 +27,10 @@ class ComponentEditorComInterfacesItem : public ComponentEditorItem /*! The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent item. * */ ComponentEditorComInterfacesItem(ComponentEditorTreeModel* model, @@ -45,31 +45,31 @@ class ComponentEditorComInterfacesItem : public ComponentEditorItem * * The font is bold, if COM interfaces exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. * */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/componenteditorcpusitem.h b/editors/ComponentEditor/treeStructure/componenteditorcpusitem.h index a4f839aa0..e54d151b4 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorcpusitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorcpusitem.h @@ -34,11 +34,11 @@ class ComponentEditorCpusItem : public ComponentEditorItem /*! The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] expressions Parser for expressions in cpus. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] expressions Parser for expressions in cpus. + * @param [in] parent The parent item. */ ComponentEditorCpusItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer referenceCounter, @@ -56,38 +56,38 @@ class ComponentEditorCpusItem : public ComponentEditorItem * * The font is bold, if cpus exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ QFont getFont() const final; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ QString text() const final; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ ItemEditor* editor() final; /*! Check the validity of this item and sub items. * - * @return True if item is in valid state. + * @return True if item is in valid state. */ bool isValid() const final; /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ void createChild(int index) final; diff --git a/editors/ComponentEditor/treeStructure/componenteditorfielditem.h b/editors/ComponentEditor/treeStructure/componenteditorfielditem.h index dda6e61b5..cf0dc58bd 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorfielditem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorfielditem.h @@ -39,18 +39,18 @@ class ComponentEditorFieldItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] reg The register which contains this field. - * @param [in] field The field being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] referenceCounter The instance for counting references made to the parameters. - * @param [in] expressionParser Expression parser to use. - * @param [in] formatter The expression formatter. - * @param [in] fieldValidator Validator used for fields. - * @param [in] fieldInterface Interface for accessing fields. - * @param [in] parent The parent item. + * @param [in] reg The register which contains this field. + * @param [in] field The field being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] referenceCounter The instance for counting references made to the parameters. + * @param [in] expressionParser Expression parser to use. + * @param [in] formatter The expression formatter. + * @param [in] fieldValidator Validator used for fields. + * @param [in] fieldInterface Interface for accessing fields. + * @param [in] parent The parent item. */ ComponentEditorFieldItem(QSharedPointer reg, QSharedPointer field, @@ -80,49 +80,49 @@ class ComponentEditorFieldItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Get the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer(); /*! * Set the visualizer for this item. * - * @param [in] visualizer The visualizer to set. + * @param [in] visualizer The visualizer to set. */ virtual void setVisualizer(MemoryMapsVisualizer* visualizer); /*! * Get the visualizer graphics item for the field. * - * @return The graphics item. + * @return The graphics item. */ virtual QGraphicsItem* getGraphicsItem(); @@ -151,8 +151,8 @@ class ComponentEditorFieldItem : public ComponentEditorItem /* * Informs of field name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void fieldNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditorfileitem.h b/editors/ComponentEditor/treeStructure/componenteditorfileitem.h index 474b3bfd0..e226678af 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorfileitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorfileitem.h @@ -36,17 +36,17 @@ class ComponentEditorFileItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] file The file being edited. - * @param [in] availableFiles The list of available files. - * @param [in] fileInterface Interface for accessing files. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] validator The validator for checking file validity. - * @param [in] parameterFinder The used parameter finder. - * @param [in] expressionParser Parser for calculating expressions. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] parent The parent item. + * @param [in] file The file being edited. + * @param [in] availableFiles The list of available files. + * @param [in] fileInterface Interface for accessing files. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] validator The validator for checking file validity. + * @param [in] parameterFinder The used parameter finder. + * @param [in] expressionParser Parser for calculating expressions. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] parent The parent item. */ ComponentEditorFileItem(QSharedPointer file, QSharedPointer > > availableFiles, @@ -68,42 +68,42 @@ class ComponentEditorFileItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Tells if the item can be opened or not. * - * @return Files can always be opened and this function returns true. + * @return Files can always be opened and this function returns true. */ virtual bool canBeOpened() const; /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions() const; @@ -112,8 +112,8 @@ class ComponentEditorFileItem : public ComponentEditorItem /*! * Handle the name change of a file. * - * @param [in] oldName Old name of the selected file. - * @param [in] newName The new name for the selected file. + * @param [in] oldName Old name of the selected file. + * @param [in] newName The new name for the selected file. */ void fileRenamed(std::string const& oldName, std::string const& newName); @@ -150,37 +150,37 @@ protected slots: /*! * Starts the selected application and runs the file with it. * - * @param [in] applicationPath Absolute path to the application executable. + * @param [in] applicationPath Absolute path to the application executable. */ void runInApplication(QString const& applicationPath); /*! * Checks if the item should be opened in Katus2 CSource editor. * - * @return True if the item should be opened, false otherwise. + * @return True if the item should be opened, false otherwise. */ virtual bool useKactusCSourceEditor() const; /*! * Checks if an executable has been set for the file type. * - * @return True, if valid executable has been set, otherwise false. + * @return True, if valid executable has been set, otherwise false. */ bool runExecutableSet() const; /*! * Gets the absolute path to the executable set for the file type. * - * @return The path to executable. + * @return The path to executable. */ QString executablePath() const; /*! * Finds all the environmental variables in a text and replaces them with the variable value. * - * @param [in] text The text to search through. + * @param [in] text The text to search through. * - * @return A text where variables have been replaced with their values. + * @return A text where variables have been replaced with their values. */ QString resolveEnvironmentVariables(QString const& text) const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorfilesetitem.h b/editors/ComponentEditor/treeStructure/componenteditorfilesetitem.h index 4779329bf..1726742b1 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorfilesetitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorfilesetitem.h @@ -39,18 +39,18 @@ class ComponentEditorFileSetItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] fileSet The file set being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] expressionFormatter Formatter used to format expressions. - * @param [in] validator The validator for checking file set validity. - * @param [in] fileValidator The validator for checking child item (file) validity. - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] parent The parent item. + * @param [in] fileSet The file set being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] expressionFormatter Formatter used to format expressions. + * @param [in] validator The validator for checking file set validity. + * @param [in] fileValidator The validator for checking child item (file) validity. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parent The parent item. */ ComponentEditorFileSetItem(QSharedPointer fileSet, ComponentEditorTreeModel* model, @@ -75,35 +75,35 @@ class ComponentEditorFileSetItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ QString getTooltip() const final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ QString text() const final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const final; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ ItemEditor* editor() final; /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ void createChild(int index) final; @@ -122,15 +122,15 @@ class ComponentEditorFileSetItem : public ComponentEditorItem /*! * Indicates the removal of an item. * - * @param [in] index The index of the removed item. + * @param [in] index The index of the removed item. */ void childRemoved(int index); /*! * Handle the name change of a file. * - * @param [in] oldName Old name of the selected file. - * @param [in] newName The new name for the selected file. + * @param [in] oldName Old name of the selected file. + * @param [in] newName The new name for the selected file. */ void fileRenamed(std::string const& oldName, std::string const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditorfilesetsitem.h b/editors/ComponentEditor/treeStructure/componenteditorfilesetsitem.h index e374cc540..5eb446cd5 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorfilesetsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorfilesetsitem.h @@ -42,15 +42,15 @@ class ComponentEditorFileSetsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The counter for parameter references. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] expressionParser Parser used to calculate expressions. - * @param [in] expressionFormatter Formatter used to format expressions. - * @param [in] parameterFinder The finder for component parameters. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The counter for parameter references. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] expressionParser Parser used to calculate expressions. + * @param [in] expressionFormatter Formatter used to format expressions. + * @param [in] parameterFinder The finder for component parameters. + * @param [in] parent The parent item. */ ComponentEditorFileSetsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, @@ -64,42 +64,42 @@ class ComponentEditorFileSetsItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; @@ -123,10 +123,10 @@ private slots: /*! * Check if the selected file set contains the selected file. * - * @param [in] file The selected file. - * @param [in] fileset The selected file set. + * @param [in] file The selected file. + * @param [in] fileset The selected file set. * - * @return True, if the file set contains the file, false otherwise. + * @return True, if the file set contains the file, false otherwise. */ bool isParentFileSet(File* file, const FileSet* fileset) const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorgeneralitem.h b/editors/ComponentEditor/treeStructure/componenteditorgeneralitem.h index 003a2ed6f..b0e03326b 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorgeneralitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorgeneralitem.h @@ -34,10 +34,10 @@ class ComponentEditorGeneralItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ ComponentEditorGeneralItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, ComponentEditorItem* parent); @@ -52,42 +52,42 @@ class ComponentEditorGeneralItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); /*! * Get pointer to the visualizer of this item. * - * @return Pointer to the visualizer to use for this item. + * @return Pointer to the visualizer to use for this item. */ ItemVisualizer* visualizer() override; diff --git a/editors/ComponentEditor/treeStructure/componenteditoritem.h b/editors/ComponentEditor/treeStructure/componenteditoritem.h index 0cd1724ac..e4f7959a3 100644 --- a/editors/ComponentEditor/treeStructure/componenteditoritem.h +++ b/editors/ComponentEditor/treeStructure/componenteditoritem.h @@ -43,10 +43,10 @@ class ComponentEditorItem : public QObject /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent item. */ ComponentEditorItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -56,9 +56,9 @@ class ComponentEditorItem : public QObject /*! * The constructor for root item. * - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] parent Pointer to the parent object. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] parent Pointer to the parent object. */ ComponentEditorItem(LibraryInterface* libHandler, QSharedPointer component, @@ -76,47 +76,47 @@ class ComponentEditorItem : public QObject /*! * Get the index of the child item under the parent. * - * @param [in] child Pointer to the child that's row is wanted. + * @param [in] child Pointer to the child that's row is wanted. * - * @return The index of the child item. Returns -1 if child is not found. + * @return The index of the child item. Returns -1 if child is not found. */ int getIndexOf(const ComponentEditorItem* child) const; /*! * Get number of children the item contains. * - * @return The number of child items this item contains. + * @return The number of child items this item contains. */ virtual int rowCount() const; /*! * Returns true if item contains child items. * - * @return True if child items exist. + * @return True if child items exist. */ bool hasChildren() const; /*! * Get pointer to the child in given index. * - * @param [in] index The index identifying the child. + * @param [in] index The index identifying the child. * - * @return Pointer to the indexed child. Null pointer is returned if index is invalid. + * @return Pointer to the indexed child. Null pointer is returned if index is invalid. */ QSharedPointer child(const int index); /*! * Get pointer to the parent of this item. * - * @return Pointer to the parent item. + * @return Pointer to the parent item. */ ComponentEditorItem* parent(); /*! * Move child from source index to target index under the same parent. * - * @param [in] sourceIndex The index identifying which item to move. - * @param [in] targetIndex The index identifying the target to move to. If under 0 then item is + * @param [in] sourceIndex The index identifying which item to move. + * @param [in] targetIndex The index identifying the target to move to. If under 0 then item is * prepended to the list. If greater than number of children then item is * appended to the list. */ @@ -125,49 +125,49 @@ class ComponentEditorItem : public QObject /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Set the locked state of the editor and possible visualizer. * - * @param [in] locked True to set the editor and visualizer in read only mode. + * @param [in] locked True to set the editor and visualizer in read only mode. */ virtual void setLocked(bool locked); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Remove the child from the given index. * - * @param [in] index Identifies the child to remove. + * @param [in] index Identifies the child to remove. */ virtual void removeChild(int index); /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const = 0; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const = 0; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; @@ -179,14 +179,14 @@ class ComponentEditorItem : public QObject /*! * Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor() = 0; /*! * Get pointer to the visualizer of this item. * - * @return Pointer to the visualizer to use for this item. + * @return Pointer to the visualizer to use for this item. */ virtual ItemVisualizer* visualizer(); @@ -208,7 +208,7 @@ class ComponentEditorItem : public QObject /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions(); @@ -218,7 +218,7 @@ class ComponentEditorItem : public QObject * The default implementation returns a null pointer, reimplement this for * elements that contain a visualization element. * - * @return QGraphicsItem* Pointer to the graphics item. + * @return QGraphicsItem* Pointer to the graphics item. */ virtual QGraphicsItem* getGraphicsItem(); @@ -241,7 +241,7 @@ class ComponentEditorItem : public QObject /*! * Tells if the item has a decoration icon or not. * - * @return True if the item has an icon, otherwise false (default). + * @return True if the item has an icon, otherwise false (default). */ virtual bool hasIcon() const; @@ -253,21 +253,21 @@ class ComponentEditorItem : public QObject /*! * Set the reference counter for this item. * - * @param [in] newReferenceCounter The counter for references. + * @param [in] newReferenceCounter The counter for references. */ void setReferenceCounter(QSharedPointer newReferenceCounter); /*! * Set the parameter finder for this item. * - * @param [in] parameterFinder The parameter finder. + * @param [in] parameterFinder The parameter finder. */ void setParameterFinder(QSharedPointer parameterFinder); /*! * Set the expression formatter. * - * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionFormatter The expression formatter. */ void setExpressionFormatter(QSharedPointer expressionFormatter); @@ -300,33 +300,33 @@ public slots: /*! * Emitted when a child should be added to this item. * - * @param [in] item Pointer to this item. - * @param [in] childIndex The index the child should be added to. + * @param [in] item Pointer to this item. + * @param [in] childIndex The index the child should be added to. */ void createChild(ComponentEditorItem* item, int childIndex); /*! * Emitted when a child should be removed from the item. * - * @param [in] item Pointer to this item. - * @param [in] childIndex The index of the child that should be removed. + * @param [in] item Pointer to this item. + * @param [in] childIndex The index of the child that should be removed. */ void removeChild(ComponentEditorItem* item, int childIndex); /*! * Emitted when a child should be moved from one place to another. * - * @param [in] item Pointer to this item. - * @param [in] sourceIndex The index of the child item to move. - * @param [in] targetIndex The index to move the child into. + * @param [in] item Pointer to this item. + * @param [in] sourceIndex The index of the child item to move. + * @param [in] targetIndex The index to move the child into. */ void moveChild(ComponentEditorItem* item, int sourceIndex, int targetIndex); /*! * Opens the specific C source file of the given component. * - * @param [in] filename The name of the file to open. - * @param [in] component The component containing the file. + * @param [in] filename The name of the file to open. + * @param [in] component The component containing the file. */ void openCSource(QString const& filename, QSharedPointer component); @@ -351,23 +351,23 @@ public slots: /*! * Emitted when a tree item should be selected in component editor. * - * @param [in] item Pointer to the item to select. + * @param [in] item Pointer to the item to select. */ void selectItem(ComponentEditorItem* item); /*! * Open the reference tree of the selected parameter. * - * @param [in] id The ID of the parameter. - * @param [in] parameterName Name of the selected parameter. + * @param [in] id The ID of the parameter. + * @param [in] parameterName Name of the selected parameter. */ void openReferenceTree(QString const& id, QString const& parameterName) const; /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] containingID ID for the vendor extensions editor. - * @param [in] extensionItem The item containing the selected vendor extensions. + * @param [in] containingID ID for the vendor extensions editor. + * @param [in] extensionItem The item containing the selected vendor extensions. */ void changeVendorExtensions(QString const& containingID, QSharedPointer extensionItem); @@ -431,22 +431,22 @@ protected slots: /*! * Handler for ItemEditor's childAdded(int) signal. * - * @param [in] index The index to add the child to. + * @param [in] index The index to add the child to. */ virtual void onAddChild(int index); /*! * Handler for ItemEditor's childRemoved(int) signal. * - * @param [in] index The index of the child to remove. + * @param [in] index The index of the child to remove. */ virtual void onRemoveChild(int index); /*! * Handler for ItemEditor's childMoved(int, int) signal. * - * @param [in] source The index of the child to move. - * @param [in] target The position to move the child into. + * @param [in] source The index of the child to move. + * @param [in] target The position to move the child into. */ virtual void onMoveChild(int source, int target); diff --git a/editors/ComponentEditor/treeStructure/componenteditormemmapitem.h b/editors/ComponentEditor/treeStructure/componenteditormemmapitem.h index dc65a94af..e33c5a876 100644 --- a/editors/ComponentEditor/treeStructure/componenteditormemmapitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditormemmapitem.h @@ -37,17 +37,17 @@ class ComponentEditorMemMapItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] memoryMap The memory map being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser to use. - * @param [in] memoryMapValidator Validator used for memory maps. - * @param [in] mapInterface Interface for accessing memory maps. - * @param [in] parent The parent item. + * @param [in] memoryMap The memory map being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser to use. + * @param [in] memoryMapValidator Validator used for memory maps. + * @param [in] mapInterface Interface for accessing memory maps. + * @param [in] parent The parent item. */ ComponentEditorMemMapItem(QSharedPointer memoryMap, ComponentEditorTreeModel* model, @@ -71,56 +71,56 @@ class ComponentEditorMemMapItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Get pointer to the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer(); /*! * Set the visualizer for this item. * - * @param [in] visualizer The visualizer. + * @param [in] visualizer The visualizer. */ virtual void setVisualizer(MemoryMapsVisualizer* visualizer); /*! * Get the visualizer graphics item for the memory map. * - * @return QGraphicsItem* The graphics item. + * @return QGraphicsItem* The graphics item. */ virtual QGraphicsItem* getGraphicsItem(); @@ -144,16 +144,16 @@ public slots: /*! * Add a memory remap item to the tree. * - * @param [in] memoryRemapIndex The index of the new memory remap item. - * @param [in] mapName Name of the parent of the new memory remap item. + * @param [in] memoryRemapIndex The index of the new memory remap item. + * @param [in] mapName Name of the parent of the new memory remap item. */ void onMemoryRemapAdded(int memoryRemapIndex, QString const& mapName); /*! * Remove a memory remap item from the tree. * - * @param [in] memoryRemapIndex The index of the removed memory remap item. - * @param [in] mapName Name of the parent of the removed memory remap item. + * @param [in] memoryRemapIndex The index of the removed memory remap item. + * @param [in] mapName Name of the parent of the removed memory remap item. */ void onMemoryRemapRemoved(int memoryRemapIndex, QString const& mapName); @@ -162,16 +162,16 @@ public slots: /* * Informs of memory map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory remap name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditormemmapsitem.h b/editors/ComponentEditor/treeStructure/componenteditormemmapsitem.h index 2ec7d1abd..b0c224bec 100644 --- a/editors/ComponentEditor/treeStructure/componenteditormemmapsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditormemmapsitem.h @@ -38,14 +38,14 @@ class ComponentEditorMemMapsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression formatter. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression formatter. + * @param [in] parent The parent item. */ ComponentEditorMemMapsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -62,42 +62,42 @@ class ComponentEditorMemMapsItem : public ComponentEditorItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Get The visualizer of memory maps. * - * @return The visualizer to use for memory maps. + * @return The visualizer to use for memory maps. */ virtual ItemVisualizer* visualizer(); @@ -106,7 +106,7 @@ public slots: /*! * Give the selected memory map order to pass its address unit bits forward. * - * @param [in] memoryMapIndex The index of the selected memory map. + * @param [in] memoryMapIndex The index of the selected memory map. */ void addressUnitBitsChangedOnMemoryMap(int memoryMapIndex); @@ -115,32 +115,32 @@ public slots: /*! * Informs that a new memory remap item should be added. * - * @param [in] memoryRemapIndex The index of the new memory remap item. - * @param [in] parentMemoryMapName Name of the parent memory map of the new memory remap. + * @param [in] memoryRemapIndex The index of the new memory remap item. + * @param [in] parentMemoryMapName Name of the parent memory map of the new memory remap. */ void memoryRemapAdded(int memoryRemapIndex, QString const& parentMemoryMapName); /*! * Informs that a memory remap item should be removed. * - * @param [in] memoryRemapIndex The index of the removed memory remap item. - * @param [in] parentMemoryMapName Name of the parent memory map of the removed memory remap. + * @param [in] memoryRemapIndex The index of the removed memory remap item. + * @param [in] parentMemoryMapName Name of the parent memory map of the removed memory remap. */ void memoryRemapRemoved(int memoryRemapIndex, QString const& parentMemoryMapName); /* * Informs of memory map name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryMapNameChanged(QString const& oldName, QString const& newName); /* * Informs of memory remap name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void memoryRemapNameChanged(QString const& parentName, QString const& oldName, QString const& newName); @@ -154,7 +154,7 @@ public slots: /*! * Check the validity of this item. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const override; @@ -171,9 +171,9 @@ public slots: /*! * Create the interface for accessing bus interfaces. * - * @param [in] parameterValidator Validator for parameters. + * @param [in] parameterValidator Validator for parameters. * - * @return The interface for accessing bus interfaces. + * @return The interface for accessing bus interfaces. */ BusInterfaceInterface* createInterfaceForBus(QSharedPointer parameterValidator); diff --git a/editors/ComponentEditor/treeStructure/componenteditormodelparamsitem.h b/editors/ComponentEditor/treeStructure/componenteditormodelparamsitem.h index 6b72f9927..ecb28ec83 100644 --- a/editors/ComponentEditor/treeStructure/componenteditormodelparamsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditormodelparamsitem.h @@ -27,13 +27,13 @@ class ComponentEditorModelParamsItem : public ComponentEditorItem { /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] refCounter Pointer to the reference counter. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] refCounter Pointer to the reference counter. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] parent Pointer to the parent item. */ ComponentEditorModelParamsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, diff --git a/editors/ComponentEditor/treeStructure/componenteditorotherclocksitem.h b/editors/ComponentEditor/treeStructure/componenteditorotherclocksitem.h index 1700e548e..5384e8032 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorotherclocksitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorotherclocksitem.h @@ -31,11 +31,11 @@ class ComponentEditorOtherClocksItem : public ComponentEditorItem /*! * The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] expressionParser The used expression parser. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The parent item. */ ComponentEditorOtherClocksItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, QSharedPointer expressionParser, @@ -49,35 +49,35 @@ class ComponentEditorOtherClocksItem : public ComponentEditorItem * * The font is bold, if other clock drivers exist, otherwise not bold. * - * @return The instance that defines the font to be used. + * @return The instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return The text to display. + * @return The text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return True if item is in valid state. + * @return True if item is in valid state. */ virtual bool isValid() const; /*! *Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorparametersitem.h b/editors/ComponentEditor/treeStructure/componenteditorparametersitem.h index df5185bda..5778d3237 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorparametersitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorparametersitem.h @@ -34,14 +34,14 @@ class ComponentEditorParametersItem : public ParameterizableItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] refCounter The reference counter. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionParser The expression parser. - * @param [in] expressionFormatter The expression formatter. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] refCounter The reference counter. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionParser The expression parser. + * @param [in] expressionFormatter The expression formatter. + * @param [in] parent The parent item. */ ComponentEditorParametersItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -58,35 +58,35 @@ class ComponentEditorParametersItem : public ParameterizableItem /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * @Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return True if item is in valid state. + * @return True if item is in valid state. */ virtual bool isValid() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorportsitem.h b/editors/ComponentEditor/treeStructure/componenteditorportsitem.h index fb0c07ab8..648030859 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorportsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorportsitem.h @@ -36,15 +36,15 @@ class ComponentEditorPortsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] refCounter The instance for counting references. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression parser. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] refCounter The instance for counting references. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression parser. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent item. */ ComponentEditorPortsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -67,35 +67,35 @@ class ComponentEditorPortsItem : public ComponentEditorItem * * The font is bold, if ports exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorregisterfileitem.h b/editors/ComponentEditor/treeStructure/componenteditorregisterfileitem.h index 38934e695..fbd3f3a64 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorregisterfileitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorregisterfileitem.h @@ -35,18 +35,18 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] regFile The register file being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] referenceCounter The instance for counting references to parameters. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The expression formatter. - * @param [in] addressBlockValidator Validator used for address blocks. - * @param [in] registerInterface Interface for accessing registers. - * @param [in] containingBlock Address block containing the edited register file. - * @param [in] parent The parent item. + * @param [in] regFile The register file being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] referenceCounter The instance for counting references to parameters. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The expression formatter. + * @param [in] addressBlockValidator Validator used for address blocks. + * @param [in] registerInterface Interface for accessing registers. + * @param [in] containingBlock Address block containing the edited register file. + * @param [in] parent The parent item. */ ComponentEditorRegisterFileItem( QSharedPointer regFile, @@ -74,35 +74,35 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const override final; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const override final; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const override final; /*! * Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor() override final; /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index) override final; @@ -111,7 +111,7 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /*! * Get the visualizer graphics item for the memory map. * - * @return QGraphicsItem* The graphics item. + * @return QGraphicsItem* The graphics item. */ virtual QGraphicsItem* getGraphicsItem() override final; @@ -123,7 +123,7 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /*! * Get pointer to the visualizer of this item. * - * @return The visualizer to use for this item. + * @return The visualizer to use for this item. */ virtual ItemVisualizer* visualizer() override final; @@ -138,7 +138,7 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /*! * Update the currently set address unit bits value. * - * @param [in] newAddressUnitBits The new address unit bits value to set. + * @param [in] newAddressUnitBits The new address unit bits value to set. */ void addressUnitBitsChanged(int newAddressUnitBits); @@ -150,8 +150,8 @@ class ComponentEditorRegisterFileItem : public ComponentEditorItem /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditorregisteritem.h b/editors/ComponentEditor/treeStructure/componenteditorregisteritem.h index dfcb15304..df761a0c7 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorregisteritem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorregisteritem.h @@ -45,18 +45,18 @@ class ComponentEditorRegisterItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] reg The register being edited. - * @param [in] containingRegisterData Register data containing the edited register. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] referenceCounter The instance counting references made to parameters. - * @param [in] expressionParser The expression parser to use. - * @param [in] registerValidator Validator for registers. - * @param [in] registerInterface Interface for registers. - * @param [in] parent The parent item. + * @param [in] reg The register being edited. + * @param [in] containingRegisterData Register data containing the edited register. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] referenceCounter The instance counting references made to parameters. + * @param [in] expressionParser The expression parser to use. + * @param [in] registerValidator Validator for registers. + * @param [in] registerInterface Interface for registers. + * @param [in] parent The parent item. */ ComponentEditorRegisterItem(QSharedPointer reg, QSharedPointer > > containingRegisterData, @@ -82,55 +82,55 @@ class ComponentEditorRegisterItem : public ComponentEditorItem /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index) override final; /*! Remove a child from the item. * - * @param [in] index The index to remove the child from. + * @param [in] index The index to remove the child from. */ virtual void removeChild(int index) override final; /*! Get pointer to the visualizer of this item. * - * @return Pointer to the visualizer to use for this item. + * @return Pointer to the visualizer to use for this item. */ virtual ItemVisualizer* visualizer() override final; /*! Set the visualizer for this item. * - * @param [in] visualizer Pointer to the visualizer. + * @param [in] visualizer Pointer to the visualizer. */ void setVisualizer(MemoryMapsVisualizer* visualizer); /*! Get the visualizer graphics item for the register. * - * @return QGraphicsItem* Pointer to the graphics item. + * @return QGraphicsItem* Pointer to the graphics item. */ virtual QGraphicsItem* getGraphicsItem() override final; @@ -145,16 +145,16 @@ class ComponentEditorRegisterItem : public ComponentEditorItem /* * Informs of field name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void fieldNameChanged(QString const& oldName, QString const& newName); /* * Informs of register name change. * - * @param [in] oldName The old name. - * @param [in] newName The new name. + * @param [in] oldName The old name. + * @param [in] newName The new name. */ void registerNameChanged(QString const& oldName, QString const& newName); diff --git a/editors/ComponentEditor/treeStructure/componenteditorrootitem.h b/editors/ComponentEditor/treeStructure/componenteditorrootitem.h index 094aa675c..d1dfdf837 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorrootitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorrootitem.h @@ -79,7 +79,7 @@ class ComponentEditorRootItem : public ComponentEditorItem /*! * Adds a child item for the root item. * - * @param [in] childItem The child item to add. + * @param [in] childItem The child item to add. */ void addChildItem(QSharedPointer childItem); diff --git a/editors/ComponentEditor/treeStructure/componenteditorswpropertiesitem.h b/editors/ComponentEditor/treeStructure/componenteditorswpropertiesitem.h index db1aaaf41..cc3f3b9dc 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorswpropertiesitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorswpropertiesitem.h @@ -30,10 +30,10 @@ class ComponentEditorSWPropertiesItem : public ComponentEditorItem /*! The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent item. * */ ComponentEditorSWPropertiesItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -46,31 +46,31 @@ class ComponentEditorSWPropertiesItem : public ComponentEditorItem * * The font is bold, if other SW properties exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); diff --git a/editors/ComponentEditor/treeStructure/componenteditorswviewitem.h b/editors/ComponentEditor/treeStructure/componenteditorswviewitem.h index acca80e64..af91eeb3e 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorswviewitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorswviewitem.h @@ -26,11 +26,11 @@ class ComponentEditorSWViewItem : public ComponentEditorItem { /*! The constructor * - * @param [in] swView The software view to edit. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent item. + * @param [in] swView The software view to edit. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent item. */ ComponentEditorSWViewItem(QSharedPointer swView, ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, @@ -41,25 +41,25 @@ class ComponentEditorSWViewItem : public ComponentEditorItem { /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); @@ -72,7 +72,7 @@ class ComponentEditorSWViewItem : public ComponentEditorItem { /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions() const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorswviewsitem.h b/editors/ComponentEditor/treeStructure/componenteditorswviewsitem.h index 0325f2caa..2e99b1db3 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorswviewsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorswviewsitem.h @@ -25,10 +25,10 @@ class ComponentEditorSWViewsItem : public ComponentEditorItem /*! The constructor * - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parent The parent item. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parent The parent item. */ ComponentEditorSWViewsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, QSharedPointer component, ComponentEditorItem* parent); @@ -40,31 +40,31 @@ class ComponentEditorSWViewsItem : public ComponentEditorItem * * The font is bold, if sw views exist, otherwise not bold. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! Get pointer to the editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); /*! Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. * */ virtual void createChild(int index); diff --git a/editors/ComponentEditor/treeStructure/componenteditortreemodel.h b/editors/ComponentEditor/treeStructure/componenteditortreemodel.h index 2091b96cc..0089413c5 100644 --- a/editors/ComponentEditor/treeStructure/componenteditortreemodel.h +++ b/editors/ComponentEditor/treeStructure/componenteditortreemodel.h @@ -35,8 +35,8 @@ class ComponentEditorTreeModel : public QAbstractItemModel /*! * The constructor. * - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] parent Pointer to the instance that owns this model. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] parent Pointer to the instance that owns this model. */ ComponentEditorTreeModel(QObject* parent); @@ -46,91 +46,91 @@ class ComponentEditorTreeModel : public QAbstractItemModel /*! * Set the root item. * - * @param [in] root Pointer to the root item. + * @param [in] root Pointer to the root item. */ void setRootItem(QSharedPointer root); /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Does the specified item have any child items. * - * @param [in] parent Model index of the item. + * @param [in] parent Model index of the item. * - * @return True if the item has any child items. + * @return True if the item has any child items. */ virtual bool hasChildren(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get index that identifies the given item. * - * @param [in] row The row of the item. - * @param [in] column The column of the item. - * @param [in] parent The parent index of the item. + * @param [in] row The row of the item. + * @param [in] column The column of the item. + * @param [in] parent The parent index of the item. * - * @return QModelIndex The model index that identifies the item. + * @return QModelIndex The model index that identifies the item. */ virtual QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const; /*! * Get the index that identifies the given item. * - * @param [in] item Pointer to the item that's index is wanted. + * @param [in] item Pointer to the item that's index is wanted. * - * @return QModelIndex The model index that identifies the item. + * @return QModelIndex The model index that identifies the item. */ virtual QModelIndex index(ComponentEditorItem* item) const; /*! * Get the index of the parent of given index. * - * @param [in] index The index that identifies the item that's parent is wanted. + * @param [in] index The index that identifies the item that's parent is wanted. * - * @return QModelIndex The model index that identifies the parent. + * @return QModelIndex The model index that identifies the parent. */ virtual QModelIndex parent(const QModelIndex& index) const; /*! * Get the model index of the selected item. * - * @param [in] itemIdentifierChain List of strings identifying the selected item. + * @param [in] itemIdentifierChain List of strings identifying the selected item. * - * @return The model index of the selected item. + * @return The model index of the selected item. */ QModelIndex getIndexOfItem(QVector itemIdentifierChain) const; @@ -141,39 +141,39 @@ public slots: /*! * Handler for component editor item's content changed signal. * - * @param [in] item Pointer to the item that changed. + * @param [in] item Pointer to the item that changed. */ void onContentChanged(ComponentEditorItem* item); /*! * Add a new item to the tree under parent item. * - * @param [in] parentItem Pointer to the item to add the child into. - * @param [in] childIndex The index to add the child to. + * @param [in] parentItem Pointer to the item to add the child into. + * @param [in] childIndex The index to add the child to. */ void addItem(ComponentEditorItem* parentItem, int childIndex); /*! * Remove a child from parent item. * - * @param [in] parentItem Pointer to the item to remove the child from. - * @param [in] childIndex The index of the child to remove. + * @param [in] parentItem Pointer to the item to remove the child from. + * @param [in] childIndex The index of the child to remove. */ void removeItem(ComponentEditorItem* parentItem, int childIndex); /*! * Move a child from one position to another. * - * @param [in] parentItem Pointer to the item that owns the child. - * @param [in] childSource The index of the child to move. - * @param [in] childtarget The index to move the child into. + * @param [in] parentItem Pointer to the item that owns the child. + * @param [in] childSource The index of the child to move. + * @param [in] childtarget The index to move the child into. */ void moveItem(ComponentEditorItem* parentItem, int childSource, int childtarget); /*! * Set the locked state of the editors and visualizers. * - * @param [in] locked True to set the editor's to view only mode. + * @param [in] locked True to set the editor's to view only mode. */ void setLocked(bool locked); @@ -185,8 +185,8 @@ public slots: /*! * Opens the specific C source file of the given component. * - * @param [in] filename The name of the file to open. - * @param [in] component The component containing the file. + * @param [in] filename The name of the file to open. + * @param [in] component The component containing the file. */ void openCSource(QString const& filename, QSharedPointer component); @@ -225,14 +225,14 @@ private slots: /*! * Open bus interface editor for named bus interface. * - * @param [in] interfaceName The name of the bus interface to open. + * @param [in] interfaceName The name of the bus interface to open. */ void onSelectBusInterface(const QString& interfaceName); /*! * Select the given item to be displayed. * - * @param [in] item Pointer to the item which should be displayed. + * @param [in] item Pointer to the item which should be displayed. */ void onSelectItem(ComponentEditorItem* item); @@ -245,10 +245,10 @@ private slots: /*! * Find the model index using the name of the item. * - * @param [in] identifier Identifies the selected item. - * @param [in] parentIndex Parent index of the selected item. + * @param [in] identifier Identifies the selected item. + * @param [in] parentIndex Parent index of the selected item. * - * @return The model index of the selected item. + * @return The model index of the selected item. */ QModelIndex findIndexByItemIdentifier(QString const& identifier, QModelIndex parentIndex = QModelIndex()) const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorviewitem.h b/editors/ComponentEditor/treeStructure/componenteditorviewitem.h index cda85de1c..4f355b8d9 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorviewitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorviewitem.h @@ -39,16 +39,16 @@ class ComponentEditorViewItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] view The view being edited. - * @param [in] model The model that owns the items. - * @param [in] libHandler The instance that manages the library. - * @param [in] component The component being edited. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] viewValidator Validator used for views. - * @param [in] moduleParameterInterface Interface for accessing module parameters. - * @param [in] parent The parent item. + * @param [in] view The view being edited. + * @param [in] model The model that owns the items. + * @param [in] libHandler The instance that manages the library. + * @param [in] component The component being edited. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] viewValidator Validator used for views. + * @param [in] moduleParameterInterface Interface for accessing module parameters. + * @param [in] parent The parent item. */ ComponentEditorViewItem(QSharedPointer view, ComponentEditorTreeModel* model, @@ -69,28 +69,28 @@ class ComponentEditorViewItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ virtual bool isValid() const; /*! * Get The editor of this item. * - * @return The editor to use for this item. + * @return The editor to use for this item. */ virtual ItemEditor* editor(); @@ -125,7 +125,7 @@ class ComponentEditorViewItem : public ComponentEditorItem /*! * Returns the possible actions for opening the item. * - * @return The actions to open the item. + * @return The actions to open the item. */ virtual QList actions() const; diff --git a/editors/ComponentEditor/treeStructure/componenteditorviewsitem.h b/editors/ComponentEditor/treeStructure/componenteditorviewsitem.h index 07e044072..e42b452d9 100644 --- a/editors/ComponentEditor/treeStructure/componenteditorviewsitem.h +++ b/editors/ComponentEditor/treeStructure/componenteditorviewsitem.h @@ -37,14 +37,14 @@ class ComponentEditorViewsItem : public ComponentEditorItem /*! * The constructor. * - * @param [in] model Pointer to the model that owns the items. - * @param [in] libHandler Pointer to the instance that manages the library. - * @param [in] component Pointer to the component being edited. - * @param [in] referenceCounter Pointer to the reference counter. - * @param [in] parameterFinder Pointer to the parameter finder. - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] expressionParser The used expression parser. - * @param [in] parent Pointer to the parent item. + * @param [in] model Pointer to the model that owns the items. + * @param [in] libHandler Pointer to the instance that manages the library. + * @param [in] component Pointer to the component being edited. + * @param [in] referenceCounter Pointer to the reference counter. + * @param [in] parameterFinder Pointer to the parameter finder. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] expressionParser The used expression parser. + * @param [in] parent Pointer to the parent item. */ ComponentEditorViewsItem(ComponentEditorTreeModel* model, LibraryInterface* libHandler, @@ -63,42 +63,42 @@ class ComponentEditorViewsItem : public ComponentEditorItem /*! * Get the tool tip for the item. * - * @return The text for the tool tip to print to user. + * @return The text for the tool tip to print to user. */ virtual QString getTooltip() const; /*! * Get the font to be used for text of this item. * - * @return QFont instance that defines the font to be used. + * @return QFont instance that defines the font to be used. */ virtual QFont getFont() const; /*! * Get the text to be displayed to user in the tree for this item. * - * @return QString Contains the text to display. + * @return QString Contains the text to display. */ virtual QString text() const; /*! * Get pointer to the editor of this item. * - * @return Pointer to the editor to use for this item. + * @return Pointer to the editor to use for this item. */ virtual ItemEditor* editor(); /*! * Add a new child to the item. * - * @param [in] index The index to add the child into. + * @param [in] index The index to add the child into. */ virtual void createChild(int index); /*! * Check the validity of this item and sub items. * - * @return bool True if item is in valid state. + * @return bool True if item is in valid state. */ bool isValid() const override; diff --git a/editors/ComponentEditor/treeStructure/componenttreeview.h b/editors/ComponentEditor/treeStructure/componenttreeview.h index ed5adbfc3..9b12b8f8d 100644 --- a/editors/ComponentEditor/treeStructure/componenttreeview.h +++ b/editors/ComponentEditor/treeStructure/componenttreeview.h @@ -51,9 +51,9 @@ class ComponentTreeView : public ExpandingTreeView /*! * The constructor. * - * @param [in] handler Pointer to the instance that manages the library. - * @param [in] compVLNV The VLNV of the component being edited. - * @param [in] parent Pointer to the owner of this widget + * @param [in] handler Pointer to the instance that manages the library. + * @param [in] compVLNV The VLNV of the component being edited. + * @param [in] parent Pointer to the owner of this widget */ ComponentTreeView(LibraryInterface* handler, const VLNV& compVLNV, @@ -67,14 +67,14 @@ class ComponentTreeView : public ExpandingTreeView /*! * Set the locked state(enables / disables the dragging). * - * @param [in] locked The new locked status. + * @param [in] locked The new locked status. */ void setLocked(bool locked); /*! * Select the specified item and deselect all others. * - * @param [in] index Identifies the item to select. + * @param [in] index Identifies the item to select. */ void selectItem(const QModelIndex& index); @@ -93,8 +93,8 @@ class ComponentTreeView : public ExpandingTreeView * This is reimplemented function that calls the base class implementation * and also emits activated() signal for the current model index. * - * @param [in] current ModelIndex of the new item - * @param [in] previous ModelIndex of the previous item + * @param [in] current ModelIndex of the new item + * @param [in] previous ModelIndex of the previous item */ virtual void currentChanged(const QModelIndex & current, const QModelIndex & previous); @@ -146,7 +146,7 @@ private slots: /*! * Finds the clicked item. * - * @return The clicked item. + * @return The clicked item. */ ComponentEditorItem* getPressedItem(); diff --git a/editors/ComponentEditor/views/ViewsDelegate.h b/editors/ComponentEditor/views/ViewsDelegate.h index 4df55249d..1ddca5d8b 100644 --- a/editors/ComponentEditor/views/ViewsDelegate.h +++ b/editors/ComponentEditor/views/ViewsDelegate.h @@ -28,7 +28,7 @@ class ViewsDelegate : public MultilineDescriptionDelegate /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ViewsDelegate(QObject* parent); diff --git a/editors/ComponentEditor/views/envidentifiereditor.h b/editors/ComponentEditor/views/envidentifiereditor.h index bc5caf488..18d02d96f 100644 --- a/editors/ComponentEditor/views/envidentifiereditor.h +++ b/editors/ComponentEditor/views/envidentifiereditor.h @@ -35,8 +35,8 @@ class EnvIdentifierEditor : public QGroupBox /*! * The constructor. * - * @param [in] view The view being edited. - * @param [in] parent The owner of this widget. + * @param [in] view The view being edited. + * @param [in] parent The owner of this widget. */ EnvIdentifierEditor(QSharedPointer view, QWidget *parent); @@ -51,7 +51,7 @@ class EnvIdentifierEditor : public QGroupBox /*! * Check for the validity of the edited parameters. * - * @return True if all parameters are in valid state. + * @return True if all parameters are in valid state. */ virtual bool isValid() const; diff --git a/editors/ComponentEditor/views/envidentifiersmodel.h b/editors/ComponentEditor/views/envidentifiersmodel.h index 79a3c8ebf..7e51ac64a 100644 --- a/editors/ComponentEditor/views/envidentifiersmodel.h +++ b/editors/ComponentEditor/views/envidentifiersmodel.h @@ -30,8 +30,8 @@ class EnvIdentifiersModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] view The view being edited. - * @param [in] parent The owner of this model + * @param [in] view The view being edited. + * @param [in] parent The owner of this model */ EnvIdentifiersModel(QSharedPointer view, QObject *parent); @@ -41,66 +41,66 @@ class EnvIdentifiersModel : public QAbstractTableModel /*! * Get the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Always returns 3. + * @return Always returns 3. */ virtual int columnCount(const QModelIndex& parent = QModelIndex() ) const; /*! * Get the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data + * @return QVariant containing the data */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole ) const; /*! * Get the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed + * @return QVariant containing the data to be displayed */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole ); /*! * Get information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Check if the model is in valid state or not. * - * @return True if all items in model are valid. + * @return True if all items in model are valid. */ bool isValid() const; @@ -109,14 +109,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); diff --git a/editors/ComponentEditor/views/vieweditor.h b/editors/ComponentEditor/views/vieweditor.h index 5da05ce0c..cd3550ae4 100644 --- a/editors/ComponentEditor/views/vieweditor.h +++ b/editors/ComponentEditor/views/vieweditor.h @@ -45,13 +45,13 @@ class ViewEditor : public ItemEditor /*! * The constructor. * - * @param [in] component The component that contains the view. - * @param [in] view The view being edited. - * @param [in] libHandler The instance that manages the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] parameterInterface Interface for accessing parameters. - * @param [in] parent The owner of this editor. + * @param [in] component The component that contains the view. + * @param [in] view The view being edited. + * @param [in] libHandler The instance that manages the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parent The owner of this editor. */ ViewEditor(QSharedPointer component, QSharedPointer view, diff --git a/editors/ComponentEditor/views/viewseditor.h b/editors/ComponentEditor/views/viewseditor.h index 25400b355..c523b5d60 100644 --- a/editors/ComponentEditor/views/viewseditor.h +++ b/editors/ComponentEditor/views/viewseditor.h @@ -34,10 +34,10 @@ class ViewsEditor : public ItemEditor /*! * The constructor. * - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance managing the library. - * @param [in] viewValidator The validator used for views. - * @param [in] parent Pointer to the parent of this editor. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance managing the library. + * @param [in] viewValidator The validator used for views. + * @param [in] parent Pointer to the parent of this editor. */ ViewsEditor(QSharedPointer component, LibraryInterface* handler, QSharedPointer viewValidator, QWidget* parent = 0); diff --git a/editors/ComponentEditor/views/viewsmodel.h b/editors/ComponentEditor/views/viewsmodel.h index c7d180182..84890ab8f 100644 --- a/editors/ComponentEditor/views/viewsmodel.h +++ b/editors/ComponentEditor/views/viewsmodel.h @@ -32,9 +32,9 @@ class ViewsModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] component Pointer to the component being edited. - * @param [in] viewValidator The validator used for views. - * @param [in] parent Pointer to the owner of the model. + * @param [in] component Pointer to the component being edited. + * @param [in] viewValidator The validator used for views. + * @param [in] parent Pointer to the owner of the model. */ ViewsModel(QSharedPointer component, QSharedPointer viewValidator, QObject* parent); @@ -44,66 +44,66 @@ class ViewsModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item. * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole); /*! * Check if the views model is in a valid state. * - * @return bool True if the state is valid and writing is possible. + * @return bool True if the state is valid and writing is possible. */ bool isValid() const; @@ -112,14 +112,14 @@ public slots: /*! * Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. */ virtual void onAddItem(QModelIndex const& index); /*! * Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); diff --git a/editors/ComponentEditor/visualization/AddressableItem.h b/editors/ComponentEditor/visualization/AddressableItem.h index 6f4de8384..830ea7a5b 100644 --- a/editors/ComponentEditor/visualization/AddressableItem.h +++ b/editors/ComponentEditor/visualization/AddressableItem.h @@ -28,7 +28,7 @@ class AddressableItem : public VisualizerItem /*! * The constructor. * - * @param [in] parent The owner of the item. + * @param [in] parent The owner of the item. */ AddressableItem(QGraphicsItem* parent = nullptr); @@ -45,56 +45,56 @@ class AddressableItem : public VisualizerItem /*! * Get the offset of the item. * - * @return The offset of the item from the parent item's base address. + * @return The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const = 0; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const = 0; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const = 0; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ //virtual unsigned int getAddressUnitSize() const = 0; /*! * Sets the first non-overlapping address to display. * - * @param [in] The first address to set. + * @param [in] The first address to set. */ virtual void setDisplayOffset(quint64 const& address); /*! * Get the first non-overlapping address of the item. * - * @return The first non-overlapping address. + * @return The first non-overlapping address. */ virtual quint64 getDisplayOffset(); /*! * Sets the last non-overlapping address to display. * - * @param [in] The last address to set. + * @param [in] The last address to set. */ virtual void setDisplayLastAddress(quint64 const& address); /*! * Get the last non-overlapping address of the item. * - * @return The last non-overlapping address. + * @return The last non-overlapping address. */ virtual quint64 getDisplayLastAddress(); @@ -104,7 +104,7 @@ class AddressableItem : public VisualizerItem /*! * Checks if the item is conflicted (overlapping with others). * - * @return True, if the item is conflicted, otherwise false. + * @return True, if the item is conflicted, otherwise false. */ bool isConflicted() const; @@ -113,24 +113,24 @@ class AddressableItem : public VisualizerItem /*! * Set the address to be shown on the top left corner. * - * @param [in] address The address to be shown in hexadecimal form. + * @param [in] address The address to be shown in hexadecimal form. */ void setTopLabelText(quint64 address); /*! * Set the address to be shown on the bottom left corner. * - * @param [in] address The address to be shown in hexadecimal form. + * @param [in] address The address to be shown in hexadecimal form. */ void setBottomLabelText(quint64 address); /*! * Converts an address to hexadecimal string. * - * @param [in] address The address to convert. - * @param [in] bitWidth The number of bits used in the representation. + * @param [in] address The address to convert. + * @param [in] bitWidth The number of bits used in the representation. * - * @return The hexadecimal representation. + * @return The hexadecimal representation. */ static QString toHexString(quint64 address, int bitWidth); diff --git a/editors/ComponentEditor/visualization/fieldgapitem.h b/editors/ComponentEditor/visualization/fieldgapitem.h index c32559d1c..fd4ca3dc3 100644 --- a/editors/ComponentEditor/visualization/fieldgapitem.h +++ b/editors/ComponentEditor/visualization/fieldgapitem.h @@ -30,8 +30,8 @@ class FieldGapItem : public MemoryGapItem /*! * The constructor. * - * @param [in] name Name to display for the gap item. - * @param [in] parent The parent graphics item. + * @param [in] name Name to display for the gap item. + * @param [in] parent The parent graphics item. */ FieldGapItem(QString const& name, QSharedPointer expressionParser, QGraphicsItem* parent); @@ -50,14 +50,14 @@ class FieldGapItem : public MemoryGapItem /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const override final; /*! * Get the width of the item. * - * @return The width of the gap item. + * @return The width of the gap item. */ virtual qreal itemTotalWidth() const override final; diff --git a/editors/ComponentEditor/visualization/memorygapitem.h b/editors/ComponentEditor/visualization/memorygapitem.h index cdb8ff848..6e2d9aec1 100644 --- a/editors/ComponentEditor/visualization/memorygapitem.h +++ b/editors/ComponentEditor/visualization/memorygapitem.h @@ -28,7 +28,7 @@ class MemoryGapItem : public MemoryVisualizationItem /*! * The constructor. * - * @param [in] parent Pointer to the parent of the gap item. + * @param [in] parent Pointer to the parent of the gap item. */ MemoryGapItem(QSharedPointer expressionParser, QGraphicsItem* parent); @@ -47,28 +47,28 @@ class MemoryGapItem : public MemoryVisualizationItem /*! * Get the offset of the item. * - * @return int The offset of the item from the parent item's base address. + * @return int The offset of the item from the parent item's base address. */ quint64 getOffset() const override; /*! * Get the last address contained in the gap. * - * @return The last address. + * @return The last address. */ quint64 getLastAddress() const override; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ int getBitWidth() const override; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ unsigned int getAddressUnitSize() const override; diff --git a/editors/ComponentEditor/visualization/memoryvisualizationitem.h b/editors/ComponentEditor/visualization/memoryvisualizationitem.h index 9824ab448..ac4b5bfe7 100644 --- a/editors/ComponentEditor/visualization/memoryvisualizationitem.h +++ b/editors/ComponentEditor/visualization/memoryvisualizationitem.h @@ -38,8 +38,8 @@ class MemoryVisualizationItem : public ExpandableItem /*! * The constructor. * - * @param [in] expressionParser The used expression parser. - * @param [in] parent The owner of the item. + * @param [in] expressionParser The used expression parser. + * @param [in] parent The owner of the item. */ MemoryVisualizationItem(QSharedPointer expressionParser, QGraphicsItem* parent = 0); @@ -59,28 +59,28 @@ class MemoryVisualizationItem : public ExpandableItem /*! * Get the offset of the item. * - * @return The offset of the item from the parent item's base address. + * @return The offset of the item from the parent item's base address. */ virtual quint64 getOffset() const = 0; /*! * Get the last address contained in the item. * - * @return The last address. + * @return The last address. */ virtual quint64 getLastAddress() const = 0; /*! * Get the bit width of the item. * - * @return The bit width of the item. + * @return The bit width of the item. */ virtual int getBitWidth() const = 0; /*! * Get number of bits the addressable unit contains. * - * @return The size of least addressable unit. + * @return The size of least addressable unit. */ virtual unsigned int getAddressUnitSize() const = 0; @@ -90,14 +90,14 @@ class MemoryVisualizationItem : public ExpandableItem /*! * Add a child visualization item for this item. * - * @param [in] childItem Pointer to the child to add. + * @param [in] childItem Pointer to the child to add. */ virtual void addChild(MemoryVisualizationItem* childItem); /*! * Remove a child visualization item from this item. * - * @param [in] childItem Pointer to the child to remove. + * @param [in] childItem Pointer to the child to remove. */ virtual void removeChild(MemoryVisualizationItem* childItem); @@ -106,14 +106,14 @@ class MemoryVisualizationItem : public ExpandableItem /*! * Set the width for the item. * - * @param [in] width The new width of the item. + * @param [in] width The new width of the item. */ virtual void setWidth(qreal width); /*! * The bounding rect of the item. * - * @return The rectangle that bounds the item and possible sub items. + * @return The rectangle that bounds the item and possible sub items. */ virtual QRectF boundingRect() const; @@ -136,14 +136,14 @@ protected slots: /*! * Parse a given expression. * - * @param [in] expression The expression to be parsed. + * @param [in] expression The expression to be parsed. */ quint64 parseExpression(QString const& expression) const; /*! * Get the used expression parser. * - * @return Pointer to the expression parser. + * @return Pointer to the expression parser. */ QSharedPointer getExpressionParser() const; @@ -175,27 +175,27 @@ protected slots: /*! * Checks if there is empty memory space between the given child and the last known used address. * - * @param [in] current The currently iterated child. - * @param [in] lastAddressInUse The last known used address. + * @param [in] current The currently iterated child. + * @param [in] lastAddressInUse The last known used address. * - * @return True, if there is empty space, otherwise false. + * @return True, if there is empty space, otherwise false. */ bool emptySpaceBeforeChild(MemoryVisualizationItem const* current, quint64 lastAddressInUse) const; /*! * Mark child and its preceding children conflicting, if overlapping. * - * @param [in] child The child to check. + * @param [in] child The child to check. */ void markChildIfConflicting(MemoryVisualizationItem* child); /*! * Creates a new child for representing a free memory slot. * - * @param [in] offset The offset of the free memory slot. - * @param [in] lastAddress The last address of the free memory slot. + * @param [in] offset The offset of the free memory slot. + * @param [in] lastAddress The last address of the free memory slot. * - * @return The created child item. + * @return The created child item. */ QMultiMap::iterator createMemoryGap(quint64 offset, quint64 lastAddress); diff --git a/editors/ConfigurationTools/ViewConfigurer.h b/editors/ConfigurationTools/ViewConfigurer.h index 0cf876f09..c8fb42a0e 100644 --- a/editors/ConfigurationTools/ViewConfigurer.h +++ b/editors/ConfigurationTools/ViewConfigurer.h @@ -35,12 +35,12 @@ class ViewConfigurer : public QDialog /*! * The constructor. * - * @param [in] selectedComponent The component used to configure the views. - * @param [in] selectedDesign The component design used to configure the views. - * @param [in] selectedDesignConfiguration The design configuration used to configure the views. - * @param [in] libraryHandler The library manager. - * @param [in] openViewName The name of the currently open view. - * @param [in] parent The parent of this widget. + * @param [in] selectedComponent The component used to configure the views. + * @param [in] selectedDesign The component design used to configure the views. + * @param [in] selectedDesignConfiguration The design configuration used to configure the views. + * @param [in] libraryHandler The library manager. + * @param [in] openViewName The name of the currently open view. + * @param [in] parent The parent of this widget. */ ViewConfigurer(QSharedPointer selectedComponent, QSharedPointer selectedDesign, QSharedPointer selectedDesignConfiguration, LibraryHandler* libraryHandler, @@ -56,8 +56,8 @@ private slots: /*! * Handles the changes in the instance views. * - * @param [in] changedItem The changed tree widget item. - * @param [in] column The column of the changed data. + * @param [in] changedItem The changed tree widget item. + * @param [in] column The column of the changed data. */ void onInstanceViewChanged(QTreeWidgetItem* changedItem, int column); @@ -86,9 +86,9 @@ private slots: /*! * Create child tree items. * - * @param [in] currentDesign The design associated with the current tree item. - * @param [in] currentDesignConfiguration The design configuration associated with the current tree item. - * @param [in] parentItem The parent tree item of the child items. + * @param [in] currentDesign The design associated with the current tree item. + * @param [in] currentDesignConfiguration The design configuration associated with the current tree item. + * @param [in] parentItem The parent tree item of the child items. */ void createChildTreeWidgetItems(QSharedPointer currentDesign, QSharedPointer currentDesignConfiguration, QTreeWidgetItem* parentItem); @@ -96,9 +96,9 @@ private slots: /*! * Check the possible design of the component instance. * - * @param [in] component The component associated with the instance. - * @param [in] viewName The name of the view used by the instance. - * @param [in] currentTreeItem The tree item associated with the instance. + * @param [in] component The component associated with the instance. + * @param [in] viewName The name of the view used by the instance. + * @param [in] currentTreeItem The tree item associated with the instance. */ void checkInstanceDesign(QSharedPointer component, QString const& viewName, QTreeWidgetItem* currentTreeItem); @@ -111,25 +111,25 @@ private slots: /*! * Change the view data of the tree item, if found in the stored configuration. * - * @param [in] currentTreeItem The current tree item. - * @param [in] viewOverrides The stored view overrides. + * @param [in] currentTreeItem The current tree item. + * @param [in] viewOverrides The stored view overrides. */ void parseExistingInstanceView(QTreeWidgetItem* currentTreeItem, QMap viewOverrides); /*! * Check if the changed item is a top level tree item. * - * @param [in] changedTreeItem The changed item. + * @param [in] changedTreeItem The changed item. * - * @return True, if the changed item is a top item, otherwise false. + * @return True, if the changed item is a top item, otherwise false. */ bool isChangedItemTopItem(QTreeWidgetItem* changedTreeItem); /*! * A changed top item means that the used design configuration needs to be changed. * - * @param [in] component The component associated with the top tree item. - * @param [in] viewName The new view name. + * @param [in] component The component associated with the top tree item. + * @param [in] viewName The new view name. */ void changedTopItemChangesDesignConfiguration(QSharedPointer component, QString const& viewName); @@ -141,15 +141,15 @@ private slots: /*! * Check if the tree item contains empty or cyclical views. * - * @param [in] treeItem The selected tree item. + * @param [in] treeItem The selected tree item. */ bool treeItemContainsEmptyOrCyclicalViews(QTreeWidgetItem* treeItem); /*! * Prepare the tree items for saving. * - * @param [in] treeItem The current tree item. - * @param [in] viewOverrides The view overrides. + * @param [in] treeItem The current tree item. + * @param [in] viewOverrides The view overrides. */ void parseChildTreeItem(QTreeWidgetItem* treeItem, QMap& viewOverrides); diff --git a/editors/ConfigurationTools/ViewConfigurerDelegate.h b/editors/ConfigurationTools/ViewConfigurerDelegate.h index 865a46c23..a05fdf9d6 100644 --- a/editors/ConfigurationTools/ViewConfigurerDelegate.h +++ b/editors/ConfigurationTools/ViewConfigurerDelegate.h @@ -27,8 +27,8 @@ class ViewConfigurerDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] libraryHandler The library manager. - * @param [in] parent The parent of this delegate. + * @param [in] libraryHandler The library manager. + * @param [in] parent The parent of this delegate. */ ViewConfigurerDelegate(LibraryHandler* libraryHandler, QObject* parent); @@ -40,11 +40,11 @@ class ViewConfigurerDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item. * - * @param [in] parent Owner of the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner of the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -52,36 +52,36 @@ class ViewConfigurerDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item thats data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item thats data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Paints the delegate. * - * @param [in] painter The painter used. - * @param [in] option Options for the painter. - * @param [in] index Model index identifying the item thats data is to be saved. + * @param [in] painter The painter used. + * @param [in] option Options for the painter. + * @param [in] index Model index identifying the item thats data is to be saved. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Gets the modified size hint for the item of this delegate. * - * @param [in] option The used style option. - * @param [in] index The current index. + * @param [in] option The used style option. + * @param [in] index The current index. * - * @return The size hint of the item at the given index. + * @return The size hint of the item at the given index. */ virtual QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -93,10 +93,10 @@ class ViewConfigurerDelegate : public QStyledItemDelegate /*! * Create the view selector the selected item. * - * @param [in] currentIndex Model Index of the item. - * @param [in] parent The owner of the item. + * @param [in] currentIndex Model Index of the item. + * @param [in] parent The owner of the item. * - * @return View selector for the selected item. + * @return View selector for the selected item. */ QWidget* createViewSelector(QModelIndex const& currentIndex, QWidget* parent) const; diff --git a/editors/HWDesign/ActiveBusInterfaceItem.h b/editors/HWDesign/ActiveBusInterfaceItem.h index 81e0418d4..6bd426fe5 100644 --- a/editors/HWDesign/ActiveBusInterfaceItem.h +++ b/editors/HWDesign/ActiveBusInterfaceItem.h @@ -39,9 +39,9 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * The constructor. * - * @param [in] busIf The bus interface represented by the item. - * @param [in] library The IP-XACT library in use. - * @param [in] parent The parent object. + * @param [in] busIf The bus interface represented by the item. + * @param [in] library The IP-XACT library in use. + * @param [in] parent The parent object. */ ActiveBusInterfaceItem(QSharedPointer busIf, LibraryInterface* library, HWComponentItem* parent); @@ -57,7 +57,7 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Get the graphics item type. * - * @return The item type. + * @return The item type. */ int type() const final { return Type; } @@ -73,7 +73,7 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Sets the endpoint temporary or not temporary. Temporary endpoints can be deleted. * - * @param [in] temp True if temporary; false if not temporary. + * @param [in] temp True if temporary; false if not temporary. */ void setTemporary(bool temp) final; @@ -100,7 +100,7 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Shorten the name label to better fit the component. * - * @param [in] width The width of the shortened name. + * @param [in] width The width of the shortened name. */ void shortenNameLabel( qreal width ) final; @@ -109,15 +109,15 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Notifies item state changes. * - * @param [in] change The change. - * @param [in] value The new value. + * @param [in] change The change. + * @param [in] value The new value. */ QVariant itemChange(GraphicsItemChange change, QVariant const& value) final; /*! * Event for mouse press. * - * @param [in] event The pressed mouse button. + * @param [in] event The pressed mouse button. */ void mousePressEvent(QGraphicsSceneMouseEvent *event) final; @@ -126,17 +126,17 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Update the name change to the relevant contained variables. * - * @param [in] previousName The previous name of the bus interface. - * @param [in] newName The new name of the bus interface. + * @param [in] previousName The previous name of the bus interface. + * @param [in] newName The new name of the bus interface. */ void updateName(QString const& previousName, QString const& newName) final; /*! * Finds the possible opposing modes for a bus interface. * - * @param [in] busIf The interface for which the opposing mode is searched. + * @param [in] busIf The interface for which the opposing mode is searched. * - * @return The possible opposing modes. + * @return The possible opposing modes. */ QList getOpposingModes(QSharedPointer busIf) const; @@ -148,19 +148,19 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Create a move command for this end point item. * - * @param [in] diagram The containing design diagram. + * @param [in] diagram The containing design diagram. * - * @return The created move command. + * @return The created move command. */ QSharedPointer createMouseMoveCommand(DesignDiagram* diagram) final; /*! * Create move command for an end point that has been moved by the movement of this end point. * - * @param [in] endPoint The selected end point. - * @param [in] endPointPosition The new position of the end point. - * @param [in] diagram Design diagram containing the end point. - * @param [in] parentCommand Parent command. + * @param [in] endPoint The selected end point. + * @param [in] endPointPosition The new position of the end point. + * @param [in] diagram Design diagram containing the end point. + * @param [in] parentCommand Parent command. */ void createMoveCommandForClashedItem(ConnectionEndpoint* endPoint, QPointF endPointPosition, DesignDiagram* diagram, QSharedPointer parentCommand) final; @@ -168,16 +168,16 @@ class ActiveBusInterfaceItem : public BusInterfaceEndPoint /*! * Check if a connection can be made to the selected connection end point. * - * @param [in] otherEndPoint The selected connection end point. + * @param [in] otherEndPoint The selected connection end point. * - * @return True, if the connection can be made, false otherwise. + * @return True, if the connection can be made, false otherwise. */ bool canConnectToInterface(ConnectionEndpoint const* otherEndPoint) const final; /*! * Get the current position of the end point. * - * @return The current position of the end point. + * @return The current position of the end point. */ QPointF getCurrentPosition() const final; }; diff --git a/editors/HWDesign/ActivePortItem.h b/editors/HWDesign/ActivePortItem.h index 20d3f11d2..d1b4b5fc0 100644 --- a/editors/HWDesign/ActivePortItem.h +++ b/editors/HWDesign/ActivePortItem.h @@ -37,8 +37,8 @@ class ActivePortItem : public AdHocItem /*! * The constructor. * - * @param [in] port The selected port. - * @param [in] parent The owner of this item. + * @param [in] port The selected port. + * @param [in] parent The owner of this item. */ ActivePortItem(QSharedPointer port, HWComponentItem* parent); @@ -54,7 +54,7 @@ class ActivePortItem : public AdHocItem /*! * Get the type of this graphics item. * - * @return AdHoc interface item type. + * @return AdHoc interface item type. */ int type() const final { return Type; } @@ -70,7 +70,7 @@ class ActivePortItem : public AdHocItem /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks Does not take existing connections into account but simply * validates whether a connection between the endpoints would be valid @@ -81,7 +81,7 @@ class ActivePortItem : public AdHocItem /*! * Check if the port is hierarchical. * - * @return False, port items are always instance items and thus non-hierarchical. + * @return False, port items are always instance items and thus non-hierarchical. */ bool isHierarchical() const noexcept final; @@ -103,7 +103,7 @@ class ActivePortItem : public AdHocItem /*! * Shortens the name label to better fit in the component. * - * @param [in] width The width of the shortened name. + * @param [in] width The width of the shortened name. */ void shortenNameLabel(qreal width) final; @@ -112,15 +112,15 @@ class ActivePortItem : public AdHocItem /*! * Notifies item state changes. * - * @param [in] change The change. - * @param [in] value The new value. + * @param [in] change The change. + * @param [in] value The new value. */ QVariant itemChange(GraphicsItemChange change, const QVariant &value) final; /*! * Event for mouse button release. * - * @param [in] event The release event. + * @param [in] event The release event. */ void mouseReleaseEvent(QGraphicsSceneMouseEvent *event) final; @@ -129,7 +129,7 @@ class ActivePortItem : public AdHocItem /*! * Check whether the label should be drawn on the left side of the interface. * - * @return True, if the label should be drawn to the left side. + * @return True, if the label should be drawn to the left side. */ bool labelShouldBeDrawnLeft() const final; diff --git a/editors/HWDesign/AdHocConnectionItem.h b/editors/HWDesign/AdHocConnectionItem.h index 4b572a8ba..82bad10c0 100644 --- a/editors/HWDesign/AdHocConnectionItem.h +++ b/editors/HWDesign/AdHocConnectionItem.h @@ -55,7 +55,7 @@ class AdHocConnectionItem : public ConnectionItem /*! * Get the type of this connection item. * - * @return Ad hoc connection item type. + * @return Ad hoc connection item type. */ int type() const final { return Type; } diff --git a/editors/HWDesign/AdHocEnabled.h b/editors/HWDesign/AdHocEnabled.h index 234ccfcb1..ba1664324 100644 --- a/editors/HWDesign/AdHocEnabled.h +++ b/editors/HWDesign/AdHocEnabled.h @@ -44,8 +44,8 @@ class AdHocEnabled /*! * Sets the ad-hoc data based on the given component and saved port ad-hoc visibilities. * - * @param [in] component The component whose ports are considered. - * @param [in] portAdHocVisibilities The saved ad-hoc visibilities for the ports. + * @param [in] component The component whose ports are considered. + * @param [in] portAdHocVisibilities The saved ad-hoc visibilities for the ports. */ void setAdHocData(QSharedPointer component, QMap const& portAdHocVisibilities = QMap()); @@ -53,15 +53,15 @@ class AdHocEnabled /*! * Sets the ad-hoc visibility of the given port. * - * @param [in] portName The name of the port. - * @param [in] visible If true, the port is set visible for ad-hoc. + * @param [in] portName The name of the port. + * @param [in] visible If true, the port is set visible for ad-hoc. */ void setPortAdHocVisible(QString const& portName, bool visible); /*! * Returns true if the given port is currently visible for ad-hoc. * - * @param [in] portName The name of the port. + * @param [in] portName The name of the port. */ bool isPortAdHocVisible(QString const& portName) const; @@ -78,8 +78,8 @@ class AdHocEnabled /*! * Called when a port's ad-hoc visibility has been changed. * - * @param [in] portName The name of the port. - * @param [in] visible The new ad-hoc visibility. + * @param [in] portName The name of the port. + * @param [in] visible The new ad-hoc visibility. */ virtual void onAdHocVisibilityChanged(QString const& portName, bool visible); @@ -96,7 +96,7 @@ class AdHocEnabled /*! * Get the name of the ad hoc enabled item. * - * @return The name of the ad hoc enabled item. + * @return The name of the ad hoc enabled item. */ virtual QString adHocIdentifier() const = 0; @@ -108,17 +108,17 @@ class AdHocEnabled /*! * Create an ad hoc port item with the selected name. * - * @param [in] portName The selected port name. + * @param [in] portName The selected port name. * - * @return 0. Child items should create their own items where desired. + * @return 0. Child items should create their own items where desired. */ virtual AdHocItem* createAdhocItem(QString const& portName); /*! * Change the visibility of an ad hoc port item. * - * @param [in] portItem The selected port item. - * @param [in] newVisibility The new visibility of the port item. + * @param [in] portItem The selected port item. + * @param [in] newVisibility The new visibility of the port item. */ void changeAdhocVisibility(AdHocItem* portItem, bool newVisibility); @@ -127,14 +127,14 @@ class AdHocEnabled /*! * Show an ad hoc port item. * - * @param [in] portItem The selected item. + * @param [in] portItem The selected item. */ virtual void showAdhocPort(AdHocItem* portItem); /*! * Hide an ad hoc port item. * - * @param [in] portItem The selected item. + * @param [in] portItem The selected item. */ virtual void hideAdhocPort(AdHocItem* portItem); diff --git a/editors/HWDesign/AdHocItem.h b/editors/HWDesign/AdHocItem.h index df266c396..e02fc3767 100644 --- a/editors/HWDesign/AdHocItem.h +++ b/editors/HWDesign/AdHocItem.h @@ -35,10 +35,10 @@ class AdHocItem : public HWConnectionEndpoint /*! * The constructor. * - * @param [in] port The selected port. - * @param [in] containingComponent Component containing the port. - * @param [in] parent The owner of this item. - * @param [in] dir The direction of the item. + * @param [in] port The selected port. + * @param [in] containingComponent Component containing the port. + * @param [in] parent The owner of this item. + * @param [in] dir The direction of the item. */ AdHocItem(QSharedPointer port, QSharedPointer containingComponent, QGraphicsItem* parent = 0, QVector2D const& dir = QVector2D(0.0f, -1.0f)); @@ -55,7 +55,7 @@ class AdHocItem : public HWConnectionEndpoint /*! * Check if the ad hoc port is valid or not. * - * @return True, if the port is valid, otherwise false. + * @return True, if the port is valid, otherwise false. */ bool adhocPortIsValid() const; @@ -66,44 +66,44 @@ class AdHocItem : public HWConnectionEndpoint /*! * Returns the name of the ad-hoc port. * - * @return The name of the ad hoc port. + * @return The name of the ad hoc port. */ QString name() const override; /*! * Returns the description of the port. * - * @return The description of the port. + * @return The description of the port. */ QString description() const override; /*! * Sets the description of the port. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description) override; /*! * Called when a connection between this and another end point is done. * - * @param [in] other The other end point of the connection. + * @param [in] other The other end point of the connection. * - * @return False if there was an error in the connection. Otherwise true. + * @return False if there was an error in the connection. Otherwise true. */ bool onConnect(ConnectionEndpoint const* other) override; /*! * Check if the port is exclusive, i.e. can only have one connection. * - * @return False. Ad hoc ports are always non-exclusive. + * @return False. Ad hoc ports are always non-exclusive. */ bool isExclusive() const final; /*! * Returns the IP-XACT bus interface model of the port. * - * @return Ad hoc interfaces do not have a bus interface, returns an empty pointer. + * @return Ad hoc interfaces do not have a bus interface, returns an empty pointer. */ QSharedPointer getBusInterface() const override; @@ -113,7 +113,7 @@ class AdHocItem : public HWConnectionEndpoint * @remarks The function returns a null pointer if the end point is a bus interface. * Use isBus() function to check for ad-hoc support (isBus() == false). * - * @return The ad hoc port of the item. + * @return The ad hoc port of the item. */ QSharedPointer getPort() const override; @@ -122,7 +122,7 @@ class AdHocItem : public HWConnectionEndpoint /*! * Check if the end point is an ad hoc port. * - * @return True, if the end point is an ad hoc port, false otherwise. + * @return True, if the end point is an ad hoc port, false otherwise. */ bool isAdHoc() const noexcept override; @@ -134,9 +134,9 @@ class AdHocItem : public HWConnectionEndpoint /*! * Create or change the current tie off label. * - * @param [in] tieOffExpression The expression containing the tie off. - * @param [in] tieOffValue The formatted tie off value. - * @param [in] tieOffIsSupported Flag for determining whether the tie off is supported or not. + * @param [in] tieOffExpression The expression containing the tie off. + * @param [in] tieOffValue The formatted tie off value. + * @param [in] tieOffIsSupported Flag for determining whether the tie off is supported or not. */ void changeTieOffLabel(QString const& tieOffExpression, QString const& tieOffValue, bool tieOffIsSupported); @@ -148,9 +148,9 @@ class AdHocItem : public HWConnectionEndpoint /*! * Check if a connection to the selected connection end point is valid. * - * @param [in] other The selected connection end point. + * @param [in] other The selected connection end point. * - * @return True, if the connection can be created, false otherwise. + * @return True, if the connection can be created, false otherwise. */ bool isConnectionValid(ConnectionEndpoint const* other) const override; @@ -159,14 +159,14 @@ class AdHocItem : public HWConnectionEndpoint /*! * Get the shape of the item. * - * @return Polygon containing the shape of the item. + * @return Polygon containing the shape of the item. */ QPolygonF getPortShape() const; /*! * Get the tie off label of the item. * - * @return The label item containing the current tie off. + * @return The label item containing the current tie off. */ GraphicsItemLabel* getTieOffLabel(); @@ -178,7 +178,7 @@ class AdHocItem : public HWConnectionEndpoint /*! * Event handling for mouse press. * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ void mousePressEvent(QGraphicsSceneMouseEvent *event) override; @@ -187,14 +187,14 @@ class AdHocItem : public HWConnectionEndpoint /*! * Get the shape of an in port. * - * @return Polygon containing the shape of an in port. + * @return Polygon containing the shape of an in port. */ static QPolygonF getInPortShape(); /*! * Get the shape of an out port. * - * @return Polygon containing the shape of an out port. + * @return Polygon containing the shape of an out port. */ static QPolygonF getOutPortShape(); @@ -211,7 +211,7 @@ class AdHocItem : public HWConnectionEndpoint /*! * Check whether the label should be drawn on the left side of the interface. * - * @return True, if the label should be drawn to the left side. + * @return True, if the label should be drawn to the left side. */ virtual bool labelShouldBeDrawnLeft() const = 0; diff --git a/editors/HWDesign/AdhocEditor/AdHocVisibilityDelegate.h b/editors/HWDesign/AdhocEditor/AdHocVisibilityDelegate.h index bd92dceee..b06e377c4 100644 --- a/editors/HWDesign/AdhocEditor/AdHocVisibilityDelegate.h +++ b/editors/HWDesign/AdhocEditor/AdHocVisibilityDelegate.h @@ -26,7 +26,7 @@ class AdHocVisibilityDelegate : public QStyledItemDelegate /*! * Constructor. * - * @param [in] parent Pointer to the owner of this instance. + * @param [in] parent Pointer to the owner of this instance. */ AdHocVisibilityDelegate(QObject *parent = 0); @@ -38,11 +38,11 @@ class AdHocVisibilityDelegate : public QStyledItemDelegate /*! * Creates a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -50,17 +50,17 @@ class AdHocVisibilityDelegate : public QStyledItemDelegate /*! * Sets the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Saves the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -69,19 +69,19 @@ class AdHocVisibilityDelegate : public QStyledItemDelegate /*! * Paint the editor. * - * @param [in] painter The used painter. - * @param [in] option The style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option The style options. + * @param [in] index The current index. */ void paint(QPainter *painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * The editor events. * - * @param [in] event The event itself. - * @param [in] model The used item model. - * @param [in] option The style options. - * @param [in] index The current model index. + * @param [in] event The event itself. + * @param [in] model The used item model. + * @param [in] option The style options. + * @param [in] index The current model index. */ bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/editors/HWDesign/AdhocEditor/AdHocVisibilityEditor.h b/editors/HWDesign/AdhocEditor/AdHocVisibilityEditor.h index f9047fc2e..296155e3d 100644 --- a/editors/HWDesign/AdhocEditor/AdHocVisibilityEditor.h +++ b/editors/HWDesign/AdhocEditor/AdHocVisibilityEditor.h @@ -40,7 +40,7 @@ class AdHocVisibilityEditor : public QWidget /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ AdHocVisibilityEditor(QWidget *parent); @@ -52,10 +52,10 @@ class AdHocVisibilityEditor : public QWidget /*! * Sets the ad-hoc ports visibility data source. * - * @param [in] dataSource The data source. - * @param [in] design The design containing the data source. - * @param [in] editProvider The edit provider to use for undo/redo. - * @param [in] lockEditor If true, the contents cannot be edited. + * @param [in] dataSource The data source. + * @param [in] design The design containing the data source. + * @param [in] editProvider The edit provider to use for undo/redo. + * @param [in] lockEditor If true, the contents cannot be edited. */ void setDataSource(AdHocEnabled* dataSource, QSharedPointer design, QSharedPointer editProvider, bool lockEditor); diff --git a/editors/HWDesign/AdhocEditor/AdHocVisibilityModel.h b/editors/HWDesign/AdhocEditor/AdHocVisibilityModel.h index 61c29412d..7d7933b9f 100644 --- a/editors/HWDesign/AdhocEditor/AdHocVisibilityModel.h +++ b/editors/HWDesign/AdhocEditor/AdHocVisibilityModel.h @@ -32,8 +32,8 @@ class AdHocVisibilityModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] visibilityPolicy Handler for ad hoc visibilities. - * @param [in] parent Pointer to the owner of this model. + * @param [in] visibilityPolicy Handler for ad hoc visibilities. + * @param [in] parent Pointer to the owner of this model. */ AdHocVisibilityModel(QSharedPointer visibilityPolicy, QObject *parent); @@ -45,70 +45,70 @@ class AdHocVisibilityModel : public QAbstractTableModel /*! * Sets the ad-hoc port visibility data source being edited. * - * @param [in] dataSource The data source. - * @param [in] editProvider The provider for undo commands. + * @param [in] dataSource The data source. + * @param [in] editProvider The provider for undo commands. */ void setDataSource(AdHocEnabled* dataSource, QSharedPointer editProvider); /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a * hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a * hierarchical model. * - * @return Always returns 3. + * @return Always returns 3. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole * is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; @@ -131,9 +131,9 @@ public slots: /*! * Get the direction of the selected port. * - * @param [in] adhocPort The selected port. + * @param [in] adhocPort The selected port. * - * @return Direction of the selected port. + * @return Direction of the selected port. */ QString getPortDirection(QSharedPointer adhocPort) const; diff --git a/editors/HWDesign/AdhocEditor/AdHocVisibilityPolicy.h b/editors/HWDesign/AdhocEditor/AdHocVisibilityPolicy.h index 4bd9a7f69..7128a55c1 100644 --- a/editors/HWDesign/AdhocEditor/AdHocVisibilityPolicy.h +++ b/editors/HWDesign/AdhocEditor/AdHocVisibilityPolicy.h @@ -39,8 +39,8 @@ class AdHocVisibilityPolicy /*! * Sets the ad-hoc port visibility data source being edited. * - * @param [in] dataSource The data source. - * @param [in] connections List of ad hoc connections within the design. + * @param [in] dataSource The data source. + * @param [in] connections List of ad hoc connections within the design. */ void setDataSource(AdHocEnabled* dataSource, QSharedPointer > > connections); @@ -48,36 +48,36 @@ class AdHocVisibilityPolicy /*! * Check if the visibility can be changed for the selected port. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the visibility can be changed, false otherwise. + * @return True, if the visibility can be changed, false otherwise. */ bool canChangeVisibility(QSharedPointer port) const; /*! * Check if the selected port has connections. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the selected port has been connected, otherwise false. + * @return True, if the selected port has been connected, otherwise false. */ bool portHasConnections(QSharedPointer port) const; /*! * Check if the selected port has a tie off value. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return True, if the selected port has a tie off value, otherwise false. + * @return True, if the selected port has a tie off value, otherwise false. */ bool portHasTieOffConnection(QSharedPointer port) const; /*! * Check if the selected port is determined to be visible within the containing component. * - * @param [in] portName The name of the port. + * @param [in] portName The name of the port. * - * @return True, if the selected port is determined to be visible, otherwise false. + * @return True, if the selected port is determined to be visible, otherwise false. */ bool isPortAdhocVisible(QString const& portName) const; @@ -92,9 +92,9 @@ class AdHocVisibilityPolicy /*! * Get a connection containing the tie off value of the selected port. * - * @param [in] port The selected port. + * @param [in] port The selected port. * - * @return A connection containing the tie off value of the selected port. Empty pointer if no + * @return A connection containing the tie off value of the selected port. Empty pointer if no * connection is found. */ QSharedPointer getTieOffConnection(QSharedPointer port) const; diff --git a/editors/HWDesign/AdhocEditor/AdhocEditor.h b/editors/HWDesign/AdhocEditor/AdhocEditor.h index 587770fa8..3e68b0a49 100644 --- a/editors/HWDesign/AdhocEditor/AdhocEditor.h +++ b/editors/HWDesign/AdhocEditor/AdhocEditor.h @@ -47,10 +47,10 @@ class AdhocEditor : public QWidget /*! * Sets the ad-hoc ports visibility data source. * - * @param [in] dataSource The data source. - * @param [in] design The design containing the data source. - * @param [in] editProvider The edit provider to use for undo/redo. - * @param [in] lockEditor If true, the contents cannot be edited. + * @param [in] dataSource The data source. + * @param [in] design The design containing the data source. + * @param [in] editProvider The edit provider to use for undo/redo. + * @param [in] lockEditor If true, the contents cannot be edited. */ void setVisibilityData(AdHocEnabled* dataSource, QSharedPointer design, QSharedPointer editProvider, bool lockEditor); @@ -63,9 +63,9 @@ class AdhocEditor : public QWidget /*! * Set the ad hoc port data to display. * - * @param [in] endPoint The selected ad hoc port. - * @param [in] containingDiagram The design diagram containing the ad hoc port. - * @param [in] editProvider The provider for undo commands. + * @param [in] endPoint The selected ad hoc port. + * @param [in] containingDiagram The design diagram containing the ad hoc port. + * @param [in] editProvider The provider for undo commands. */ void setPortData(AdHocItem* endPoint, HWDesignDiagram* containingDiagram, QSharedPointer editProvider); @@ -84,14 +84,14 @@ class AdhocEditor : public QWidget /*! * Informs of new references made to the parameter with the selected ID. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. */ void increaseReferences(QString const& parameterID); /*! * Informs of removing references from the parameter with the selected ID. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. */ void decreaseReferences(QString const& parameterID); diff --git a/editors/HWDesign/AdhocEditor/AdhocPortEditor.h b/editors/HWDesign/AdhocEditor/AdhocPortEditor.h index 32935906f..c0256d936 100644 --- a/editors/HWDesign/AdhocEditor/AdhocPortEditor.h +++ b/editors/HWDesign/AdhocEditor/AdhocPortEditor.h @@ -41,8 +41,8 @@ class AdhocPortEditor : public QWidget /*! * The constructor. * - * @param [in] designParameterFinder Parameter finder for design parameters. - * @param [in] parent The parent widget. + * @param [in] designParameterFinder Parameter finder for design parameters. + * @param [in] parent The parent widget. */ AdhocPortEditor(QSharedPointer designParameterFinder, QWidget* parent); @@ -54,9 +54,9 @@ class AdhocPortEditor : public QWidget /*! * Set the ad hoc port. * - * @param [in] endPoint The selected ad hoc port. - * @param [in] containingDiagram The design diagram containing the ad hoc port. - * @param [in] editProvider The provider for undo commands. + * @param [in] endPoint The selected ad hoc port. + * @param [in] containingDiagram The design diagram containing the ad hoc port. + * @param [in] editProvider The provider for undo commands. */ void setAdhocPort(AdHocItem* endPoint, HWDesignDiagram* containingDiagram, QSharedPointer editProvider); @@ -88,14 +88,14 @@ private slots: /*! * Handles the increasing of parameter reference counts in the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void onIncreaseReferencesInExpression(QString const& expression); /*! * Handles the decreasing of parameter reference counts in the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void onDecreaseReferencesInExpression(QString const& expression); @@ -114,14 +114,14 @@ private slots: /*! * Informs of new references made to the parameter with the selected ID. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. */ void increaseReferences(QString const& parameterID); /*! * Informs of removing references from the parameter with the selected ID. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. */ void decreaseReferences(QString const& parameterID); @@ -134,25 +134,25 @@ private slots: /*! * Calculate the formatted value for a given expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. * - * @return The formatted value of a given expression. + * @return The formatted value of a given expression. */ QString formattedValueFor(QString const& expression) const; /*! * Get the tied value associated with contained ad hoc port. * - * @param [in] connectionItem The tied value connection of the associated ad hoc port. + * @param [in] connectionItem The tied value connection of the associated ad hoc port. * - * @return The tied value of the ad hoc port. + * @return The tied value of the ad hoc port. */ QString getTiedValue(QSharedPointer connectionItem) const; /*! * Get the ad hoc connection containing this ad hoc ports tied value. * - * @return The selected ad hoc connection, or an empty pointer if no connection was found. + * @return The selected ad hoc connection, or an empty pointer if no connection was found. */ QSharedPointer getTiedConnection() const; @@ -161,58 +161,58 @@ private slots: /*! * Create a tie off change command. * - * @param [in] newTiedValue The new tie off value. + * @param [in] newTiedValue The new tie off value. */ void createTieOffChangeCommand(QString const& newTiedValue); /*! * Calculate the tie off value. * - * @param [in] tieOffValue The selected tie off value. + * @param [in] tieOffValue The selected tie off value. * - * @return The calculated tie off value. + * @return The calculated tie off value. */ QString getParsedTieOffValue(QString const& tieOffValue) const; /*! * Set a tool tip for the tied value editor. * - * @param [in] tiedValue The new tied value. + * @param [in] tiedValue The new tied value. */ void setTiedValueEditorToolTip(QString const& tiedValue); /*! * Update the bounds of the tied value connection. * - * @param [in] portPartSelect Part select of the referenced port. + * @param [in] portPartSelect Part select of the referenced port. */ void updateTiedValueBounds(QSharedPointer portPartSelect); /*! * Get the part select of the referenced port. * - * @param [in] adHocConnection Connection containing the ad hoc item. + * @param [in] adHocConnection Connection containing the ad hoc item. * - * @return The part select of the referenced port. + * @return The part select of the referenced port. */ QSharedPointer getEndPointPartSelect(QSharedPointer adHocConnection) const; /*! * Create a change command for the tie off bounds. * - * @param [in] newLeftBound New value for the left bound of the tied value. - * @param [in] newRightBound New value for the right bounds of the tied value. + * @param [in] newLeftBound New value for the left bound of the tied value. + * @param [in] newRightBound New value for the right bounds of the tied value. */ void createTieOffBoundsChangeCommand(QString const& newLeftBound, QString const& newRightBound); /*! * Check if the new tie off bounds values differ from the current values. * - * @param [in] newLeftBound New tie off left bound. - * @param [in] newRightBound New tie off right bound. - * @param [in] connection The selected ad hoc connection. + * @param [in] newLeftBound New tie off left bound. + * @param [in] newRightBound New tie off right bound. + * @param [in] connection The selected ad hoc connection. * - * @return True, if the tie off values have changed, false otherwise. + * @return True, if the tie off values have changed, false otherwise. */ bool tieOffBoundsHaveChanged(QString const& newLeftBound, QString const& newRightBound, QSharedPointer connection) const; @@ -220,7 +220,7 @@ private slots: /*! * Change the signal block status of the expression editors. * - * @param [in] block New block status for the expression editor signals. + * @param [in] block New block status for the expression editor signals. */ void blockExpressionEditorSignals(bool block); diff --git a/editors/HWDesign/BusInterfaceDialog.h b/editors/HWDesign/BusInterfaceDialog.h index e87351eb8..849f9ce76 100644 --- a/editors/HWDesign/BusInterfaceDialog.h +++ b/editors/HWDesign/BusInterfaceDialog.h @@ -31,7 +31,7 @@ class BusInterfaceDialog : public QDialog /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ BusInterfaceDialog(QWidget* parent = 0); @@ -43,7 +43,7 @@ class BusInterfaceDialog : public QDialog /*! * Adds a mode to the possible alternatives. * - * @param [in] mode The interface mode to add. + * @param [in] mode The interface mode to add. */ void addMode(General::InterfaceMode mode); diff --git a/editors/HWDesign/BusInterfaceEndPoint.h b/editors/HWDesign/BusInterfaceEndPoint.h index ff8d127a9..5a99829c7 100644 --- a/editors/HWDesign/BusInterfaceEndPoint.h +++ b/editors/HWDesign/BusInterfaceEndPoint.h @@ -39,11 +39,11 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * The constructor. * - * @param [in] busIf The bus interface this item represents. - * @param [in] component Component containing the bus interface. - * @param [in] library Access to the library. - * @param [in] parent The parent object. - * @param [in] dir Direction for the end point graphics. + * @param [in] busIf The bus interface this item represents. + * @param [in] component Component containing the bus interface. + * @param [in] library Access to the library. + * @param [in] parent The parent object. + * @param [in] dir Direction for the end point graphics. */ BusInterfaceEndPoint(QSharedPointer busIf, QSharedPointer component, LibraryInterface* library, bool isDraft, QGraphicsItem *parent = nullptr, QVector2D const& dir = QVector2D(0.0f, -1.0f)); @@ -65,42 +65,42 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Set a new name for the bus interface. * - * @param [in] name The new bus interface name. + * @param [in] name The new bus interface name. */ void setName(QString const& name) override; /*! * Get the description of the bus interface. * - * @return The bus interface description. + * @return The bus interface description. */ QString description() const override; /*! * Set a new description for the bus interface. * - * @param [in] description The selected description to set. + * @param [in] description The selected description to set. */ void setDescription(QString const& description) override; /*! * Get the contained bus interface. * - * @return The contained bus interface. + * @return The contained bus interface. */ QSharedPointer getBusInterface() const override; /*! * Check if the bus interface can only have one connection. * - * @return True, if the bus interface is exclusive, false otherwise. + * @return True, if the bus interface is exclusive, false otherwise. */ bool isExclusive() const override; /*! * Sets the draw direction of the endpoint. * - * @param [in] dir The draw direction to set. + * @param [in] dir The draw direction to set. * * @remarks The direction can be changed only if isDirectionFixed() returns false. */ @@ -109,53 +109,53 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Check if the end point is a bus interface. * - * @return True. + * @return True. */ bool isBus() const noexcept override; /*! * Get the type of the connection end point. * - * @return This end point is a bus interface. + * @return This end point is a bus interface. */ ConnectionEndpoint::EndpointType getType() const noexcept override; /*! * Set the interface mode for the end point. * - * @param mode [in] The interface mode to set. + * @param mode [in] The interface mode to set. */ virtual void setInterfaceMode(General::InterfaceMode mode); /*! * Get the mode of the contained bus interface. * - * @return The bus interface mode. + * @return The bus interface mode. */ virtual General::InterfaceMode getInterfaceMode() const; /*! * Check if a connection can be made to the selected end point. * - * @param [in] other The end point to be connected. + * @param [in] other The end point to be connected. * - * @return True, if the connection can be made, false otherwise. + * @return True, if the connection can be made, false otherwise. */ bool isConnectionValid(ConnectionEndpoint const* other) const override; /*! * Handles the connecting of the connection end points. * - * @param [in] other The other end of the connection. + * @param [in] other The other end of the connection. * - * @return True, if the connection was made successfully, false otherwise. + * @return True, if the connection was made successfully, false otherwise. */ bool onConnect(ConnectionEndpoint const* other) override; /*! * Set a new bus interface. * - * @param [in] newBus The selected bus interface. + * @param [in] newBus The selected bus interface. */ void setBusInterface(QSharedPointer newBus); @@ -164,28 +164,28 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Get the position of the bus interface item before moving it. * - * @return The old position of the bus interface item. + * @return The old position of the bus interface item. */ QPointF getOldPosition() const; /*! * Store the given position as the old position of the item. * - * @param [in] newPosition The position to be stored. + * @param [in] newPosition The position to be stored. */ void setOldPosition(QPointF const& newPosition); /*! * Set the positions of the end point items from the same level as this item. * - * @param [in] items List of the associated end point items. + * @param [in] items List of the associated end point items. */ void saveOldPortPositions(QList items); /*! * Get the stored positions of the associated end point items. * - * @return The stored positions of the associated end point items. + * @return The stored positions of the associated end point items. */ QMap getOldPortPositions() const; @@ -197,70 +197,70 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Handle the mouse release events. * - * @param [in] event The mouse release event. + * @param [in] event The mouse release event. */ void mouseReleaseEvent(QGraphicsSceneMouseEvent *event) override; /*! * Get the shape of the bus interface with direction in. * - * @return The shape of the bus interface with direction in. + * @return The shape of the bus interface with direction in. */ static QPolygonF getDirectionInShape(); /*! * Get the shape of the bus interface with direction out. * - * @return The shape of the bus interface with direction out. + * @return The shape of the bus interface with direction out. */ static QPolygonF getDirectionOutShape(); /*! * Get the shape of the bus interface with direction in/out. * - * @return The shape of the bus interface with direction in/out. + * @return The shape of the bus interface with direction in/out. */ static QPolygonF getDirectionInOutShape(); /*! * Get the shape of the bus interface with initiative provides. * - * @return The shape of the bus interface with initiative provides. + * @return The shape of the bus interface with initiative provides. */ static QPolygonF getInitiativeProvidesShape(); /*! * Get the shape of the bus interface with initiative requires. * - * @return The shape of the bus interface with initiative requires. + * @return The shape of the bus interface with initiative requires. */ static QPolygonF getInitiativeRequiresShape(); /*! * Get the shape of the bus interface with initiative requires / provides. * - * @return The shape of the bus interface with initiative requires / provides. + * @return The shape of the bus interface with initiative requires / provides. */ static QPolygonF getInitiativeRequiresProvidesShape(); /*! * Get access to the library. * - * @return The library interface. + * @return The library interface. */ LibraryInterface* getLibraryAccess() const; /*! * Get isDraft_ parameter. * - * @return Boolean isDraft_ parameter. + * @return Boolean isDraft_ parameter. */ bool getIsDraft() const; /*! * Set isDraft_ parameter. * - * @param [in] isDraft Value to be set to isDraft_. + * @param [in] isDraft Value to be set to isDraft_. */ void setIsDraft(bool isDraft); @@ -269,45 +269,45 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Get the graphical shape for the interface item. * - * @param [in] direction Direction of the interface item. + * @param [in] direction Direction of the interface item. * - * @return The new shape for the interface item. + * @return The new shape for the interface item. */ QPolygonF getInterfaceShapeWithDirection(DirectionTypes::Direction direction) const; /*! * Get the graphical shape for the interface item. * - * @param [in] initiative Initiative of the interface item. + * @param [in] initiative Initiative of the interface item. * - * @return The new shape for the interface item. + * @return The new shape for the interface item. */ QPolygonF getInterfaceShapeWithInitiative(TransactionalTypes::Initiative initiative) const; /*! * Handle the name change of the bus interface. * - * @param [in] previousName The previous name. - * @param [in] newName The new name. + * @param [in] previousName The previous name. + * @param [in] newName The new name. */ virtual void updateName(QString const& previousName, QString const& newName) = 0; /*! * Create a move command for this end point item. * - * @param [in] diagram The containing design diagram. + * @param [in] diagram The containing design diagram. * - * @return The created move command. + * @return The created move command. */ virtual QSharedPointer createMouseMoveCommand(DesignDiagram* diagram) = 0; /*! * Create move command for an end point that has been moved by the movement of this end point. * - * @param [in] endPoint The selected end point. - * @param [in] endPointPosition The new position of the end point. - * @param [in] diagram Design diagram containing the end point. - * @param [in] parentCommand Parent command. + * @param [in] endPoint The selected end point. + * @param [in] endPointPosition The new position of the end point. + * @param [in] diagram Design diagram containing the end point. + * @param [in] parentCommand Parent command. */ virtual void createMoveCommandForClashedItem(ConnectionEndpoint* endPoint, QPointF endPointPosition, DesignDiagram* diagram, QSharedPointer parentCommand) = 0; @@ -315,9 +315,9 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Check if a connection can be made to the selected connection end point. * - * @param [in] otherEndPoint The selected connection end point. + * @param [in] otherEndPoint The selected connection end point. * - * @return True, if the connection can be made, false otherwise. + * @return True, if the connection can be made, false otherwise. */ virtual bool canConnectToInterface(ConnectionEndpoint const* otherEndPoint) const = 0; @@ -329,7 +329,7 @@ class BusInterfaceEndPoint : public HWConnectionEndpoint /*! * Get the current position of the end point. * - * @return The current position of the end point. + * @return The current position of the end point. */ virtual QPointF getCurrentPosition() const = 0; diff --git a/editors/HWDesign/HWAddCommands.h b/editors/HWDesign/HWAddCommands.h index f6835c9e6..003688bd4 100644 --- a/editors/HWDesign/HWAddCommands.h +++ b/editors/HWDesign/HWAddCommands.h @@ -47,10 +47,10 @@ class PortAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component to which to add a port. - * @param [in] pos The position where to add the port. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] component The component to which to add a port. + * @param [in] pos The position where to add the port. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ PortAddCommand(HWComponentItem* component, QPointF const& pos, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -107,9 +107,9 @@ class ConnectionAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] scene The scene. - * @param [in] connectionItem The interconnection to add. - * @param [in] parent The parent command. + * @param [in] scene The scene. + * @param [in] connectionItem The interconnection to add. + * @param [in] parent The parent command. */ ConnectionAddCommand(QGraphicsScene* scene, HWConnection* connectionItem, QSharedPointer design, QUndoCommand* parent = 0); @@ -161,11 +161,11 @@ class BusInterfacePasteCommand : public QUndoCommand * * Creates the child commands for adding physical ports to the component model. * - * @param [in] destComponent The component to which to copy an interface. - * @param [in] interface The interface item to paste. - * @param [in] column The target column. - * @param [in] diagram The target design diagram. - * @param [in] parent The parent command. + * @param [in] destComponent The component to which to copy an interface. + * @param [in] interface The interface item to paste. + * @param [in] column The target column. + * @param [in] diagram The target design diagram. + * @param [in] parent The parent command. */ BusInterfacePasteCommand(QSharedPointer destComponent, HierarchicalBusInterfaceItem* interfaceItem, GraphicsColumn* column, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -225,9 +225,9 @@ class AddPhysicalPortCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component to which to copy a physical port. - * @param [in] port The port to paste. - * @param [in] parent The parent command. + * @param [in] component The component to which to copy a physical port. + * @param [in] port The port to paste. + * @param [in] parent The parent command. */ AddPhysicalPortCommand(QSharedPointer, QSharedPointer port, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/HWChangeCommands.h b/editors/HWDesign/HWChangeCommands.h index fa60c38a3..7645ecce3 100644 --- a/editors/HWDesign/HWChangeCommands.h +++ b/editors/HWDesign/HWChangeCommands.h @@ -62,10 +62,10 @@ class ComponentChangeNameCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component. - * @param [in] newName The component's new name. - * @param [in] design Design containing the component instance. - * @param [in] parent The parent command. + * @param [in] component The component. + * @param [in] newName The component's new name. + * @param [in] design Design containing the component instance. + * @param [in] parent The parent command. */ ComponentChangeNameCommand(ComponentItem* component, QString const& newName, QSharedPointer design, QUndoCommand* parent = 0); @@ -93,18 +93,18 @@ class ComponentChangeNameCommand : public QUndoCommand /*! * Renames the component instance and change the component reference in connections. * - * @param [in] oldReference The old component reference. - * @param [in] newReference The new component reference. + * @param [in] oldReference The old component reference. + * @param [in] newReference The new component reference. */ void renameInstanceAndConnections(QString const& previousName, QString const& newReference); /*! * Change the default name of an ad hoc connection. * - * @param [in] connection The selected ad hoc connection. - * @param [in] portReference The reference port of the containing interface. - * @param [in] oldReference Old component reference. - * @param [in] newReference New component reference. + * @param [in] connection The selected ad hoc connection. + * @param [in] portReference The reference port of the containing interface. + * @param [in] oldReference Old component reference. + * @param [in] newReference New component reference. */ void changeAdHocConnectionDefaultName(QSharedPointer connection, QString const& portReference, QString const& oldReference, QString const& newReference); @@ -132,9 +132,9 @@ class ComponentChangeDisplayNameCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component. - * @param [in] newDisplayName The component's new display name. - * @param [in] parent The parent command. + * @param [in] component The component. + * @param [in] newDisplayName The component's new display name. + * @param [in] parent The parent command. */ ComponentChangeDisplayNameCommand(ComponentItem* component, QString const& newDisplayName, QUndoCommand* parent = 0); @@ -179,9 +179,9 @@ class ComponentChangeDescriptionNameCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component. - * @param [in] newDescription The component's new description. - * @param [in] parent The parent command. + * @param [in] component The component. + * @param [in] newDescription The component's new description. + * @param [in] parent The parent command. */ ComponentChangeDescriptionNameCommand(ComponentItem* component, QString const& newDescription, QUndoCommand* parent = 0); @@ -227,11 +227,11 @@ class ComponentActiveViewChangeCommand : public QUndoCommand /*! * The constructor * - * @param [in] instanceName The name of the component instance - * @param [in] oldActiveView The name of the previous active view. - * @param [in] newActiveView The name of the new active view. - * @param [in] activeViewModel Pointer to the model that manages the active views. - * @param [in] parent Pointer to the parent command. + * @param [in] instanceName The name of the component instance + * @param [in] oldActiveView The name of the previous active view. + * @param [in] newActiveView The name of the new active view. + * @param [in] activeViewModel Pointer to the model that manages the active views. + * @param [in] parent Pointer to the parent command. */ ComponentActiveViewChangeCommand(const QString& instanceName, QString const& oldActiveView, QString const& newActiveView, ActiveViewModel* activeViewModel, QUndoCommand* parent = 0); @@ -285,10 +285,10 @@ class ComponentPacketizeCommand : public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] diagram The design diagram containing the packaged component. - * @param [in] component The component to package. - * @param [in] vlnv The VLNV of the packaged component. - * @param [in] parent The parent command. + * @param [in] diagram The design diagram containing the packaged component. + * @param [in] component The component to package. + * @param [in] vlnv The VLNV of the packaged component. + * @param [in] parent The parent command. */ ComponentPacketizeCommand(DesignDiagram* diagram, ComponentItem* component, VLNV const& vlnv, QUndoCommand* parent = 0); @@ -339,9 +339,9 @@ class EndpointChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The diagram connection end point. - * @param [in] newInterfaceMode The end point's new interface mode. - * @param [in] parent The parent command. + * @param [in] endpoint The diagram connection end point. + * @param [in] newInterfaceMode The end point's new interface mode. + * @param [in] parent The parent command. */ EndpointChangeCommand(ConnectionEndpoint* endpoint, General::InterfaceMode newMode, @@ -391,9 +391,9 @@ class EndpointNameChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newName The endpoint's new name. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newName The endpoint's new name. + * @param [in] parent The parent command. */ EndpointNameChangeCommand(ConnectionEndpoint* endpoint, QString const& newName, @@ -446,9 +446,9 @@ class EndpointDescChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newDescription The endpoint's new description. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newDescription The endpoint's new description. + * @param [in] parent The parent command. */ EndpointDescChangeCommand(ConnectionEndpoint* endpoint, QString const& newDescription, QUndoCommand* parent = 0); @@ -496,9 +496,9 @@ class EndpointDependencyDirectionChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newDir The endpoint's new dependency direction. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newDir The endpoint's new dependency direction. + * @param [in] parent The parent command. */ EndpointDependencyDirectionChangeCommand(ConnectionEndpoint* endpoint, DependencyDirection newDir, QUndoCommand* parent = 0); @@ -546,9 +546,9 @@ class EndpointComDirectionChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newDir The endpoint's new COM direction. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newDir The endpoint's new COM direction. + * @param [in] parent The parent command. */ EndpointComDirectionChangeCommand(ConnectionEndpoint* endpoint, DirectionTypes::Direction newDir, QUndoCommand* parent = 0); @@ -596,9 +596,9 @@ class EndpointTransferTypeChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newDir The endpoint's new COM data type. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newDir The endpoint's new COM data type. + * @param [in] parent The parent command. */ EndpointTransferTypeChangeCommand(ConnectionEndpoint* endpoint, QString const& newTransferType, QUndoCommand* parent = 0); @@ -646,9 +646,9 @@ class EndpointPropertyValuesChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The connection endpoint. - * @param [in] newValues The endpoint's new property values. - * @param [in] parent The parent command. + * @param [in] endpoint The connection endpoint. + * @param [in] newValues The endpoint's new property values. + * @param [in] parent The parent command. */ EndpointPropertyValuesChangeCommand(ConnectionEndpoint* endpoint, QMap const& newValues, @@ -697,11 +697,11 @@ class EndPointTypesCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The diagram connection end point. - * @param [in] busType The end point's current bus type. - * @param [in] absType The end point's current abs type. - * @param [in] activeView The active view of the containing item. - * @param [in] parent The parent command. + * @param [in] endpoint The diagram connection end point. + * @param [in] busType The end point's current bus type. + * @param [in] absType The end point's current abs type. + * @param [in] activeView The active view of the containing item. + * @param [in] parent The parent command. */ EndPointTypesCommand(ConnectionEndpoint* endpoint, VLNV const& busType, VLNV const& absType, QString const& activeView, QUndoCommand* parent = 0); @@ -762,10 +762,10 @@ class EndPointPortMapCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The diagram connection end point. - * @param [in] newPortMaps The new port maps for the end point. - * @param [in] component The component whose design is being edited. - * @param [in] parent The parent command. + * @param [in] endpoint The diagram connection end point. + * @param [in] newPortMaps The new port maps for the end point. + * @param [in] component The component whose design is being edited. + * @param [in] parent The parent command. */ EndPointPortMapCommand(ConnectionEndpoint* endpoint, QList< QSharedPointer > newPortMaps, diff --git a/editors/HWDesign/HWComponentItem.h b/editors/HWDesign/HWComponentItem.h index e55db5154..bf4b74dda 100644 --- a/editors/HWDesign/HWComponentItem.h +++ b/editors/HWDesign/HWComponentItem.h @@ -44,10 +44,10 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled /*! * The constructor. * - * @param [in] libInterface The library in use. - * @param [in] instance The component instance represented by the item. - * @param [in] component The component represented by the instance. - * @param [in] parent The parent object. + * @param [in] libInterface The library in use. + * @param [in] instance The component instance represented by the item. + * @param [in] component The component represented by the instance. + * @param [in] parent The parent object. */ HWComponentItem(LibraryInterface* libInterface, QSharedPointer instance, QSharedPointer component, QGraphicsItem* parent = nullptr); @@ -65,8 +65,8 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled /*! * Called when a port's ad-hoc visibility has been changed. * - * @param [in] portName The name of the port. - * @param [in] visible The new ad-hoc visibility. + * @param [in] portName The name of the port. + * @param [in] visible The new ad-hoc visibility. */ virtual void onAdHocVisibilityChanged(QString const& portName, bool visible); @@ -91,23 +91,23 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled * Adds a new, empty bus interface to the component. This function creates automatically an empty * bus interface to the component. * - * @param [in] pos The position hint for the port. + * @param [in] pos The position hint for the port. * - * @return The newly created port. + * @return The newly created port. */ ActiveBusInterfaceItem* addPort(QPointF const& pos); /*! * Adds an already created bus interface to the component. * - * @param [in] port The interface to add. Must not be used in any other component. + * @param [in] port The interface to add. Must not be used in any other component. */ void addPort(HWConnectionEndpoint* port); /*! * Removes the given port from the component. * - * @param [in] port The port to remove. + * @param [in] port The port to remove. */ void removePort(HWConnectionEndpoint* port); @@ -124,7 +124,7 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled /*! Called when a port is being moved. * - * @param [in] port The port that is being moved. + * @param [in] port The port that is being moved. */ virtual void onMovePort(ConnectionEndpoint* port); @@ -151,16 +151,16 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled /*! * Checks if the item is a draft component. * - * @return True, if the component is a draft component, otherwise false. + * @return True, if the component is a draft component, otherwise false. */ bool isDraft() const; /*! * Create an ad hoc port item with the given name. * - * @param [in] portName The name of the ad hoc port item. + * @param [in] portName The name of the ad hoc port item. * - * @return The created ad hoc port item. + * @return The created ad hoc port item. */ virtual AdHocItem* createAdhocItem(QString const& portName); @@ -199,14 +199,14 @@ class HWComponentItem : public ComponentItem, public AdHocEnabled /*! * Show the selected ad hoc port item. * - * @param [in] portItem The selected port item. + * @param [in] portItem The selected port item. */ virtual void showAdhocPort(AdHocItem* portItem); /*! * Hide the selected ad hoc port item. * - * @param [in] portItem The selected port item. + * @param [in] portItem The selected port item. */ virtual void hideAdhocPort(AdHocItem* portItem); diff --git a/editors/HWDesign/HWConnection.h b/editors/HWDesign/HWConnection.h index 867431333..6ea557a28 100644 --- a/editors/HWDesign/HWConnection.h +++ b/editors/HWDesign/HWConnection.h @@ -37,11 +37,11 @@ class HWConnection : public ConnectionItem /*! * Constructor which creates an open-ended diagram interconnection. * - * @param [in] p1 The first end point. - * @param [in] dir1 Direction of the first end point. - * @param [in] p2 The second end point. - * @param [in] dir2 Direction of the second end point. - * @param [in] parent Owner of the connection item. + * @param [in] p1 The first end point. + * @param [in] dir1 Direction of the first end point. + * @param [in] p2 The second end point. + * @param [in] dir2 Direction of the second end point. + * @param [in] parent Owner of the connection item. */ HWConnection(QPointF const& p1, QVector2D const& dir1, QPointF const& p2, QVector2D const& dir2, DesignDiagram* parent); @@ -49,11 +49,11 @@ class HWConnection : public ConnectionItem /*! * Constructor. * - * @param [in] endpoint1 The first end point. - * @param [in] endpoint2 The second end point. - * @param [in] interconnection The contained interconnection. - * @param [in] route Route for the connection item. - * @param [in] parent Owner of the connection item. + * @param [in] endpoint1 The first end point. + * @param [in] endpoint2 The second end point. + * @param [in] interconnection The contained interconnection. + * @param [in] route Route for the connection item. + * @param [in] parent Owner of the connection item. */ HWConnection(ConnectionEndpoint* endpoint1, ConnectionEndpoint* endpoint2, QSharedPointer interconnection, QSharedPointer route, @@ -67,7 +67,7 @@ class HWConnection : public ConnectionItem /*! * Get the type of this connection. * - * @return HW connection. + * @return HW connection. */ int type() const final { return Type; } diff --git a/editors/HWDesign/HWConnectionEndpoint.h b/editors/HWDesign/HWConnectionEndpoint.h index 1f268301d..433cd19c1 100644 --- a/editors/HWDesign/HWConnectionEndpoint.h +++ b/editors/HWDesign/HWConnectionEndpoint.h @@ -44,10 +44,10 @@ class HWConnectionEndpoint : public ConnectionEndpoint /*! * Constructor. * - * @param [in] name Name of the end point. - * @param [in] containingComponent Component containing the end point item. - * @param [in] parent The parent graphics item. - * @param [in] dir The initial direction for the endpoint. + * @param [in] name Name of the end point. + * @param [in] containingComponent Component containing the end point item. + * @param [in] parent The parent graphics item. + * @param [in] dir The initial direction for the endpoint. */ HWConnectionEndpoint(QString const& name, QSharedPointer containingComponent, QGraphicsItem* parent = nullptr, QVector2D const& dir = QVector2D(0.0f, -1.0f)); @@ -71,7 +71,7 @@ class HWConnectionEndpoint : public ConnectionEndpoint /*! * Get the component containing this end point item. * - * @return The component containing this end point item. + * @return The component containing this end point item. */ virtual QSharedPointer getOwnerComponent() const; @@ -83,28 +83,28 @@ class HWConnectionEndpoint : public ConnectionEndpoint /*! * Set a new name for the connection end point. * - * @param [in] name The selected name. + * @param [in] name The selected name. */ void setName(QString const& name) override; /*! * Get the off page connector item. * - * @return the off page connector item. + * @return the off page connector item. */ virtual ConnectionEndpoint* getOffPageConnector() const; /*! * Check if the scene is locked. * - * @return True, if the scene is locked, false otherwise. + * @return True, if the scene is locked, false otherwise. */ bool sceneIsLocked() const; /*! * Get the component item containing this end point item. * - * @return The component item containing this end point item. + * @return The component item containing this end point item. */ ComponentItem* encompassingComp() const override; @@ -113,14 +113,14 @@ class HWConnectionEndpoint : public ConnectionEndpoint /*! * Get the label containing the name of this end point. * - * @return The name label. + * @return The name label. */ GraphicsItemLabel* getNameLabel() const; /*! * Handles the mouse move events. * - * @param [in] event The mouse move event. + * @param [in] event The mouse move event. */ void mouseMoveEvent(QGraphicsSceneMouseEvent *event) override; diff --git a/editors/HWDesign/HWDesignDiagram.h b/editors/HWDesign/HWDesignDiagram.h index a8553b837..647d16410 100644 --- a/editors/HWDesign/HWDesignDiagram.h +++ b/editors/HWDesign/HWDesignDiagram.h @@ -180,11 +180,11 @@ class HWDesignDiagram : public ComponentDesignDiagram /*! * The constructor. * - * @param [in] lh Enables access to the library. - * @param [in] editProvider The edit provider. - * @param [in] designAndInstancesParameterFinder Parameter finder for design parameter reference tree. - * @param [in] designParameterFinder Parameter finder for design parameters. - * @param [in] parent Owner of this diagram. + * @param [in] lh Enables access to the library. + * @param [in] editProvider The edit provider. + * @param [in] designAndInstancesParameterFinder Parameter finder for design parameter reference tree. + * @param [in] designParameterFinder Parameter finder for design parameters. + * @param [in] parent Owner of this diagram. */ HWDesignDiagram(LibraryInterface* lh, QSharedPointer editProvider, QSharedPointer designAndInstancesParameterFinder, @@ -214,22 +214,22 @@ class HWDesignDiagram : public ComponentDesignDiagram /*! * Load and insert the selected column to the graphics layout. * - * @param [in] description Column description of the selected column. + * @param [in] description Column description of the selected column. */ void loadColumn(QSharedPointer description); /*! * Adds a column to the diagram's layout. * - * @param [in] desc The column description. + * @param [in] desc The column description. */ void addColumn(QSharedPointer desc); /*! * Called when a port's ad-hoc visibility has been changed. * - * @param [in] portName The name of the port. - * @param [in] visible The new ad-hoc visibility. + * @param [in] portName The name of the port. + * @param [in] visible The new ad-hoc visibility. */ virtual void onAdHocVisibilityChanged(QString const& portName, bool visible); @@ -242,7 +242,7 @@ class HWDesignDiagram : public ComponentDesignDiagram * Returns the bus interface item of the corresponding design component bus interface with the given name * or nullptr if not found. * - * @param [in] busRef The interface name. + * @param [in] busRef The interface name. * * @return The hierarchical bus interface item found or null. */ @@ -251,7 +251,7 @@ class HWDesignDiagram : public ComponentDesignDiagram /*! * Sets the value of the flag indicating if interfaces have been deleted in the design diagram. * - * @param [in] haveBeenDeleted Flag value to set. + * @param [in] haveBeenDeleted Flag value to set. */ void setInterfacesHaveBeenDeleted(); @@ -270,7 +270,7 @@ public slots: /*! * Paste hierarchical interfaces. * - * @param [in] mimeData The data containing the pasted items. + * @param [in] mimeData The data containing the pasted items. */ void pasteHierarchicalInterfaces(QMimeData const* mimeData); @@ -287,7 +287,7 @@ public slots: /*! * Paste interfaces to a draft component. * - * @param [in] targetItem The component item to paste interfaces into. + * @param [in] targetItem The component item to paste interfaces into. */ void pasteInterfacesToDraftComponent(HWComponentItem* targetItem); @@ -301,8 +301,8 @@ public slots: /*! * Opens a design for a given component. * - * @param [in] component The component whose design to open. - * @param [in] viewName The name of the view to open. + * @param [in] component The component whose design to open. + * @param [in] viewName The name of the view to open. */ virtual void openDesignForComponent(ComponentItem* component, QString const& viewName) override; @@ -321,25 +321,25 @@ public slots: /*! * Set the interface VLNV at an end point. * - * @param [in] droppedVLNV The selected VLNV. + * @param [in] droppedVLNV The selected VLNV. */ void setInterfaceVLNVatEndpoint(VLNV const& droppedVLNV); /*! * Replace the component item at the selected position. * - * @param [in] position The position of the replaced component item. - * @param [in] component The component to replace the item at position. + * @param [in] position The position of the replaced component item. + * @param [in] component The component to replace the item at position. */ void replaceComponentItemAtPositionWith(QPointF position, QSharedPointer component); /*! * Create a new component item. * - * @param [in] comp The selected component. - * @param [in] instanceName The name of the instance to create. - * @param [in] position Position of the new component item. - * @param [in] parentCommand Parent undo command for item creation. + * @param [in] comp The selected component. + * @param [in] instanceName The name of the instance to create. + * @param [in] position Position of the new component item. + * @param [in] parentCommand Parent undo command for item creation. */ HWComponentItem* createComponentItem(QSharedPointer comp, QString const& instanceName, QPointF position, QUndoCommand* parentCommand); @@ -350,83 +350,83 @@ public slots: /*! * Checks if open component action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool openComponentActionEnabled() const override; /*! * Check if the selected items are of a type used in the HW design. * - * @return True, if the items are used in HW design, false otherwise. + * @return True, if the items are used in HW design, false otherwise. */ virtual bool selectedItemIsCorrectType() const override; /*! * Checks if the given item is a hierarchical component. * - * @param [in] item The item to check. + * @param [in] item The item to check. * - * @return True, if item is a hierarchical component, otherwise false. + * @return True, if item is a hierarchical component, otherwise false. */ virtual bool isHierarchicalComponent(QGraphicsItem* item) const override; /*! * Checks if copy action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool copyActionEnabled() const override; /*! * Checks if paste action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool pasteActionEnabled() const override; /*! * Opens the given component according to the active view of the component. * - * @param [in] comp The component to open. + * @param [in] comp The component to open. */ void openComponentByActiveView(ComponentItem * comp); /*! * Gets the names of hierarchical views of a component. * - * @param [in] component The component whose hierarchical views to get. + * @param [in] component The component whose hierarchical views to get. * - * @return The names of the hierarchical views. + * @return The names of the hierarchical views. */ virtual QStringList hierarchicalViewsOf(ComponentItem* component) const override; /*! * Gets the graphics item type of the components in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int componentType() const; /*! * Gets the graphics item type of the off page connectors in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int offpageConnectorType() const; /*! * Gets the graphics item type of the connections in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int connectionType() const; /*! * Create an ad hoc interface item with the selected name. * - * @param [in] portName The name of the new ad hoc interface item. + * @param [in] portName The name of the new ad hoc interface item. * - * @return The created ad hoc interface item. + * @return The created ad hoc interface item. */ virtual AdHocItem* createAdhocItem(QString const& portName) override; @@ -439,10 +439,10 @@ public slots: * Finds the design extension for a hierarchical bus interface item. If the extension does not exist, * it is created. * - * @param [in] design The design to search extensions in. - * @param [in] busInterfaceName The name of the bus interface to search for. + * @param [in] design The design to search extensions in. + * @param [in] busInterfaceName The name of the bus interface to search for. * - * @return The extension for hierarchical bus interface data. + * @return The extension for hierarchical bus interface data. */ QSharedPointer findOrCreateInterfaceExtensionGroup(QSharedPointer design, QString const& busInterfaceName); @@ -450,50 +450,50 @@ public slots: /*! * Called when an item has been selected in the diagram. * - * @param [in] newSelection The selected item. + * @param [in] newSelection The selected item. */ virtual void onSelected(QGraphicsItem* newSelection); /*! * Creates a connection between the given two endpoints. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending connection end point. - * @param [in] isOffPage Determines if connection to be created is off-page or not. + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending connection end point. + * @param [in] isOffPage Determines if connection to be created is off-page or not. * - * @return The created connection. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint, bool isOffPage = false); /*! * Creates a connection between the given endpoint and a coordinate point. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending coordinate point. + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending coordinate point. * - * @return The created connection. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, QPointF const& endPoint); /*! * Creates an add command for a given connection. * - * @param [in] connection The connection to create a command for. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created commands. + * @param [in] connection The connection to create a command for. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created commands. * - * @return The created add command. + * @return The created add command. */ virtual QUndoCommand* createAddCommandForConnection(GraphicsConnection* connection, QUndoCommand* parentCommand = nullptr); /*! * Copies the interface definition to hierarchical interface from a defined interface. * - * @param [in] definedPoint The interface item to copy definitions from. - * @param [in] undefinedPoint The interface item to copy definitions into. - * @param [in] definingConnection The connection between the points initiating the copy. - * @param [in] parentCommand The parent undo command. + * @param [in] definedPoint The interface item to copy definitions from. + * @param [in] undefinedPoint The interface item to copy definitions into. + * @param [in] definingConnection The connection between the points initiating the copy. + * @param [in] parentCommand The parent undo command. * - * @return True, if the copy was accepted by the user, otherwise false. + * @return True, if the copy was accepted by the user, otherwise false. */ bool copyDefinitions(ConnectionEndpoint* definedPoint, ConnectionEndpoint* undefinedPoint, HWConnection* definingConnection, QUndoCommand* parentCommand); @@ -501,19 +501,19 @@ public slots: /*! * Checks if the given bus interface item has a default name. * - * @param [in] connectionPoint The bus interface item to check. + * @param [in] connectionPoint The bus interface item to check. * - * @return True, if the name is default pattern, otherwise false. + * @return True, if the name is default pattern, otherwise false. */ bool hasDefaultName(ConnectionEndpoint const* undefinedPoint) const; /*! * Copies the interface name to hierarchical interface from a defined interface. * - * @param [in] sourceInterface The interface item to copy name from. - * @param [in] targetInterface The interface item to copy the name into. - * @param [in] definingConnection The connection between the points initiating the copy. - * @param [in] parentCommand The parent undo command. + * @param [in] sourceInterface The interface item to copy name from. + * @param [in] targetInterface The interface item to copy the name into. + * @param [in] definingConnection The connection between the points initiating the copy. + * @param [in] parentCommand The parent undo command. */ void copyInterfaceName(ConnectionEndpoint* sourceInterface, ConnectionEndpoint* targetInterface, HWConnection* definingConnection, QUndoCommand* parentCommand); @@ -521,10 +521,10 @@ public slots: /*! * Finds the hierInterfaces corresponding to the given interface name. * - * @param [in] previousName The name to search for. - * @param [in] connection The interconnection to search in. + * @param [in] previousName The name to search for. + * @param [in] connection The interconnection to search in. * - * @return The hierInterfaces with the given name. + * @return The hierInterfaces with the given name. */ QList > findInterfacesByName(QString const& previousName, QSharedPointer connection) const; @@ -532,9 +532,9 @@ public slots: /*! * Copies the interface mode to hierarchical interface from a defined interface. * - * @param [in] sourceInterface The interface item to copy mode from. - * @param [in] targetInterface The interface item to copy mode into. - * @param [in] parentCommand The parent undo command. + * @param [in] sourceInterface The interface item to copy mode from. + * @param [in] targetInterface The interface item to copy mode into. + * @param [in] parentCommand The parent undo command. */ void copyMode(ConnectionEndpoint* sourceInterface, ConnectionEndpoint* targetInterface, QUndoCommand* parentCommand); @@ -542,20 +542,20 @@ public slots: /*! * Copies the interface type to hierarchical interface from a defined interface. * - * @param [in] definedPoint The interface item to copy type from. - * @param [in] draftPoint The interface item to copy type into. - * @param [in] parentCommand The parent undo command. + * @param [in] definedPoint The interface item to copy type from. + * @param [in] draftPoint The interface item to copy type into. + * @param [in] parentCommand The parent undo command. */ void copyType(ConnectionEndpoint* definedPoint, ConnectionEndpoint* draftPoint, QUndoCommand* parentCommand); /*! * Copies the port maps and ports into a hierarchical bus interface. * - * @param [in] sourcePoint The interface item to copy from. - * @param [in] targetPoint The interface item to copy into. - * @param [in] parentCommand The parent undo command. + * @param [in] sourcePoint The interface item to copy from. + * @param [in] targetPoint The interface item to copy into. + * @param [in] parentCommand The parent undo command. * - * @return True, if the copy was accepted by the user, otherwise false. + * @return True, if the copy was accepted by the user, otherwise false. */ bool copyPortsAndMapsForHierarchicalPoint(ConnectionEndpoint* sourcePoint, ConnectionEndpoint* targetPoint, QUndoCommand* parentCommand); @@ -563,11 +563,11 @@ public slots: /*! * Copies port and port maps from the given bus interface into a bus interface item. * - * @param [in] sourceComponent The component containing the bus interface to copy from. - * @param [in] sourceInterface The bus interface to copy from. - * @param [in] sourceInstanceItem The item containing the copied end point. - * @param [in] target The bus interface item to copy into. - * @param [in] parentCommand The parent undo command. + * @param [in] sourceComponent The component containing the bus interface to copy from. + * @param [in] sourceInterface The bus interface to copy from. + * @param [in] sourceInstanceItem The item containing the copied end point. + * @param [in] target The bus interface item to copy into. + * @param [in] parentCommand The parent undo command. */ void copyPortMapsAndPhysicalPorts(QSharedPointer sourceComponent, QSharedPointer sourceInterface, ComponentItem* sourceInstanceItem, @@ -576,11 +576,11 @@ public slots: /*! * Creates a connecting port for opposing the given port. * - * @param [in] sourcePort The port whose opposing port to create. - * @param [in] portDirection The port direction for the created port. - * @param [in] reservedNames The names of existing ports in the target component. + * @param [in] sourcePort The port whose opposing port to create. + * @param [in] portDirection The port direction for the created port. + * @param [in] reservedNames The names of existing ports in the target component. * - * @return The newly created port matching the source port in size and type. + * @return The newly created port matching the source port in size and type. */ QSharedPointer createConnectingPhysicalPort(QSharedPointer sourcePort, DirectionTypes::Direction portDirection, QStringList const& reservedNames); @@ -588,11 +588,11 @@ public slots: /*! * Creates the port maps for hierarchical interface by user selection. * - * @param [in] sourcePoint The bus interface whose mode and definitions to use as a starting point. - * @param [in] targetPoint The interface whose port maps to create. - * @param [in] parentCommand The parent undo command. + * @param [in] sourcePoint The bus interface whose mode and definitions to use as a starting point. + * @param [in] targetPoint The interface whose port maps to create. + * @param [in] parentCommand The parent undo command. * - * @return True, if the selection was accepted by the user, otherwise false. + * @return True, if the selection was accepted by the user, otherwise false. */ bool createPortMapsManually(ConnectionEndpoint* sourcePoint, ConnectionEndpoint* targetPoint, QUndoCommand* parentCommand); @@ -600,9 +600,9 @@ public slots: /*! * Adds a new interface to the given diagram column. * - * @param [in] column The column where to add the interface. - * @param [in] pos The interface position. - * @param [in] isDraft Determines if Bus Interface is draft or not. + * @param [in] column The column where to add the interface. + * @param [in] pos The interface position. + * @param [in] isDraft Determines if Bus Interface is draft or not. */ virtual void addTopLevelInterface(GraphicsColumn* column, QPointF const& pos, bool isDraft); @@ -610,60 +610,60 @@ public slots: * Handler for draft tool clicks. Creates a draft component instance or a draft interface according to the * clicked position. * - * @param [in] clickedPosition The position to create the draft item to. + * @param [in] clickedPosition The position to create the draft item to. */ virtual void draftAt(QPointF const& clickedPosition); /*! * Finds the item types for the given column. If the types are ambiguous, asks the user for types. * - * @param [in] column The column to find the types for. + * @param [in] column The column to find the types for. * - * @return The column types. + * @return The column types. */ unsigned int findColumnItemType(GraphicsColumn* column) const; /*! * Adds a draft component instance to the design. * - * @param [in] column The column to add the instance to. - * @param [in] position The initial position to add the instance at. + * @param [in] column The column to add the instance to. + * @param [in] position The initial position to add the instance at. */ void addDraftComponentInstance(GraphicsColumn* column, QPointF const& position); /*! * Adds a draft interface in a draft component instance. * - * @param [in] targetComponent The component item to add the interface to. - * @param [in] position The initial position of the interface. + * @param [in] targetComponent The component item to add the interface to. + * @param [in] position The initial position of the interface. */ void addDraftComponentInterface(HWComponentItem* targetComponent, QPointF const& position); /*! * Performs the replacing of destination component with source component. * - * @param [in] destComp The component to replace. - * @param [in] sourceComp The replacing component. + * @param [in] destComp The component to replace. + * @param [in] sourceComp The replacing component. */ virtual void replace(ComponentItem* destComp, ComponentItem* sourceComp); /*! * Creates a graphics item for component instance and adds it to the diagram. * - * @param [in] instance The instance to create item for. - * @param [in] design The design containing the instance. + * @param [in] instance The instance to create item for. + * @param [in] design The design containing the instance. */ void createComponentItem(QSharedPointer instance, QSharedPointer design); /*! * Finds a port item on a component item or creates one if not found. * - * @param [in] componentItem The component graphic item containing the port. - * @param [in] componentRef The reference name for the component. - * @param [in] busRef The reference name for the bus interface. - * @param [in] design The design containing the component instance. + * @param [in] componentItem The component graphic item containing the port. + * @param [in] componentRef The reference name for the component. + * @param [in] busRef The reference name for the bus interface. + * @param [in] design The design containing the component instance. * - * @return The port item on the component. + * @return The port item on the component. */ ConnectionEndpoint* findOrCreateMissingInterface(HWComponentItem* componentItem, QString const& componentRef, QString const& busRef, QSharedPointer design); @@ -671,11 +671,11 @@ public slots: /*! * Creates a missing port to the given component item. * - * @param [in] portName The name of the port to create. - * @param [in] component The parent component. - * @param [in] design The design containing related information. + * @param [in] portName The name of the port to create. + * @param [in] component The parent component. + * @param [in] design The design containing related information. * - * @return A port item for a missing port. + * @return A port item for a missing port. */ ActiveBusInterfaceItem* createMissingBusInterface(QString const& interfaceName, HWComponentItem* containingComponent, QSharedPointer design); @@ -683,31 +683,31 @@ public slots: /*! * Creates a graphics item for interconnection and adds it to the diagram. * - * @param [in] interconnection The interconnection to create item for. - * @param [in] design The design containing the interconnection. + * @param [in] interconnection The interconnection to create item for. + * @param [in] design The design containing the interconnection. */ void createInterconnection(QSharedPointer interconnection, QSharedPointer design); /*! * Create an interconnection between components. * - * @param [in] interconnection The selected interconnection. - * @param [in] design The design in which to create the interconnection. + * @param [in] interconnection The selected interconnection. + * @param [in] design The design in which to create the interconnection. */ void createInterconnectionBetweenComponents(QSharedPointer interconnection, QSharedPointer design); /*! * Find or create a route for the interconnection. * - * @param [in] interconnectionName The name of the interconnection. + * @param [in] interconnectionName The name of the interconnection. */ QSharedPointer findOrCreateRouteForInterconnection(QString const& interconnectionName); /*! * Creates a graphics item for hierarchical interconnection and adds it to the diagram. * - * @param [in] hierConn The hierarchical interconnection to create item for. - * @param [in] design The design containing the interconnection. + * @param [in] hierConn The hierarchical interconnection to create item for. + * @param [in] design The design containing the interconnection. */ void createHierarchicalConnection(QSharedPointer connection, QSharedPointer design); @@ -715,25 +715,25 @@ public slots: /*! * Find or create a hierarchical interface. * - * @param [in] busRef The name of the interface. + * @param [in] busRef The name of the interface. */ ConnectionEndpoint* findOrCreateHierarchicalInterface(QString const& busRef); /*! * Creates the hierarchical ad-hoc port items in the diagram. * - * @param [in] design The design containing the ad-hoc ports. + * @param [in] design The design containing the ad-hoc ports. */ void createHierachicalAdHocPorts(QSharedPointer design); /*! * Create a missing hierarchical ad hoc port. * - * @param [in] portName The name of the missing port. - * @param [in] adHocExtension The extension containing information of the port. - * @param [in] parentItem The parent item of the missing ad hoc port. + * @param [in] portName The name of the missing port. + * @param [in] adHocExtension The extension containing information of the port. + * @param [in] parentItem The parent item of the missing ad hoc port. * - * @return The interface item for the missing interface. + * @return The interface item for the missing interface. */ HierarchicalPortItem* createMissingHierarchicalAdHocPort(QString const& portName, QSharedPointer adHocExtension, QGraphicsItem* parentItem = (QGraphicsItem*)0); @@ -741,32 +741,32 @@ public slots: /*! * Creates a graphics item for an ad-hoc interconnection and adds it to the diagram. * - * @param [in] adHocConn The ad-hoc connection to create the item for. + * @param [in] adHocConn The ad-hoc connection to create the item for. */ void createAdHocConnection(QSharedPointer adHocConnection); /*! * Finds the graphical item for the given port reference. * - * @param [in] portReference The port reference whose graphical item to find. + * @param [in] portReference The port reference whose graphical item to find. * - * @return The port item or 0 if port cannot be found. + * @return The port item or 0 if port cannot be found. */ ActivePortItem* findAdhocPort(QSharedPointer portReference); /*! * Create a symbol for an ad hoc tie off value. * - * @param [in] connection The selected ad hoc connection. + * @param [in] connection The selected ad hoc connection. */ void createAdHocTieOffConnection(QSharedPointer connection); /*! * Creates a graphics item for an ad-hoc interconnection between two ports and adds it to the diagram. * - * @param [in] adHocConnection The ad-hoc connection containing the ports. - * @param [in] secondaryPort The connected internal/hierarchical port. - * @param [in] primaryPortItem The port item for the primary port. + * @param [in] adHocConnection The ad-hoc connection containing the ports. + * @param [in] secondaryPort The connected internal/hierarchical port. + * @param [in] primaryPortItem The port item for the primary port. */ void createConnectionForAdHocPorts(QSharedPointer adHocConnection, QSharedPointer secondaryPort, @@ -774,25 +774,25 @@ public slots: /*! * Copies component instances in a format which can be saved to clipboard. * - * @param [in] items The top-level bus interface instance items to copy. - * @param [out] collection The resulted collection of bus interface instance copy data. + * @param [in] items The top-level bus interface instance items to copy. + * @param [out] collection The resulted collection of bus interface instance copy data. */ void copyInterfaces(QList const& items, BusInterfaceCollectionCopyData &collection); /*! * Copies component instances in a format which can be saved to clipboard. * - * @param [in] items The component instance items to copy. - * @param [out] collection The resulted collection of component instance copy data. + * @param [in] items The component instance items to copy. + * @param [out] collection The resulted collection of component instance copy data. */ void copyInstances(QList const& items, ComponentCollectionCopyData &collection); /*! * Pastes bus port instances from a copy data collection. * - * @param [in] collection The collection of bus port instance copy data. - * @param [in] component The component where to place the ports. - * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] collection The collection of bus port instance copy data. + * @param [in] component The component where to place the ports. + * @param [in] cmd The parent undo command for the paste undo commands. */ void pasteInterfaces(BusInterfaceCollectionCopyData const& collection, HWComponentItem* component, QUndoCommand* cmd); @@ -800,10 +800,10 @@ public slots: /*! * Pastes top-level bus interface instances from a copy data collection. * - * @param [in] collection The collection of bus interface instance copy data. - * @param [in] column The column where to place the instances. - * @param [in] cmd The parent undo command for the paste undo commands. - * @param [in] userCursorPos If true, the instances are placed close to the cursor position. + * @param [in] collection The collection of bus interface instance copy data. + * @param [in] column The column where to place the instances. + * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] userCursorPos If true, the instances are placed close to the cursor position. * Otherwise the original positions are used. */ void pasteTopLevelInterfaces(BusInterfaceCollectionCopyData const& collection, GraphicsColumn* column, @@ -812,10 +812,10 @@ public slots: /*! * Creates paste command for component instances from a copy data collection. * - * @param [in] collection The collection of component instance copy data. - * @param [in] column The column where to place the instances. - * @param [in] cmd The parent undo command for the paste undo commands. - * @param [in] userCursorPos If true, the instances are placed close to the cursor position. + * @param [in] collection The collection of component instance copy data. + * @param [in] column The column where to place the instances. + * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] userCursorPos If true, the instances are placed close to the cursor position. * Otherwise the original positions are used. */ void createComponentPasteCommand(ComponentCollectionCopyData const& collection, GraphicsColumn* column, @@ -824,40 +824,40 @@ public slots: /*! * Show the selected hoc port item. * - * @param [in] portItem The selected ad hoc port item. + * @param [in] portItem The selected ad hoc port item. */ virtual void showAdhocPort(AdHocItem* portItem); /*! * Hide the selected hoc port item. * - * @param [in] portItem The selected ad hoc port item. + * @param [in] portItem The selected ad hoc port item. */ virtual void hideAdhocPort(AdHocItem* portItem); /*! * Generates a unique name. * - * @param [in] name The base for the name. - * @param [in] reservedNames The existing names that should not be generated. + * @param [in] name The base for the name. + * @param [in] reservedNames The existing names that should not be generated. * - * @return A unique name. + * @return A unique name. */ QString generateUniqueName(QString const& name, QStringList const& reservedNames) const; /*! * Finds the name of hierarchical interfaces in the design. * - * @return The names of the hierarchical interfaces. + * @return The names of the hierarchical interfaces. */ QStringList getTopLevelInterfaceNames() const; /*! * Check if the design parameter reference finder contains a component finder for the selected component. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return True, if the design parameter reference finder contains the selected component, otherwise + * @return True, if the design parameter reference finder contains the selected component, otherwise * false. */ bool referenceFinderContainsComponent(QSharedPointer component); @@ -865,54 +865,54 @@ public slots: /*! * Create auto connection dialog. * - * @param [in] firstItem The first item for the auto connector. + * @param [in] firstItem The first item for the auto connector. * - * @return The auto connector dialog. + * @return The auto connector dialog. */ virtual ComponentItemAutoConnector* createAutoConnector(ComponentItem* firstItem) const; /*! * Get the connection end point for the selected auto connector item. * - * @param [in] connectorItem The selected auto connector item. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. + * @param [in] connectorItem The selected auto connector item. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. * - * @return The end point item for the selected auto connector item. + * @return The end point item for the selected auto connector item. */ virtual ConnectionEndpoint* getEndPointForItem(AutoConnectorItem* connectorItem, QUndoCommand* parentUndoCommand = nullptr); /*! * Get the component item connection end point for the selected auto connector item. * - * @param [in] connectorItem The selected auto connector item. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. + * @param [in] connectorItem The selected auto connector item. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. * - * @return The selected component item connection end point. + * @return The selected component item connection end point. */ ConnectionEndpoint* getEndPointFromComponentItem(AutoConnectorItem* connectorItem, QUndoCommand* parentUndoCommand = nullptr); /*! * Get the top component connection end point for the selected auto connector item. * - * @param [in] connectorItem The selected auto connector item. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. + * @param [in] connectorItem The selected auto connector item. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. * - * @return The selected top component connection end point. + * @return The selected top component connection end point. */ ConnectionEndpoint* getEndPointForTopComponentItem(AutoConnectorItem* connectorItem, QUndoCommand* parentUndoCommand = nullptr); /*! * Create connection between the selected end points. * - * @param [in] startPoint Start point for the connection. - * @param [in] endPoint End point for the connection. + * @param [in] startPoint Start point for the connection. + * @param [in] endPoint End point for the connection. */ virtual void createConnectionBetweenEndPoints(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint); /*! * Check if the auto connector should be added to the context menu. * - * @return True, if the auto connected should be added, false otherwise. + * @return True, if the auto connected should be added, false otherwise. */ virtual bool addAutoConnectorActionToContextMenu() const; diff --git a/editors/HWDesign/HWDesignWidget.h b/editors/HWDesign/HWDesignWidget.h index 6524784de..8991cc1fb 100644 --- a/editors/HWDesign/HWDesignWidget.h +++ b/editors/HWDesign/HWDesignWidget.h @@ -43,10 +43,10 @@ class HWDesignWidget : public DesignWidget /*! * The constructor. * - * @param [in] lh The library interface. - * @param [in] designAndInstancesParameterFinder Parameter finder for design parameter reference tree. - * @param [in] designParameterFinder Design parameter finder. - * @param [in] parent Owner of this object. + * @param [in] lh The library interface. + * @param [in] designAndInstancesParameterFinder Parameter finder for design parameter reference tree. + * @param [in] designParameterFinder Design parameter finder. + * @param [in] parent Owner of this object. */ HWDesignWidget(LibraryInterface *lh, QSharedPointer designAndIsntancesParameterFinder, QSharedPointer designParameterFinder, QWidget *parent = 0); @@ -63,8 +63,8 @@ class HWDesignWidget : public DesignWidget /*! * Set the design to be displayed in the block diagram * - * @param [in] vlnv VLNV of the design to open - * @param [in] viewName Name of the view to open within component. + * @param [in] vlnv VLNV of the design to open + * @param [in] viewName Name of the view to open within component. */ bool setDesign(VLNV const& vlnv, QString const& viewName) final; @@ -88,7 +88,7 @@ class HWDesignWidget : public DesignWidget /*! * Emitted when user wants to refresh this widget * - * @param [in] designWidget Pointer to this HWDesignWidget instance + * @param [in] designWidget Pointer to this HWDesignWidget instance */ void refresh(const HWDesignWidget* designWidget); @@ -107,7 +107,7 @@ public slots: /*! * Handler for key press event. * - * @param [in] event The selected key event. + * @param [in] event The selected key event. */ void keyPressEvent(QKeyEvent *event); @@ -117,90 +117,90 @@ public slots: /*! * Delete the selected component items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedComponentItems(QList selectedItems); /*! * Delete the selected bus interface items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedBusInterfaceItems(QList selectedItems); /*! * Delete the selected bus port items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedBusPortItems(QList selectedItems); /*! * Delete the selected HW connection items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedHWConnectionItems(QList selectedItems); /*! * Delete the selected ad hoc connection items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedAdHocConnectionItems(QList selectedItems); /*! * Delete the selected HW column items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedHWColumns(QList selectedItems); /*! * Delete the selected ad hoc interface items. Only invalid interfaces can be deleted. * - * @param [in] selectedItems A list of the selected items. + * @param [in] selectedItems A list of the selected items. */ void deleteSelectedAdhocInterfaces(QList selectedItems); /*! * Delete the selected ad hoc port items. Only invalid ports can be deleted. * - * @param [in] selectedItems A list of the selected items. + * @param [in] selectedItems A list of the selected items. */ void deleteSelectedAdHocPorts(QList selectedItems); /*! * Create an empty hierarchical component. * - * @return Pointer to the created component. + * @return Pointer to the created component. */ QSharedPointer createEmptyDesign(VLNV const& prevlnv); /*! * Set a design to be edited. * - * @param [in] comp The selected component. - * @param [in] viewName The name of the view containing the design. + * @param [in] comp The selected component. + * @param [in] viewName The name of the view containing the design. * - * @return True, if the design is set correctly, false if an error occurred. + * @return True, if the design is set correctly, false if an error occurred. */ bool setDesign(QSharedPointer comp, const QString& viewName); /*! * Create an empty design and configuration for a component. * - * @param [in] component Pointer to the component to create the design for. - * @param [in] dirPath File path to the directory to create the design and configuration to. + * @param [in] component Pointer to the component to create the design for. + * @param [in] dirPath File path to the directory to create the design and configuration to. */ void createDesignForComponent(QSharedPointer component, const QString& dirPath); /*! * Update the files. * - * @param [in] topComponent The top component of the design. - * @param [in] sourcePath The source path. - * @param [in] targetPath The target directory. + * @param [in] topComponent The top component of the design. + * @param [in] sourcePath The source path. + * @param [in] targetPath The target directory. */ void updateFiles(QSharedPointer topComponent, QString const& sourcePath, QString const& targetPath) const; @@ -213,14 +213,14 @@ public slots: /*! * Load bus interface changes made in the component editor. Checks for removed and added bus interfaces. * - * @param [in] libraryComponent The component loaded from disk. + * @param [in] libraryComponent The component loaded from disk. */ void loadBusInterfaceChanges(QSharedPointer libraryComponent); /*! * Load adhoc port changes made in the component editor. Checks for removed and added ports. * - * @param [in] libraryComponent The component loaded from disk. + * @param [in] libraryComponent The component loaded from disk. */ void loadPortChanges(QSharedPointer libraryComponent); diff --git a/editors/HWDesign/HWMoveCommands.h b/editors/HWDesign/HWMoveCommands.h index 6ffda72ae..0743e32e5 100644 --- a/editors/HWDesign/HWMoveCommands.h +++ b/editors/HWDesign/HWMoveCommands.h @@ -32,10 +32,10 @@ class PortMoveCommand : public QUndoCommand /*! * Constructor which assumes that the port has already been moved to its new position. * - * @param [in] port The port to move. - * @param [in] oldPos The port's old position. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] port The port to move. + * @param [in] oldPos The port's old position. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ PortMoveCommand(HWConnectionEndpoint* port, QPointF const& oldPos, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -43,11 +43,11 @@ class PortMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] port The port to move. - * @param [in] oldPos The port's old position. - * @param [in] newPos The port's new position. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] port The port to move. + * @param [in] oldPos The port's old position. + * @param [in] newPos The port's new position. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ PortMoveCommand(HWConnectionEndpoint* port, QPointF const& oldPos, QPointF const& newPos, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/HierarchicalBusInterfaceItem.h b/editors/HWDesign/HierarchicalBusInterfaceItem.h index 79addcd69..f36b7d363 100644 --- a/editors/HWDesign/HierarchicalBusInterfaceItem.h +++ b/editors/HWDesign/HierarchicalBusInterfaceItem.h @@ -43,12 +43,12 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * The constructor. * - * @param [in] component The component containing the bus interface this item represents. - * @param [in] busIf The bus interface this item represents. - * @param [in] dataGroup The container for the item data. - * @param [in] library Access to the library. - * @param [in] parent The parent object. - * @param [in] isDraft Determines if Bus Interface is draft or not. + * @param [in] component The component containing the bus interface this item represents. + * @param [in] busIf The bus interface this item represents. + * @param [in] dataGroup The container for the item data. + * @param [in] library Access to the library. + * @param [in] parent The parent object. + * @param [in] isDraft Determines if Bus Interface is draft or not. */ HierarchicalBusInterfaceItem(QSharedPointer component, QSharedPointer busIf, QSharedPointer dataGroup, LibraryInterface* library, QGraphicsItem *parent = 0, bool isDraft=false); @@ -65,7 +65,7 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Get the graphics item type of this item. * - * @return The graphics item type of this item. + * @return The graphics item type of this item. */ int type() const final { return Type; } @@ -81,7 +81,7 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Set the direction for the bus interface item. * - * @param [in] dir The new direction. + * @param [in] dir The new direction. */ void setDirection(QVector2D const& dir); @@ -93,7 +93,7 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Gets the data extension for the bus interface. * - * @return The data vendor extension. + * @return The data vendor extension. */ QSharedPointer getDataExtension() const; @@ -102,15 +102,15 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Notifies item state changes. * - * @param [in] change The change. - * @param [in] value The new value. + * @param [in] change The change. + * @param [in] value The new value. */ QVariant itemChange(GraphicsItemChange change, QVariant const& value) final; /*! * Event for mouse press. * - * @param [in] event The pressed mouse button. + * @param [in] event The pressed mouse button. */ void mousePressEvent(QGraphicsSceneMouseEvent *event) final; @@ -119,8 +119,8 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Update the name change to the relevant contained variables. * - * @param [in] previousName The previous name of the bus interface. - * @param [in] newName The new name of the bus interface. + * @param [in] previousName The previous name of the bus interface. + * @param [in] newName The new name of the bus interface. */ void updateName(QString const& previousName, QString const& newName) final; @@ -132,19 +132,19 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Create a move command for this end point item. * - * @param [in] diagram The containing design diagram. + * @param [in] diagram The containing design diagram. * - * @return The created move command. + * @return The created move command. */ QSharedPointer createMouseMoveCommand(DesignDiagram* diagram) final; /*! * Create move command for an end point that has been moved by the movement of this end point. * - * @param [in] endPoint The selected end point. - * @param [in] endPointPosition The new position of the end point. - * @param [in] diagram Design diagram containing the end point. - * @param [in] parentCommand Parent command. + * @param [in] endPoint The selected end point. + * @param [in] endPointPosition The new position of the end point. + * @param [in] diagram Design diagram containing the end point. + * @param [in] parentCommand Parent command. */ void createMoveCommandForClashedItem(ConnectionEndpoint* endPoint, QPointF endPointPosition, DesignDiagram* diagram, QSharedPointer parentCommand) final; @@ -152,16 +152,16 @@ class HierarchicalBusInterfaceItem : public BusInterfaceEndPoint /*! * Check if a connection can be made to the selected connection end point. * - * @param [in] otherEndPoint The selected connection end point. + * @param [in] otherEndPoint The selected connection end point. * - * @return True, if the connection can be made, false otherwise. + * @return True, if the connection can be made, false otherwise. */ bool canConnectToInterface(ConnectionEndpoint const* otherEndPoint) const final; /*! * Get the current position of the end point. * - * @return The current position of the end point. + * @return The current position of the end point. */ QPointF getCurrentPosition() const final; diff --git a/editors/HWDesign/HierarchicalPortItem.h b/editors/HWDesign/HierarchicalPortItem.h index ccd5f345a..cc26dd01f 100644 --- a/editors/HWDesign/HierarchicalPortItem.h +++ b/editors/HWDesign/HierarchicalPortItem.h @@ -37,10 +37,10 @@ class HierarchicalPortItem : public AdHocItem /*! * The constructor. * - * @param [in] component The component containing the ad hoc port. - * @param [in] port The selected port. - * @param [in] dataGroup The visibility data group of the item. - * @param [in] parent The owner of this item. + * @param [in] component The component containing the ad hoc port. + * @param [in] port The selected port. + * @param [in] dataGroup The visibility data group of the item. + * @param [in] parent The owner of this item. */ HierarchicalPortItem(QSharedPointer component, QSharedPointer port, QSharedPointer dataGroup, QGraphicsItem* parent = 0); @@ -53,7 +53,7 @@ class HierarchicalPortItem : public AdHocItem /*! * Get the type of this graphics item. * - * @return AdHoc interface item type. + * @return AdHoc interface item type. */ int type() const { return Type; } @@ -69,7 +69,7 @@ class HierarchicalPortItem : public AdHocItem /*! * Set the direction for this ad hoc interface item. * - * @param [in] dir The new item direction. + * @param [in] dir The new item direction. */ void setDirection(QVector2D const& dir); @@ -86,14 +86,14 @@ class HierarchicalPortItem : public AdHocItem /*! * Get the visibility data group of the item. * - * @return The visibility data group of the item. + * @return The visibility data group of the item. */ QSharedPointer getDataGroup() const; /*! * Set a new visibility and position data group. * - * @param [in] newDataGroup The new visibility and position data group. + * @param [in] newDataGroup The new visibility and position data group. */ void setDataGroup(QSharedPointer newDataGroup); @@ -102,15 +102,15 @@ class HierarchicalPortItem : public AdHocItem /*! * Notifies item state changes. * - * @param [in] change The change. - * @param [in] value The new value. + * @param [in] change The change. + * @param [in] value The new value. */ QVariant itemChange(GraphicsItemChange change, QVariant const& value) final; /*! * Event for mouse button release. * - * @param [in] event The release event. + * @param [in] event The release event. */ void mouseReleaseEvent(QGraphicsSceneMouseEvent *event) final; @@ -119,7 +119,7 @@ class HierarchicalPortItem : public AdHocItem /*! * Check whether the label should be drawn on the left side of the interface. * - * @return True, if the label should be drawn to the left side. + * @return True, if the label should be drawn to the left side. */ bool labelShouldBeDrawnLeft() const final; diff --git a/editors/HWDesign/OffPageConnectorItem.h b/editors/HWDesign/OffPageConnectorItem.h index 7fb6ac061..af939c31e 100644 --- a/editors/HWDesign/OffPageConnectorItem.h +++ b/editors/HWDesign/OffPageConnectorItem.h @@ -40,7 +40,7 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * The constructor. * - * @param [in] parent The parent connection endpoint. + * @param [in] parent The parent connection endpoint. */ explicit OffPageConnectorItem(ConnectionEndpoint* parent); @@ -72,7 +72,7 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Set the name of the parent bus interface. * - * @param [in] name The name to set for the port. + * @param [in] name The name to set for the port. * */ void setName(QString const& name) override; @@ -80,37 +80,37 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Get the description of the port. * - * @return QString containing the description. + * @return QString containing the description. */ QString description() const override; /*! * Set the description for the port. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ void setDescription(QString const& description) override; /*! * Attaches the endpoint to a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ void addConnection(GraphicsConnection* connection) override; /*! * Unattaches the endpoint from a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ void removeConnection(GraphicsConnection* connection) override; /*! * Called when a connection between this and another endpoint is done. * - * @param [in] other The other endpoint of the connection. + * @param [in] other The other endpoint of the connection. * - * @return False if there was an error in the connection. Otherwise true. + * @return False if there was an error in the connection. Otherwise true. */ bool onConnect(ConnectionEndpoint const* other) override; @@ -122,7 +122,7 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks Does not take existing connections into account but simply * validates whether a connection between the endpoints would be valid @@ -138,7 +138,7 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Sets the draw direction of the endpoint. * - * @param [in] dir The draw direction to set. + * @param [in] dir The draw direction to set. * * @remarks The direction can be changed only if isDirectionFixed() returns false. */ @@ -162,7 +162,7 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Returns pointer to the top component that owns this interface. * - * @return Pointer to the component to which this interface belongs to. + * @return Pointer to the component to which this interface belongs to. */ virtual QSharedPointer getOwnerComponent() const; @@ -203,49 +203,49 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Get the bus interface mode of the end point item. * - * @return The bus interface mode. + * @return The bus interface mode. */ virtual General::InterfaceMode getInterfaceMode() const; /*! * Get the type of the end point item. * - * @return The type of the end point item. + * @return The type of the end point item. */ ConnectionEndpoint::EndpointType getType() const noexcept override; /*! * Check if the end point is a bus interface. * - * @return True, if the end point is a bus interface end point, otherwise false. + * @return True, if the end point is a bus interface end point, otherwise false. */ bool isBus() const noexcept override; /*! * Check if the end point is an ad hoc. * - * @return True if the endpoint is an ad-hoc port, otherwise false. + * @return True if the endpoint is an ad-hoc port, otherwise false. */ bool isAdHoc() const noexcept override; /*! * Check if the end point is a com interface. * - * @return True if the endpoint is a COM interface endpoint, otherwise false. + * @return True if the endpoint is a COM interface endpoint, otherwise false. */ bool isCom() const noexcept override; /*! * Check if the end point is an api interface. * - * @return True if the endpoint is an API interface endpoint, otherwise false. + * @return True if the endpoint is an API interface endpoint, otherwise false. */ bool isApi() const noexcept override; /*! * Returns the corresponding parent connector. * - * @return The parent connector. + * @return The parent connector. */ virtual ConnectionEndpoint* getParentConnector() const; @@ -254,10 +254,10 @@ class OffPageConnectorItem : public ConnectionEndpoint /*! * Handle the item changes. * - * @param [in] change The change in the item. - * @param [in] value Value for change. + * @param [in] change The change in the item. + * @param [in] value Value for change. * - * @return The item change. + * @return The item change. */ QVariant itemChange(GraphicsItemChange change, QVariant const& value) override; diff --git a/editors/HWDesign/PortmapDialog.h b/editors/HWDesign/PortmapDialog.h index 54fa40491..c52d142ea 100644 --- a/editors/HWDesign/PortmapDialog.h +++ b/editors/HWDesign/PortmapDialog.h @@ -41,11 +41,11 @@ class PortmapDialog : public QDialog /*! * Constructor. * - * @param [in] library The library interface. - * @param [in] component The parent component of the bus interface. - * @param [in] busIf The bus interface whose port map will be edited. - * @param [in] otherBusIf The bus interface in the other end of the connection. - * @param [in] parent The owner of this dialog. + * @param [in] library The library interface. + * @param [in] component The parent component of the bus interface. + * @param [in] busIf The bus interface whose port map will be edited. + * @param [in] otherBusIf The bus interface in the other end of the connection. + * @param [in] parent The owner of this dialog. */ PortmapDialog(LibraryInterface* library, QSharedPointer component, QSharedPointer busIf, QSharedPointer otherBusIf, QWidget* parent = 0); diff --git a/editors/HWDesign/SelectItemTypeDialog.h b/editors/HWDesign/SelectItemTypeDialog.h index b00efe2fb..a200ff2ab 100644 --- a/editors/HWDesign/SelectItemTypeDialog.h +++ b/editors/HWDesign/SelectItemTypeDialog.h @@ -31,8 +31,8 @@ class SelectItemTypeDialog : public QDialog /*! * Constructor. * - * @param [in] allowedItems The item types from which the user can select from. - * @param [in] parent The parent widget. + * @param [in] allowedItems The item types from which the user can select from. + * @param [in] parent The parent widget. */ SelectItemTypeDialog(unsigned int allowedItems, QWidget* parent); diff --git a/editors/HWDesign/WarningSymbol.h b/editors/HWDesign/WarningSymbol.h index b1fe39aca..efb766930 100644 --- a/editors/HWDesign/WarningSymbol.h +++ b/editors/HWDesign/WarningSymbol.h @@ -26,11 +26,11 @@ class WarningSymbol : public QGraphicsPolygonItem /*! * The constructor. * - * @param [in] busIf The bus interface this item represents. - * @param [in] component Component containing the bus interface. - * @param [in] library Access to the library. - * @param [in] parent The parent object. - * @param [in] dir Direction for the end point graphics. + * @param [in] busIf The bus interface this item represents. + * @param [in] component Component containing the bus interface. + * @param [in] library Access to the library. + * @param [in] parent The parent object. + * @param [in] dir Direction for the end point graphics. */ WarningSymbol(QGraphicsItem* parent); @@ -42,7 +42,7 @@ class WarningSymbol : public QGraphicsPolygonItem /*! * Move the warning symbol in the design according to direction. * - * @param [in] dir The selected direction. + * @param [in] dir The selected direction. */ void moveSymbol(QVector2D const& dir); diff --git a/editors/HWDesign/columnview/ColumnEditDialog.h b/editors/HWDesign/columnview/ColumnEditDialog.h index 601ce20e9..8605f3861 100644 --- a/editors/HWDesign/columnview/ColumnEditDialog.h +++ b/editors/HWDesign/columnview/ColumnEditDialog.h @@ -34,9 +34,9 @@ class ColumnEditDialog : public QDialog /*! * Constructor. * - * @param [in] parent The parent widget. - * @param [in] sw If true, the dialog shows only options valid for SW designs. - * @param [in] column The existing column to edit. + * @param [in] parent The parent widget. + * @param [in] sw If true, the dialog shows only options valid for SW designs. + * @param [in] column The existing column to edit. */ ColumnEditDialog(QWidget* parent, bool sw, GraphicsColumn const* column = 0); @@ -83,21 +83,21 @@ private slots: /*! * Initializes the selectable types. * - * @param [in] sw True if editing sw columns. + * @param [in] sw True if editing sw columns. */ void initializeTypes(bool sw); /*! * Sets the dialog layout. * - * @param [in] sw True if editing sw columns. + * @param [in] sw True if editing sw columns. */ void setupLayout(bool sw); /*! * Sets the allowed items in the dialog. * - * @param [in] allowedItems The allowed items. See ComponentItemType for possible values. + * @param [in] allowedItems The allowed items. See ComponentItemType for possible values. */ void setAllowedItems(unsigned int allowedItems); diff --git a/editors/HWDesign/columnview/HWColumn.h b/editors/HWDesign/columnview/HWColumn.h index c7ed5a279..0c33f5c35 100644 --- a/editors/HWDesign/columnview/HWColumn.h +++ b/editors/HWDesign/columnview/HWColumn.h @@ -36,8 +36,8 @@ class HWColumn : public GraphicsColumn /*! * Constructor. * - * @param [in] desc The column description. - * @param [in] layout The parent column layout. + * @param [in] desc The column description. + * @param [in] layout The parent column layout. */ HWColumn(QSharedPointer desc, GraphicsColumnLayout* layout); @@ -52,8 +52,8 @@ class HWColumn : public GraphicsColumn /*! * Returns true if the given item is allowed to reside in the column based on the allowed items. * - * @param [in] item The item. - * @param [in] allowedItems The allowed items flags. + * @param [in] item The item. + * @param [in] allowedItems The allowed items flags. */ virtual bool isItemAllowed(QGraphicsItem* item, unsigned int allowedItems) const; @@ -65,7 +65,7 @@ class HWColumn : public GraphicsColumn /*! * Creates an undo command for the column move. * - * @return The created undo command. + * @return The created undo command. */ virtual QSharedPointer createMoveUndoCommand(); diff --git a/editors/HWDesign/undoCommands/AdHocBoundsChangeCommand.h b/editors/HWDesign/undoCommands/AdHocBoundsChangeCommand.h index 3bf2f0ac2..def87042a 100644 --- a/editors/HWDesign/undoCommands/AdHocBoundsChangeCommand.h +++ b/editors/HWDesign/undoCommands/AdHocBoundsChangeCommand.h @@ -32,10 +32,10 @@ class AdHocBoundsChangeCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] referencedPort The changed ad hoc port. - * @param [in] newLeftBound New value for the left bound of the tie off. - * @param [in] newRightBound New value for the right bound of the tie off. - * @param [in] parent The parent command. + * @param [in] referencedPort The changed ad hoc port. + * @param [in] newLeftBound New value for the left bound of the tie off. + * @param [in] newRightBound New value for the right bound of the tie off. + * @param [in] parent The parent command. */ AdHocBoundsChangeCommand(QSharedPointer referencedPort, QString const& newLeftBound, QString const& newRightBound, QUndoCommand* parent = 0); @@ -60,14 +60,14 @@ class AdHocBoundsChangeCommand : public QObject, public QUndoCommand /*! * Informs of new references created from the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void increaseReferences(QString const& expression); /*! * Informs of old references created from the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void decreaseReferences(QString const& expression); @@ -85,15 +85,15 @@ class AdHocBoundsChangeCommand : public QObject, public QUndoCommand /*! * Setup the part select for the selected port reference. * - * @param [in] newLeftValue New value for the left bound. - * @param [in] newRightValue New value for the right bound. + * @param [in] newLeftValue New value for the left bound. + * @param [in] newRightValue New value for the right bound. */ void setupPartSelectForPortReference(QString const& newLeftValue, QString const& newRightValue); /*! * Set a new part select for the referenced port. * - * @param [in] partSelect The new part select. + * @param [in] partSelect The new part select. */ void setPartSelectForReferencedPort(QSharedPointer partSelect); diff --git a/editors/HWDesign/undoCommands/AdHocConnectionAddCommand.h b/editors/HWDesign/undoCommands/AdHocConnectionAddCommand.h index 261ce8f7f..89985c4e6 100644 --- a/editors/HWDesign/undoCommands/AdHocConnectionAddCommand.h +++ b/editors/HWDesign/undoCommands/AdHocConnectionAddCommand.h @@ -28,10 +28,10 @@ class AdHocConnectionAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] diagram The diagram containing the item. - * @param [in] conn The adhoc connection to add. - * @param [in] design The design containing the adhoc connection. - * @param [in] parent The parent command. + * @param [in] diagram The diagram containing the item. + * @param [in] conn The adhoc connection to add. + * @param [in] design The design containing the adhoc connection. + * @param [in] parent The parent command. */ AdHocConnectionAddCommand(DesignDiagram* diagram, AdHocConnectionItem* conn, QSharedPointer design, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/AdHocConnectionDeleteCommand.h b/editors/HWDesign/undoCommands/AdHocConnectionDeleteCommand.h index d1b4875fd..73c548d47 100644 --- a/editors/HWDesign/undoCommands/AdHocConnectionDeleteCommand.h +++ b/editors/HWDesign/undoCommands/AdHocConnectionDeleteCommand.h @@ -32,9 +32,9 @@ class AdHocConnectionDeleteCommand : public QUndoCommand /*! * The constructor. * - * @param [in] diagram The diagram containing the AdHocConnection item. - * @param [in] adHocConnection The AdHocConnection to remove. - * @param [in] parent The parent command. + * @param [in] diagram The diagram containing the AdHocConnection item. + * @param [in] adHocConnection The AdHocConnection to remove. + * @param [in] parent The parent command. */ AdHocConnectionDeleteCommand(DesignDiagram* diagram, AdHocConnectionItem* AdHocConnection, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/AdHocTieOffBoundsChangeCommand.h b/editors/HWDesign/undoCommands/AdHocTieOffBoundsChangeCommand.h index 1a2c6fa37..d4cbbb4bb 100644 --- a/editors/HWDesign/undoCommands/AdHocTieOffBoundsChangeCommand.h +++ b/editors/HWDesign/undoCommands/AdHocTieOffBoundsChangeCommand.h @@ -34,12 +34,12 @@ class AdHocTieOffBoundsChangeCommand : public AdHocTiedValueCommand, public AdHo /*! * The constructor. * - * @param [in] portItem The selected port item. - * @param [in] newLeftValue New value for the left bound of the tie off. - * @param [in] newRightValue New value for the right bound of the tie off. - * @param [in] tieOffConnection Connection containing the tie off. - * @param [in] designDiagram Diagram containing the HW design. - * @param [in] parent The parent command. + * @param [in] portItem The selected port item. + * @param [in] newLeftValue New value for the left bound of the tie off. + * @param [in] newRightValue New value for the right bound of the tie off. + * @param [in] tieOffConnection Connection containing the tie off. + * @param [in] designDiagram Diagram containing the HW design. + * @param [in] parent The parent command. */ AdHocTieOffBoundsChangeCommand(AdHocItem* portItem, QString const& newLeftValue, QString const& newRightValue, QSharedPointer tieOffConnection, HWDesignDiagram* designDiagram, diff --git a/editors/HWDesign/undoCommands/AdHocTieOffChangeCommand.h b/editors/HWDesign/undoCommands/AdHocTieOffChangeCommand.h index 3150049e9..df676cf25 100644 --- a/editors/HWDesign/undoCommands/AdHocTieOffChangeCommand.h +++ b/editors/HWDesign/undoCommands/AdHocTieOffChangeCommand.h @@ -38,18 +38,18 @@ class AdHocTieOffChangeCommand : public QObject, public AdHocTiedValueCommand, p /*! * The constructor. * - * @param [in] portItem The selected port item. - * @param [in] connection The tie off connection. - * @param [in] newTieOffValue A new value for tie off. - * @param [in] newParsedTieOff Parsed value of the new tie off. - * @param [in] newFormattedTieOff New tie off with the referenced parameter UUIDs changed into names. - * @param [in] newBase The base number of the parsed new tie off. - * @param [in] oldTieOffValue The old value for the tie off. - * @param [in] oldParsedTieOff Parsed value of the old tie off. - * @param [in] oldFormattedTieOff Old tie off with the referenced parameter UUIDs changed into names. - * @param [in] oldBase The base number of the parsed old tie off. - * @param [in] design The containing design. - * @param [in] parent Parent command. + * @param [in] portItem The selected port item. + * @param [in] connection The tie off connection. + * @param [in] newTieOffValue A new value for tie off. + * @param [in] newParsedTieOff Parsed value of the new tie off. + * @param [in] newFormattedTieOff New tie off with the referenced parameter UUIDs changed into names. + * @param [in] newBase The base number of the parsed new tie off. + * @param [in] oldTieOffValue The old value for the tie off. + * @param [in] oldParsedTieOff Parsed value of the old tie off. + * @param [in] oldFormattedTieOff Old tie off with the referenced parameter UUIDs changed into names. + * @param [in] oldBase The base number of the parsed old tie off. + * @param [in] design The containing design. + * @param [in] parent Parent command. */ AdHocTieOffChangeCommand(AdHocItem* portItem, QSharedPointer connection, QString const& newTieOffValue, QString newParsedTieOff, QString newFormattedTieOff, int newBase, @@ -76,14 +76,14 @@ class AdHocTieOffChangeCommand : public QObject, public AdHocTiedValueCommand, p /*! * Informs of new references created from the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void increaseReferences(QString const& expression); /*! * Informs of old references created from the selected expression. * - * @param [in] expression The selected expression. + * @param [in] expression The selected expression. */ void decreaseReferences(QString const& expression); @@ -101,10 +101,10 @@ class AdHocTieOffChangeCommand : public QObject, public AdHocTiedValueCommand, p /*! * Change the tie off symbols in the connected ports. * - * @param [in] tieOffValue The tie off value. - * @param [in] parsedTieOff The parsed tie off value. - * @param [in] formattedTieOff The tie off with referenced parameter UUIDs changed to names. - * @param [in] tieOffBase The base number of the tie off. + * @param [in] tieOffValue The tie off value. + * @param [in] parsedTieOff The parsed tie off value. + * @param [in] formattedTieOff The tie off with referenced parameter UUIDs changed to names. + * @param [in] tieOffBase The base number of the tie off. */ void changeTieOffSymbolsInConnectedPorts(QString const& tieOffValue, QString const& parsedTieOff, QString const& formattedTieOff, int tieOffBase) const; @@ -112,11 +112,11 @@ class AdHocTieOffChangeCommand : public QObject, public AdHocTiedValueCommand, p /*! * Draw a tie off symbol matching the given value. * - * @param [in] portItem The port item whose symbol is being redrawn. - * @param [in] tieOffValue The tie off expression. - * @param [in] parsedTieOff The parsed tie off value. - * @param [in] formattedTieOff The tie off with the referenced parameter UUIDs changed to names. - * @param [in] tieOffBase The base number of the tie off. + * @param [in] portItem The port item whose symbol is being redrawn. + * @param [in] tieOffValue The tie off expression. + * @param [in] parsedTieOff The parsed tie off value. + * @param [in] formattedTieOff The tie off with the referenced parameter UUIDs changed to names. + * @param [in] tieOffBase The base number of the tie off. */ void drawTieOffSymbol(AdHocItem* portItem, QString const& tieOffValue, QString parsedTieOff, QString formattedTieOff, int tieOffBase) const; diff --git a/editors/HWDesign/undoCommands/AdHocTieOffConnectionDeleteCommand.h b/editors/HWDesign/undoCommands/AdHocTieOffConnectionDeleteCommand.h index 78ab47dfc..f1b60ecaf 100644 --- a/editors/HWDesign/undoCommands/AdHocTieOffConnectionDeleteCommand.h +++ b/editors/HWDesign/undoCommands/AdHocTieOffConnectionDeleteCommand.h @@ -28,9 +28,9 @@ class AdHocTieOffConnectionDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] containingDesign The design containing the ad hoc tie off connection. - * @param [in] connection The deleted ad hoc connection containing a tie off value. - * @param [in] parent The parent undo command. + * @param [in] containingDesign The design containing the ad hoc tie off connection. + * @param [in] connection The deleted ad hoc connection containing a tie off value. + * @param [in] parent The parent undo command. */ AdHocTieOffConnectionDeleteCommand(QSharedPointer containingDesign, QSharedPointer connection, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/AdHocTiedValueCommand.h b/editors/HWDesign/undoCommands/AdHocTiedValueCommand.h index 517c29930..060081084 100644 --- a/editors/HWDesign/undoCommands/AdHocTiedValueCommand.h +++ b/editors/HWDesign/undoCommands/AdHocTiedValueCommand.h @@ -31,9 +31,9 @@ class AdHocTiedValueCommand /*! * The constructor. * - * @param [in] portItem The selected port item. - * @param [in] tiedValueConnection The tie off connection. - * @param [in] designDiagram Diagram containing the HW design. + * @param [in] portItem The selected port item. + * @param [in] tiedValueConnection The tie off connection. + * @param [in] designDiagram Diagram containing the HW design. */ AdHocTiedValueCommand(AdHocItem* portItem, QSharedPointer tiedValueConnection, HWDesignDiagram* designDiagram); @@ -48,14 +48,14 @@ class AdHocTiedValueCommand /*! * Get the tied value connection. * - * @return The connection containing the tied values. + * @return The connection containing the tied values. */ QSharedPointer getTiedValueConnection() const; /*! * Get the referenced port of the tied value connection. * - * @return The referenced port. + * @return The referenced port. */ QSharedPointer getReferencedPort() const; @@ -73,25 +73,25 @@ class AdHocTiedValueCommand /*! * Create an ad hoc connection for the selected port item. * - * @param [in] portItem The selected port item. + * @param [in] portItem The selected port item. * - * @return The ad hoc connection for containing the tie off value. + * @return The ad hoc connection for containing the tie off value. */ QSharedPointer createConnectionForTiedValue(AdHocItem* portItem); /*! * Create a name for a tied value connection. * - * @param [in] portItem The port item whose connection is being created. + * @param [in] portItem The port item whose connection is being created. * - * @return Name of the tied value connection, __to_tiedValue + * @return Name of the tied value connection, __to_tiedValue */ QString createNameForTiedValueConnection(AdHocItem* portItem) const; /*! * Setup the referenced port. * - * @param [in] portName Name of the ad hoc port item. + * @param [in] portName Name of the ad hoc port item. */ void setupReferencedPort(QString const& portName); diff --git a/editors/HWDesign/undoCommands/AdHocVisibilityChangeCommand.h b/editors/HWDesign/undoCommands/AdHocVisibilityChangeCommand.h index d7fe439ce..3292de89d 100644 --- a/editors/HWDesign/undoCommands/AdHocVisibilityChangeCommand.h +++ b/editors/HWDesign/undoCommands/AdHocVisibilityChangeCommand.h @@ -28,10 +28,10 @@ class AdHocVisibilityChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] dataSource The ad-hoc enabled data source. - * @param [in] portName The name of the port. - * @param [in] newVisiblity The new ad-hoc visibility of the port. - * @param [in] parent The parent undo command. + * @param [in] dataSource The ad-hoc enabled data source. + * @param [in] portName The name of the port. + * @param [in] newVisiblity The new ad-hoc visibility of the port. + * @param [in] parent The parent undo command. */ AdHocVisibilityChangeCommand(AdHocEnabled* dataSource, QString const& portName, bool newVisibility, QUndoCommand* parent = 0); @@ -59,14 +59,14 @@ class AdHocVisibilityChangeCommand : public QUndoCommand /*! * Create a delete command for a connected connection. * - * @param [in] connection The selected connection. + * @param [in] connection The selected connection. */ void createConnectionDeleteCommand(GraphicsConnection* connection); /*! * Change the visibility status of the selected port item. * - * @param [in] currentVisibility The new visibility of the port item. + * @param [in] currentVisibility The new visibility of the port item. */ void changePortItemVisibility(bool currentVisibility); diff --git a/editors/HWDesign/undoCommands/ColumnDeleteCommand.h b/editors/HWDesign/undoCommands/ColumnDeleteCommand.h index ab77c7605..c1e58f3c9 100644 --- a/editors/HWDesign/undoCommands/ColumnDeleteCommand.h +++ b/editors/HWDesign/undoCommands/ColumnDeleteCommand.h @@ -30,10 +30,10 @@ class ColumnDeleteCommand : public QUndoCommand /*! * The constructor. * - * @param [in] diagram The diagram containing the column item. - * @param [in] layout The column layout to use. - * @param [in] column The column to remove. - * @param [in] parent The parent command. + * @param [in] diagram The diagram containing the column item. + * @param [in] layout The column layout to use. + * @param [in] column The column to remove. + * @param [in] parent The parent command. */ ColumnDeleteCommand(DesignDiagram* diagram, GraphicsColumnLayout* layout, GraphicsColumn* column, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/ComponentDeleteCommand.h b/editors/HWDesign/undoCommands/ComponentDeleteCommand.h index 186f44daa..5816727b2 100644 --- a/editors/HWDesign/undoCommands/ComponentDeleteCommand.h +++ b/editors/HWDesign/undoCommands/ComponentDeleteCommand.h @@ -33,10 +33,10 @@ class ComponentDeleteCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] diagram The diagram containing the component item. - * @param [in] column The column containing the component item. - * @param [in] component The component item to remove. - * @param [in] parent The parent command. + * @param [in] diagram The diagram containing the component item. + * @param [in] column The column containing the component item. + * @param [in] component The component item to remove. + * @param [in] parent The parent command. */ ComponentDeleteCommand(DesignDiagram* diagram, GraphicsColumn* column, HWComponentItem* component, QUndoCommand* parent = 0); @@ -72,7 +72,7 @@ class ComponentDeleteCommand : public QObject, public QUndoCommand /*! * Create a possible tie off value delete command for the selected connection end point. * - * @param [in] endPoint The selected connection end point. + * @param [in] endPoint The selected connection end point. */ void createTieOffDeleteCommand(ConnectionEndpoint* endPoint); diff --git a/editors/HWDesign/undoCommands/ComponentItemMoveCommand.h b/editors/HWDesign/undoCommands/ComponentItemMoveCommand.h index 00447cd38..edec57611 100644 --- a/editors/HWDesign/undoCommands/ComponentItemMoveCommand.h +++ b/editors/HWDesign/undoCommands/ComponentItemMoveCommand.h @@ -31,11 +31,11 @@ class ComponentItemMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] item The component item to move. - * @param [in] oldPos The item's old position. - * @param [in] oldStack The item's old stack. - * @param [in] diagram Diagram containing the scene of the component item. - * @param [in] parent The parent command. + * @param [in] item The component item to move. + * @param [in] oldPos The item's old position. + * @param [in] oldStack The item's old stack. + * @param [in] diagram Diagram containing the scene of the component item. + * @param [in] parent The parent command. */ ComponentItemMoveCommand(ComponentItem* item, QPointF const& oldPos, IGraphicsItemStack* oldStack, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/ConfigurableElementChangeCommand.h b/editors/HWDesign/undoCommands/ConfigurableElementChangeCommand.h index 44e4bc3ee..537d4f2d2 100644 --- a/editors/HWDesign/undoCommands/ConfigurableElementChangeCommand.h +++ b/editors/HWDesign/undoCommands/ConfigurableElementChangeCommand.h @@ -30,12 +30,12 @@ class ConfigurableElementChangeCommand: public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] elementID Parameter ID referenced by the changed configurable element. - * @param [in] oldValue Old value of the changed configurable element. - * @param [in] newValue New value of the changed configurable element. - * @param [in] defaultValue Default value of the parameter. - * @param [in] configurableElements List of the associated configurable element values. - * @param [in] parent The parent undo command. + * @param [in] elementID Parameter ID referenced by the changed configurable element. + * @param [in] oldValue Old value of the changed configurable element. + * @param [in] newValue New value of the changed configurable element. + * @param [in] defaultValue Default value of the parameter. + * @param [in] configurableElements List of the associated configurable element values. + * @param [in] parent The parent undo command. */ ConfigurableElementChangeCommand(QString const& elementID, QString const& oldValue, QString const& newValue, QString const& defaultValue, @@ -62,22 +62,22 @@ class ConfigurableElementChangeCommand: public QObject, public QUndoCommand /*! * Informs of data change in the configurable element referencing the selected ID. * - * @param [in] parameterID ID of the referenced parameter. - * @param [in] newDataValue New value of the configurable element. + * @param [in] parameterID ID of the referenced parameter. + * @param [in] newDataValue New value of the configurable element. */ void dataChangedInID(QString const& parameterID, QString const& newDataValue); /*! * Increase the amount of references in the new value. * - * @param [in] newValue The new value for the configurable element. + * @param [in] newValue The new value for the configurable element. */ void increaseReferencesInNewValue(QString const& newValue); /*! * Decrease the amount of references in the old value. * - * @param [in] oldValue The old value for the configurable element. + * @param [in] oldValue The old value for the configurable element. */ void decreaseReferencesInOldValue(QString const& oldValue); @@ -90,9 +90,9 @@ class ConfigurableElementChangeCommand: public QObject, public QUndoCommand /*! * Find the configurable element from the list of associated configurable elements. * - * @param [in] elementID ID of the parameter referenced by the configurable element. + * @param [in] elementID ID of the parameter referenced by the configurable element. * - * @return The configurable element value referencing the selected parameter. A new configurable element + * @return The configurable element value referencing the selected parameter. A new configurable element * value is constructed if one does not exist. */ QSharedPointer setupConfigurableElement(QString const& elementID); @@ -100,7 +100,7 @@ class ConfigurableElementChangeCommand: public QObject, public QUndoCommand /*! * Change the value in the configurable element. * - * @param [in] newElementValue New value for the configurable element. + * @param [in] newElementValue New value for the configurable element. */ void changeConfigurableElement(QString const& newElementValue); diff --git a/editors/HWDesign/undoCommands/ConfigurableElementRemoveCommand.h b/editors/HWDesign/undoCommands/ConfigurableElementRemoveCommand.h index e612d2b38..431217b57 100644 --- a/editors/HWDesign/undoCommands/ConfigurableElementRemoveCommand.h +++ b/editors/HWDesign/undoCommands/ConfigurableElementRemoveCommand.h @@ -30,12 +30,12 @@ class ConfigurableElementRemoveCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] elementID ID of the parameter referenced by the configurable element. - * @param [in] itemRow Row of the item. - * @param [in] parentName Name of the parent item. - * @param [in] configurableElements List of the configurable element values containing the element + * @param [in] elementID ID of the parameter referenced by the configurable element. + * @param [in] itemRow Row of the item. + * @param [in] parentName Name of the parent item. + * @param [in] configurableElements List of the configurable element values containing the element * removed in this command. - * @param [in] parent The parent undo command. + * @param [in] parent The parent undo command. */ ConfigurableElementRemoveCommand(QString const& elementID, int itemRow, QString const& parentName, QSharedPointer > > configurableElements, @@ -65,9 +65,9 @@ class ConfigurableElementRemoveCommand : public QObject, public QUndoCommand /*! * Informs that the selected configurable element value has been added to the associated table. * - * @param [in] elementID ID of the selected configurable element. - * @param [in] elementValue Value of the selected configurable element. - * @param [in] elementRow Row of the configurable element in the associated table. + * @param [in] elementID ID of the selected configurable element. + * @param [in] elementValue Value of the selected configurable element. + * @param [in] elementRow Row of the configurable element in the associated table. */ void addConfigurableElement(QString const& elementID, QString const& elementValue, int elementRow); @@ -75,23 +75,23 @@ class ConfigurableElementRemoveCommand : public QObject, public QUndoCommand /*! * Informs that the selected configurable element value has been removed from the associated table. * - * @param [in] elementID ID of the parameter referenced by the selected configurable element. - * @param [in] parentName Name of the parent item containing the configurable element item. - * @param [in] elementRow Row of the removed configurable element value. + * @param [in] elementID ID of the parameter referenced by the selected configurable element. + * @param [in] parentName Name of the parent item containing the configurable element item. + * @param [in] elementRow Row of the removed configurable element value. */ void removeConfigurableElement(QString const& elementID, int elementRow); /*! * Increase the amount of references in the new value. * - * @param [in] newValue The new value for the configurable element. + * @param [in] newValue The new value for the configurable element. */ void increaseReferencesInNewValue(QString const& newValue); /*! * Decrease the amount of references in the old value. * - * @param [in] oldValue The old value for the configurable element. + * @param [in] oldValue The old value for the configurable element. */ void decreaseReferencesInOldValue(QString const& oldValue); @@ -100,9 +100,9 @@ class ConfigurableElementRemoveCommand : public QObject, public QUndoCommand /*! * Locate the configurable element value with the referenced parameter ID. * - * @param [in] elementID ID of the parameter referenced by the selected configurable element value. + * @param [in] elementID ID of the parameter referenced by the selected configurable element value. * - * @return The configurable element value containing a reference to the selected parameter ID. + * @return The configurable element value containing a reference to the selected parameter ID. */ QSharedPointer getRemovedConfigurableElement(QString const& elementID); diff --git a/editors/HWDesign/undoCommands/ConnectionDeleteCommand.h b/editors/HWDesign/undoCommands/ConnectionDeleteCommand.h index 16231b2b2..942a324c6 100644 --- a/editors/HWDesign/undoCommands/ConnectionDeleteCommand.h +++ b/editors/HWDesign/undoCommands/ConnectionDeleteCommand.h @@ -32,9 +32,9 @@ class ConnectionDeleteCommand : public QUndoCommand /*! * The constructor. * - * @param [in] diagram The diagram containing the connection item. - * @param [in] connection The connection to remove. - * @param [in] parent The parent command. + * @param [in] diagram The diagram containing the connection item. + * @param [in] connection The connection to remove. + * @param [in] parent The parent command. */ ConnectionDeleteCommand(DesignDiagram* diagram, HWConnection* connection, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/HWColumnAddCommand.h b/editors/HWDesign/undoCommands/HWColumnAddCommand.h index da90eee49..72afcf951 100644 --- a/editors/HWDesign/undoCommands/HWColumnAddCommand.h +++ b/editors/HWDesign/undoCommands/HWColumnAddCommand.h @@ -29,10 +29,10 @@ class HWColumnAddCommand : public GraphicsColumnAddCommand /*! * Constructor. * - * @param [in] layout The column layout. - * @param [in] column The column to add. - * @param [in] diagram Diagram containing the column layout. - * @param [in] parent The parent command. + * @param [in] layout The column layout. + * @param [in] column The column to add. + * @param [in] diagram Diagram containing the column layout. + * @param [in] parent The parent command. */ HWColumnAddCommand(GraphicsColumnLayout* layout, GraphicsColumn* column, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -60,14 +60,14 @@ class HWColumnAddCommand : public GraphicsColumnAddCommand /*! * Get the mandatory port items that have not been inserted into any columns. * - * @return The mandatory port items that have not been inserted into any columns. + * @return The mandatory port items that have not been inserted into any columns. */ QVector getMissingAdHocPortItems() const; /*! * Get the mandatory ports that have not been inserted into any columns. * - * @return The mandatory ports that have not been inserted into any column + * @return The mandatory ports that have not been inserted into any column */ QVector > getMissingAdHocPorts() const; @@ -84,17 +84,17 @@ class HWColumnAddCommand : public GraphicsColumnAddCommand /*! * Check if the selected port exists in the design diagram. * - * @param [in] adHocPort The selected ad hoc port. + * @param [in] adHocPort The selected ad hoc port. * - * @return True, if the port is found in the design diagram, otherwise false. + * @return True, if the port is found in the design diagram, otherwise false. */ bool portExistsInDiagram(QSharedPointer adHocPort) const; /*! * Get the position vendor extension for the selected ad hoc port. * - * @param [in] positionGroup Extension group for ad hoc positions. - * @param [in] adhocPort The selected ad hoc port. + * @param [in] positionGroup Extension group for ad hoc positions. + * @param [in] adhocPort The selected ad hoc port. */ QSharedPointer getAdHocPositionExtension(QSharedPointer positionGroup, QSharedPointer adhocPort) const; diff --git a/editors/HWDesign/undoCommands/HWComponentAddCommand.h b/editors/HWDesign/undoCommands/HWComponentAddCommand.h index c131ada50..cd321660e 100644 --- a/editors/HWDesign/undoCommands/HWComponentAddCommand.h +++ b/editors/HWDesign/undoCommands/HWComponentAddCommand.h @@ -35,10 +35,10 @@ class HWComponentAddCommand : public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] diagram Diagram containing the scene of the component item. - * @param [in] stack The stack to which to add the item. - * @param [in] item The item to add. - * @param [in] parent The parent command. + * @param [in] diagram Diagram containing the scene of the component item. + * @param [in] stack The stack to which to add the item. + * @param [in] item The item to add. + * @param [in] parent The parent command. */ HWComponentAddCommand(DesignDiagram* diagram, IGraphicsItemStack* stack, ComponentItem* item, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/InterfaceDeleteCommand.h b/editors/HWDesign/undoCommands/InterfaceDeleteCommand.h index fedc29ba3..28eb5faab 100644 --- a/editors/HWDesign/undoCommands/InterfaceDeleteCommand.h +++ b/editors/HWDesign/undoCommands/InterfaceDeleteCommand.h @@ -38,8 +38,8 @@ class InterfaceDeleteCommand : public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] interface The interface to delete. - * @param [in] removePorts If true, the ports that are part of the interface are also removed. + * @param [in] interface The interface to delete. + * @param [in] removePorts If true, the ports that are part of the interface are also removed. */ InterfaceDeleteCommand(DesignDiagram* diagram, HierarchicalBusInterfaceItem* interface, bool removePorts, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/PhysicalPortDeleteCommand.h b/editors/HWDesign/undoCommands/PhysicalPortDeleteCommand.h index 31a468662..7b128ce6a 100644 --- a/editors/HWDesign/undoCommands/PhysicalPortDeleteCommand.h +++ b/editors/HWDesign/undoCommands/PhysicalPortDeleteCommand.h @@ -29,9 +29,9 @@ class DeletePhysicalPortCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component from which to delete a physical port. - * @param [in] port The port to delete. - * @param [in] parent The parent command. + * @param [in] component The component from which to delete a physical port. + * @param [in] port The port to delete. + * @param [in] parent The parent command. */ DeletePhysicalPortCommand(QSharedPointer, QSharedPointer port, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/PortDeleteCommand.h b/editors/HWDesign/undoCommands/PortDeleteCommand.h index 05c97b070..f713e7a2e 100644 --- a/editors/HWDesign/undoCommands/PortDeleteCommand.h +++ b/editors/HWDesign/undoCommands/PortDeleteCommand.h @@ -29,7 +29,7 @@ class PortDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] port The port to delete. + * @param [in] port The port to delete. */ PortDeleteCommand(DesignDiagram* diagram, HWConnectionEndpoint* port, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/PortPasteCommand.h b/editors/HWDesign/undoCommands/PortPasteCommand.h index b7d7109b7..84379e85e 100644 --- a/editors/HWDesign/undoCommands/PortPasteCommand.h +++ b/editors/HWDesign/undoCommands/PortPasteCommand.h @@ -28,10 +28,10 @@ class PortPasteCommand : public QUndoCommand * * Creates the child commands for adding physical ports to the component model. * - * @param [in] destComponent The component to which to copy a port. - * @param [in] port The port to paste. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] destComponent The component to which to copy a port. + * @param [in] port The port to paste. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ PortPasteCommand(HWComponentItem* destComponent, ActiveBusInterfaceItem* port, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/HWDesign/undoCommands/ReplaceComponentCommand.h b/editors/HWDesign/undoCommands/ReplaceComponentCommand.h index f0ff8e4e7..e2b7b38ca 100644 --- a/editors/HWDesign/undoCommands/ReplaceComponentCommand.h +++ b/editors/HWDesign/undoCommands/ReplaceComponentCommand.h @@ -39,11 +39,11 @@ class ReplaceComponentCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] diagram The containing design diagram. - * @param [in] oldComp The replaced component. - * @param [in] newComp The new component. - * @param [in] diagram Diagram containing the scene of the component items. - * @param [in] parent Owner of this command. + * @param [in] diagram The containing design diagram. + * @param [in] oldComp The replaced component. + * @param [in] newComp The new component. + * @param [in] diagram Diagram containing the scene of the component items. + * @param [in] parent Owner of this command. */ ReplaceComponentCommand(HWComponentItem* oldComp, HWComponentItem* newComp, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -78,11 +78,11 @@ class ReplaceComponentCommand : public QObject, public QUndoCommand /*! * Change connections. * - * @param [in] keepExistingComponent Flag for existence checking. - * @param [in] connectionNames Names of the changed connections. - * @param [in] oldComponentItem The replaced component. - * @param [in] newComponentItem The new component. - * @param [in] diagram The containing design diagram. + * @param [in] keepExistingComponent Flag for existence checking. + * @param [in] connectionNames Names of the changed connections. + * @param [in] oldComponentItem The replaced component. + * @param [in] newComponentItem The new component. + * @param [in] diagram The containing design diagram. */ void changeConnections(HWComponentItem* oldComponentItem, HWComponentItem* newComponentItem, QVector& connectionNames); @@ -90,9 +90,9 @@ class ReplaceComponentCommand : public QObject, public QUndoCommand /*! * Create exchange commands for connections between the end points. * - * @param [in] connectionNames Names of the changed connections. - * @param [in] oldEndpoint The replaced end point. - * @param [in] newEndpoint The new end point. + * @param [in] connectionNames Names of the changed connections. + * @param [in] oldEndpoint The replaced end point. + * @param [in] newEndpoint The new end point. */ void createConnectionExchangeCommands(ConnectionEndpoint* oldEndpoint, HWConnectionEndpoint* newEndpoint, QVector& connectionNames); diff --git a/editors/HWDesign/undoCommands/TopAdHocVisibilityChangeCommand.h b/editors/HWDesign/undoCommands/TopAdHocVisibilityChangeCommand.h index 917d1705d..15a3ac114 100644 --- a/editors/HWDesign/undoCommands/TopAdHocVisibilityChangeCommand.h +++ b/editors/HWDesign/undoCommands/TopAdHocVisibilityChangeCommand.h @@ -27,10 +27,10 @@ class TopAdHocVisibilityChangeCommand : public AdHocVisibilityChangeCommand /*! * Constructor. * - * @param [in] dataSource The ad-hoc enabled data source. - * @param [in] portName The name of the port. - * @param [in] newVisiblity The new ad-hoc visibility of the port. - * @param [in] parent The parent undo command. + * @param [in] dataSource The ad-hoc enabled data source. + * @param [in] portName The name of the port. + * @param [in] newVisiblity The new ad-hoc visibility of the port. + * @param [in] parent The parent undo command. */ TopAdHocVisibilityChangeCommand(HWDesignDiagram* dataSource, QString const& portName, bool newVisibility, QUndoCommand* parent = nullptr); @@ -49,15 +49,15 @@ class TopAdHocVisibilityChangeCommand : public AdHocVisibilityChangeCommand /*! * Setup a command for the deleting of the tie off value connection of the selected port item. * - * @param [in] diagram Design diagram containing the ad hoc port. - * @param [in] portName Name of the selected port item. + * @param [in] diagram Design diagram containing the ad hoc port. + * @param [in] portName Name of the selected port item. */ void setupTieOffConnectionForDeletion(HWDesignDiagram* diagram, QString const& portName); /*! * Setup the addition of an ad hoc port column. * - * @param [in] diagram Design diagram containing the ad hoc port. + * @param [in] diagram Design diagram containing the ad hoc port. */ void setupColumnAddition(HWDesignDiagram* diagram); diff --git a/editors/MemoryDesigner/AddressBlockGraphicsItem.h b/editors/MemoryDesigner/AddressBlockGraphicsItem.h index b00aa3064..13bf5c507 100644 --- a/editors/MemoryDesigner/AddressBlockGraphicsItem.h +++ b/editors/MemoryDesigner/AddressBlockGraphicsItem.h @@ -38,14 +38,14 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public /*! * The constructor. * - * @param [in] blockItem Memory item containing the address block data. - * @param [in] identifierChain Chain of strings identifying this item. - * @param [in] isEmptyBlock Boolean value for existing blocks. - * @param [in] filterRegisters Filtering value for address block registers. - * @param [in] filterFields Filtering value for register fields. - * @param [in] addressBlockWidth Width of the address block graphics item. - * @param [in] containingInstanceName Name of the containing component instance. - * @param [in] memoryMapItem The parent memory map item. + * @param [in] blockItem Memory item containing the address block data. + * @param [in] identifierChain Chain of strings identifying this item. + * @param [in] isEmptyBlock Boolean value for existing blocks. + * @param [in] filterRegisters Filtering value for address block registers. + * @param [in] filterFields Filtering value for register fields. + * @param [in] addressBlockWidth Width of the address block graphics item. + * @param [in] containingInstanceName Name of the containing component instance. + * @param [in] memoryMapItem The parent memory map item. */ AddressBlockGraphicsItem(QSharedPointer blockItem, QVector identifierChain, bool isEmptyBlock, bool filterRegisters, bool filterFields, qreal addressBlockWidth, @@ -64,21 +64,21 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public /*! * Change the address block ranges. * - * @param [in] offset The new offset of the memory map. + * @param [in] offset The new offset of the memory map. */ virtual void changeAddressRange(quint64 memoryMapOffset); /*! * Add a memory connection to address block item and to the correct sub items. * - * @param [in] connectionItem The selected memory connection item. + * @param [in] connectionItem The selected memory connection item. */ virtual void addMemoryConnection(MemoryConnectionItem* connectionItem); /*! * Change the width of the contained register graphics items. * - * @param [in] widthChange The given change in width. + * @param [in] widthChange The given change in width. */ void changeWidth(qreal widthChange); @@ -86,7 +86,7 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public * Get the maximum needed change in width to display the name labels of all the field items within the * register items. * - * @return The maximum needed change in width to display the name labels of all the field items. + * @return The maximum needed change in width to display the name labels of all the field items. */ qreal getMaximumNeededChangeInFieldWidth() const; @@ -103,8 +103,8 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public /*! * Get the width of the block item. * - * @param [in] memoryMapItem The parent item of the address block item. - * @param [in] registersAreFiltered Filtering value for address block registers. + * @param [in] memoryMapItem The parent item of the address block item. + * @param [in] registersAreFiltered Filtering value for address block registers. */ qreal getBlockWidth(MemoryMapGraphicsItem* memoryMapItem, bool registersAreFiltered) const; @@ -116,10 +116,10 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public /*! * Create a new register graphics item. * - * @param [in] subMemoryItem Memory item containing register data. - * @param [in] isEmpty Boolean value for an empty register. + * @param [in] subMemoryItem Memory item containing register data. + * @param [in] isEmpty Boolean value for an empty register. * - * @return The created register graphics item. + * @return The created register graphics item. */ virtual MemoryDesignerChildGraphicsItem* createNewSubItem(QSharedPointer subMemoryItem, bool isEmpty); @@ -127,24 +127,24 @@ class AddressBlockGraphicsItem : public MemoryDesignerChildGraphicsItem, public /*! * Create an empty register graphics item. * - * @param [in] beginAddress Base address of the empty register graphics item. - * @param [in] rangeEnd End address of the empty register graphics item. + * @param [in] beginAddress Base address of the empty register graphics item. + * @param [in] rangeEnd End address of the empty register graphics item. * - * @return The created register graphics item. + * @return The created register graphics item. */ virtual MemoryDesignerChildGraphicsItem* createEmptySubItem(quint64 beginAddress, quint64 rangeEnd); /*! * Get the width of the available area used by the address block item. * - * @return The width of the available area used by the address block item. + * @return The width of the available area used by the address block item. */ virtual qreal getItemWidth() const; /*! * Get the width for the register graphics items. * - * @return Width for the register graphics items. + * @return Width for the register graphics items. */ qreal getRegisterWidth() const; diff --git a/editors/MemoryDesigner/AddressSegmentGraphicsItem.h b/editors/MemoryDesigner/AddressSegmentGraphicsItem.h index 55c986a1c..d6e2b627c 100644 --- a/editors/MemoryDesigner/AddressSegmentGraphicsItem.h +++ b/editors/MemoryDesigner/AddressSegmentGraphicsItem.h @@ -33,11 +33,11 @@ class AddressSegmentGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * The constructor. * - * @param [in] segmentItem The memory item containing address segment data. - * @param [in] isEmptySegment Boolean value to inform of an empty segment. - * @param [in] identifierChain Chain of strings identifying this item. - * @param [in] containingInstance Name of the containing component instance. - * @param [in] spaceItem The address space item containing the address segment. + * @param [in] segmentItem The memory item containing address segment data. + * @param [in] isEmptySegment Boolean value to inform of an empty segment. + * @param [in] identifierChain Chain of strings identifying this item. + * @param [in] containingInstance Name of the containing component instance. + * @param [in] spaceItem The address space item containing the address segment. */ AddressSegmentGraphicsItem(QSharedPointer segmentItem, bool isEmptySegment, QVector identifierChain, QSharedPointer containingInstance, @@ -61,7 +61,7 @@ class AddressSegmentGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the width of the address segment item. * - * @param [in] addressSpaceItem [Description]. + * @param [in] addressSpaceItem [Description]. */ qreal getSegmentItemWidth(AddressSpaceGraphicsItem* addressSpaceItem) const; diff --git a/editors/MemoryDesigner/AddressSpaceGraphicsItem.h b/editors/MemoryDesigner/AddressSpaceGraphicsItem.h index 7669a84a8..7e34ecd45 100644 --- a/editors/MemoryDesigner/AddressSpaceGraphicsItem.h +++ b/editors/MemoryDesigner/AddressSpaceGraphicsItem.h @@ -38,11 +38,11 @@ class AddressSpaceGraphicsItem : public MainMemoryGraphicsItem /*! * The constructor. * - * @param [in] memoryItem Memory item containing address space data. - * @param [in] identifierChain Chain of strings identifying this item. - * @param [in] containingInstance Data of the containing component instance. - * @param [in] filterSegments Value for filtering address space segments. - * @param [in] parent The parent item. + * @param [in] memoryItem Memory item containing address space data. + * @param [in] identifierChain Chain of strings identifying this item. + * @param [in] containingInstance Data of the containing component instance. + * @param [in] filterSegments Value for filtering address space segments. + * @param [in] parent The parent item. */ AddressSpaceGraphicsItem(QSharedPointer memoryItem, QVector identifierChain, QSharedPointer containingInstance, bool filterSegments, @@ -77,10 +77,10 @@ class AddressSpaceGraphicsItem : public MainMemoryGraphicsItem /*! * Create a new address segment graphics item. * - * @param [in] subMemoryItem Memory item containing address segment data. - * @param [in] isEmpty Boolean value for an empty address segment. + * @param [in] subMemoryItem Memory item containing address segment data. + * @param [in] isEmpty Boolean value for an empty address segment. * - * @return The created address segment graphics item. + * @return The created address segment graphics item. */ virtual MemoryDesignerChildGraphicsItem* createNewSubItem(QSharedPointer subMemoryItem, bool isEmpty) override; @@ -88,17 +88,17 @@ class AddressSpaceGraphicsItem : public MainMemoryGraphicsItem /*! * Create an empty address segment graphics item. * - * @param [in] beginAddress Base address of the empty address segment graphics item. - * @param [in] rangeEnd End address of the empty address segment graphics item. + * @param [in] beginAddress Base address of the empty address segment graphics item. + * @param [in] rangeEnd End address of the empty address segment graphics item. * - * @return The created address segment graphics item. + * @return The created address segment graphics item. */ virtual MemoryDesignerChildGraphicsItem* createEmptySubItem(quint64 beginAddress, quint64 rangeEnd) override; /*! * Get the minimum height required to display for the memory item. * - * @return The minimum height required to display the memory item. + * @return The minimum height required to display the memory item. */ virtual qreal getMinimumHeightForSubItems() const override final; diff --git a/editors/MemoryDesigner/ConnectivityComponent.h b/editors/MemoryDesigner/ConnectivityComponent.h index e6010c499..76887f0ab 100644 --- a/editors/MemoryDesigner/ConnectivityComponent.h +++ b/editors/MemoryDesigner/ConnectivityComponent.h @@ -28,7 +28,7 @@ class ConnectivityComponent /*! * The constructor. * - * @param [in] name Name for the component instance. + * @param [in] name Name for the component instance. */ ConnectivityComponent(QString const& name); @@ -40,63 +40,63 @@ class ConnectivityComponent /*! * Set a new name for the component instance. * - * @param [in] newName The new name. + * @param [in] newName The new name. */ void setName(QString const& newName); /*! * Gets the name of the instance. * - * @return The instance name. + * @return The instance name. */ QString getName() const; /*! * Sets the identifier for the instance. * - * @param [in] uuid The identifier to set. + * @param [in] uuid The identifier to set. */ void setInstanceUuid(QString const& uuid); /*! * Gets the identifier for the component instance. * - * @return The identifier for the instance. + * @return The identifier for the instance. */ QString getInstanceUuid() const; /*! * Sets the instance VLNV identifier. * - * @param [in] vlnv The VLNV to set. + * @param [in] vlnv The VLNV to set. */ void setVlnv(QString const& vlnv); /*! * Gets the instance VLNV identifier. * - * @return The instance VLNV identifier. + * @return The instance VLNV identifier. */ QString getVlnv() const; /*! * Sets the active view for the instance. * - * @param [in] viewName The name of the active view to set. + * @param [in] viewName The name of the active view to set. */ void setActiveView(QString const& viewName); /*! * Adds a memory associated with the instance. * - * @param [in] memory The memory to add. + * @param [in] memory The memory to add. */ void addMemory(QSharedPointer memory); /*! * Gets the associated memories for the instance. * - * @return The associated memories. + * @return The associated memories. */ QVector > getMemories() const; @@ -108,7 +108,7 @@ class ConnectivityComponent /*! * Checks if the component is a channel. * - * @return True, if the component is a channel, otherwise false. + * @return True, if the component is a channel, otherwise false. */ bool isChanneled() const; diff --git a/editors/MemoryDesigner/ConnectivityConnection.h b/editors/MemoryDesigner/ConnectivityConnection.h index c764d4d2d..a07b7d80d 100644 --- a/editors/MemoryDesigner/ConnectivityConnection.h +++ b/editors/MemoryDesigner/ConnectivityConnection.h @@ -27,9 +27,9 @@ class ConnectivityConnection /*! * The constructor. * - * @param [in] name The name of the connection. - * @param [in] startPoint The starting interface in the connection. - * @param [in] endPoint The end interface in the connection. + * @param [in] name The name of the connection. + * @param [in] startPoint The starting interface in the connection. + * @param [in] endPoint The end interface in the connection. */ ConnectivityConnection(QString const& name, QSharedPointer startPoint, QSharedPointer endPoint); @@ -42,21 +42,21 @@ class ConnectivityConnection /*! * Gets the name of the connection. * - * @return The name of the connection. + * @return The name of the connection. */ QString getName() const; /*! * Gets the first interface in the connection. * - * @return The first interface in the connection. + * @return The first interface in the connection. */ QSharedPointer getFirstInterface() const; /*! * Gets the second interface in the connection. * - * @return The second interface in the connection. + * @return The second interface in the connection. */ QSharedPointer getSecondInterface() const; diff --git a/editors/MemoryDesigner/ConnectivityGraph.h b/editors/MemoryDesigner/ConnectivityGraph.h index 0f4f3a7b7..7d46d0883 100644 --- a/editors/MemoryDesigner/ConnectivityGraph.h +++ b/editors/MemoryDesigner/ConnectivityGraph.h @@ -36,23 +36,23 @@ class ConnectivityGraph /*! * Gets all interfaces (=vertices) in the graph. * - * @return All interfaces. + * @return All interfaces. */ QVector >& getInterfaces() const; /*! * Gets all the instances in the graph. * - * @return All instances. + * @return All instances. */ QVector >& getInstances() const; /*! * Finds all connections for the given interface. * - * @param [in] startPoint The interface to find connections for. + * @param [in] startPoint The interface to find connections for. * - * @return All connections to/from the given interface. + * @return All connections to/from the given interface. */ QVector > getConnectionsFor( QSharedPointer startPoint) const; @@ -60,10 +60,10 @@ class ConnectivityGraph /*! * Finds the interface with the given name in the given instance. * - * @param [in] instanceName The name of the instance containing the interface. - * @param [in] interfaceName The name of the interface to find. + * @param [in] instanceName The name of the instance containing the interface. + * @param [in] interfaceName The name of the interface to find. * - * @return The found interface matching the given name and instance. + * @return The found interface matching the given name and instance. */ QSharedPointer getInterface(QString const& interfaceName, QString const& instanceName); @@ -71,7 +71,7 @@ class ConnectivityGraph /*! * Get all connections in the graph. * - * @return All connections in the graph. + * @return All connections in the graph. */ QVector >& getConnections() const; diff --git a/editors/MemoryDesigner/ConnectivityGraphFactory.h b/editors/MemoryDesigner/ConnectivityGraphFactory.h index 1e4171c8b..c44d013b9 100644 --- a/editors/MemoryDesigner/ConnectivityGraphFactory.h +++ b/editors/MemoryDesigner/ConnectivityGraphFactory.h @@ -61,7 +61,7 @@ class ConnectivityGraphFactory /*! * The constructor. * - * @param [in] library The library interface. + * @param [in] library The library interface. */ ConnectivityGraphFactory(LibraryInterface* library); @@ -71,10 +71,10 @@ class ConnectivityGraphFactory /*! * Creates a connectivity graph from the component and its underlying hierarchy. * - * @param [in] topComponent The selected component. - * @param [in] activeView The view to determine hierarchy. + * @param [in] topComponent The selected component. + * @param [in] activeView The view to determine hierarchy. * - * @return Connectivity graph for the design hierarchy. + * @return Connectivity graph for the design hierarchy. */ QSharedPointer createConnectivityGraph(QSharedPointer topComponent, QString const& activeView); @@ -87,11 +87,11 @@ class ConnectivityGraphFactory /*! * Creates graph elements from the given design and configuration. * - * @param [in] designInstantiation The design instantiation used in the top component. - * @param [in] design The design to analyze and transform into graph. - * @param [in] designConfiguration The design configuration to analyze and transform into graph. - * @param [in] topInterfaces The top-level component interfaces available for connections. - * @param [in/out] graph The graph to add elements into. + * @param [in] designInstantiation The design instantiation used in the top component. + * @param [in] design The design to analyze and transform into graph. + * @param [in] designConfiguration The design configuration to analyze and transform into graph. + * @param [in] topInterfaces The top-level component interfaces available for connections. + * @param [in/out] graph The graph to add elements into. */ void analyzeDesign(QSharedPointer designInstantiation, QSharedPointer design, @@ -102,12 +102,12 @@ class ConnectivityGraphFactory /*! * Creates a component instance representation for a component instance. * - * @param [in] instance The component instance to transform into the graph. - * @param [in] component The component for the instance. - * @param [in] activeView The active view for the instance. - * @param [in/out] graph The graph to add instance node into. + * @param [in] instance The component instance to transform into the graph. + * @param [in] component The component for the instance. + * @param [in] activeView The active view for the instance. + * @param [in/out] graph The graph to add instance node into. * - * @return The graph representation for the component instance. + * @return The graph representation for the component instance. */ QSharedPointer createInstanceData(QSharedPointer instance, QSharedPointer component, QString const& activeView, @@ -116,8 +116,8 @@ class ConnectivityGraphFactory /*! * Adds all address spaces to a component instance in the graph. * - * @param [in/out] instance The component instance to add the address spaces into. - * @param [in] component The component for the instance. + * @param [in/out] instance The component instance to add the address spaces into. + * @param [in] component The component for the instance. */ void addAddressSpaceMemories(QSharedPointer instance, QSharedPointer component) const; @@ -125,8 +125,8 @@ class ConnectivityGraphFactory /*! * Adds all memory maps to a component instance in the graph. * - * @param [in] instanceData The component instance representation to add memory maps into. - * @param [in] component The component for the instance. + * @param [in] instanceData The component instance representation to add memory maps into. + * @param [in] component The component for the instance. */ void addMemoryMapMemories(QSharedPointer instanceData, QSharedPointer component) const; @@ -134,11 +134,11 @@ class ConnectivityGraphFactory /*! * Creates a representation for a memory map in a component instance. * - * @param [in] map The memory map to transform into the graph. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. - * @param [in] containingInstance The component instance containing the memory map. + * @param [in] map The memory map to transform into the graph. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] containingInstance The component instance containing the memory map. * - * @return Representation for the memory map. + * @return Representation for the memory map. */ QSharedPointer createMemoryMapData(QSharedPointer map, int addressableUnitBits, QSharedPointer containingInstance) const; @@ -146,10 +146,10 @@ class ConnectivityGraphFactory /*! * Adds a all memory remap representations into a component instance representation. * - * @param [in] map The memory map containing the memory remaps. - * @param [in] mapItem The memory map representation for the memory map. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. - * @param [in] containingInstance The component instance containing the memory map and remaps. + * @param [in] map The memory map containing the memory remaps. + * @param [in] mapItem The memory map representation for the memory map. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] containingInstance The component instance containing the memory map and remaps. */ void addMemoryRemapData(QSharedPointer map, QSharedPointer mapItem, int addressableUnitBits, QSharedPointer containingInstance) const; @@ -157,11 +157,11 @@ class ConnectivityGraphFactory /*! * Create a representation of a memory block. * - * @param [in] block The selected memory block. - * @param [in] mapIdentifier Identifier for the containing memory map. - * @param [in] addressableUnitBits The used address unit bits. + * @param [in] block The selected memory block. + * @param [in] mapIdentifier Identifier for the containing memory map. + * @param [in] addressableUnitBits The used address unit bits. * - * @return Representation of the memory block. + * @return Representation of the memory block. */ QSharedPointer createMemoryBlock(QSharedPointer block, QString const& mapIdentifier, int addressableUnitBits) const; @@ -169,11 +169,11 @@ class ConnectivityGraphFactory /*! * Creates a representation for an address block. * - * @param [in] block The address block to transform into the graph. - * @param [in] mapIdentifier Identifier for the containing memory map. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] block The address block to transform into the graph. + * @param [in] mapIdentifier Identifier for the containing memory map. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. * - * @return Representation for the address block. + * @return Representation for the address block. */ QSharedPointer createMemoryAddressBlockItem(QSharedPointer block, QString const& mapIdentifier, int addressableUnitBits) const; @@ -181,11 +181,11 @@ class ConnectivityGraphFactory /*! * Creates a representation for a subspace map. * - * @param [in] subspace The selected subspace map. - * @param [in] mapIdentifier Identifier for the containing memory map. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] subspace The selected subspace map. + * @param [in] mapIdentifier Identifier for the containing memory map. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. * - * @return Represenation for the subspace map. + * @return Represenation for the subspace map. */ QSharedPointer createMemorySubSpaceMapItem(QSharedPointer subspace, QString const& mapIdentifier, int addressableUnitBits) const; @@ -193,11 +193,11 @@ class ConnectivityGraphFactory /*! * Adds a register representations into an address block representation. * - * @param [in] reg The register to add. - * @param [in] baseAddress The base address for the address block. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. - * @param [in] blockIdentifier Identifier for the containing address block. - * @param [in/out] blockItem The address block to the add register into. + * @param [in] reg The register to add. + * @param [in] baseAddress The base address for the address block. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] blockIdentifier Identifier for the containing address block. + * @param [in/out] blockItem The address block to the add register into. */ void addRegisterData(QSharedPointer reg, int baseAddress, int addressableUnitBits, QString const& blockIdentifier, QSharedPointer blockItem) const; @@ -205,10 +205,10 @@ class ConnectivityGraphFactory /*! * Get field items of the selected register item in order of offset. * - * @param [in] registerItem The selected register item. - * @param [in] fieldItems Field items of the register item. + * @param [in] registerItem The selected register item. + * @param [in] fieldItems Field items of the register item. * - * @return Field items in order of offset. + * @return Field items in order of offset. */ QMap > getOrderedFieldItems(QSharedPointer registerItem, QVector > fieldItems) const; @@ -216,12 +216,12 @@ class ConnectivityGraphFactory /*! * Creates a representation for a field within a register. * - * @param [in] field The field to transform into the graph. - * @param [in] registerIdentifier Identifier for the containing register. - * @param [in] regAddress The base address for the containing register. - * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. + * @param [in] field The field to transform into the graph. + * @param [in] registerIdentifier Identifier for the containing register. + * @param [in] regAddress The base address for the containing register. + * @param [in] addressableUnitBits The number of addressable unit bits in the memory map. * - * @return Representation for the field. + * @return Representation for the field. */ QSharedPointer createField(QSharedPointer field, QString const& registerIdentifier, int regAddress, int addressableUnitBits) const; @@ -229,11 +229,11 @@ class ConnectivityGraphFactory /*! * Creates a representation for an enumerated value within a field. * - * @param [in] enumeratedValue The enumerated value to transform into the graph. - * @param [in] fieldIdentifier Identifier for the containing field. - * @param [in] addressUnitBits The number of address unit bits in the memory map. + * @param [in] enumeratedValue The enumerated value to transform into the graph. + * @param [in] fieldIdentifier Identifier for the containing field. + * @param [in] addressUnitBits The number of address unit bits in the memory map. * - * @return Representation of the enumerated value. + * @return Representation of the enumerated value. */ QSharedPointer createEnumeratedValueItem(QSharedPointer enumeratedValue, QString const& fieldIdentifier, int const& addressUnitBits) const; @@ -241,12 +241,12 @@ class ConnectivityGraphFactory /*! * Create a representation of a reset within a field. * - * @param [in] fieldReset The selected field reset. - * @param [in] fieldIdentifier Identifier of the containing field. - * @param [in] addressUnitBits The number of address unit bits in the memory map. - * @param [in] fieldWidth The bit width of the field. + * @param [in] fieldReset The selected field reset. + * @param [in] fieldIdentifier Identifier of the containing field. + * @param [in] addressUnitBits The number of address unit bits in the memory map. + * @param [in] fieldWidth The bit width of the field. * - * @return Representation of the reset. + * @return Representation of the reset. */ QSharedPointer createFieldResetItem(QSharedPointer fieldReset, QString const& fieldIdentifier, int const& addressUnitBits, QString const& fieldWidth) const; @@ -254,12 +254,12 @@ class ConnectivityGraphFactory /*! * Create a representation of a reset within a register. * - * @param [in] fieldItems Field items within the selected register. - * @param [in] registerItem The selected register item. - * @param [in] registerIdentifier Identifier of the containing register. - * @param [in] addressUnitBits The number of address unit bits in the memory map. + * @param [in] fieldItems Field items within the selected register. + * @param [in] registerItem The selected register item. + * @param [in] registerIdentifier Identifier of the containing register. + * @param [in] addressUnitBits The number of address unit bits in the memory map. * - * @return Representation of the reset. + * @return Representation of the reset. */ QSharedPointer createRegisterResetItem(QMap > fieldItems, QSharedPointer registerItem, QString const& registerIdentifier, int const& addressUnitBits) @@ -268,20 +268,20 @@ class ConnectivityGraphFactory /*! * Get the representation of HARD reset of the selected item. * - * @param [in] containingItem The selected item. + * @param [in] containingItem The selected item. * - * @return Representation of a HARD reset. + * @return Representation of a HARD reset. */ QSharedPointer getHardResetItem(QSharedPointer containingItem) const; /*! * Creates graph vertices from the bus interfaces of the given component. * - * @param [in] instancedComponent The component whose bus interfaces to transform into graph. - * @param [in] instanceNode The graph element representing the instance. - * @param [in/out] graph The graph to add elements into. + * @param [in] instancedComponent The component whose bus interfaces to transform into graph. + * @param [in] instanceNode The graph element representing the instance. + * @param [in/out] graph The graph to add elements into. * - * @return The vertices created from the component bus interfaces. + * @return The vertices created from the component bus interfaces. */ QVector > createInterfacesForInstance( QSharedPointer instancedComponent, QSharedPointer instanceNode, @@ -290,11 +290,11 @@ class ConnectivityGraphFactory /*! * Creates an interface representation for a bus interface. * - * @param [in] busInterface The bus interface to transform into the graph. - * @param [in] instanceNode The instance containing the interface. - * @param [in/out] graph The graph to add elements into. + * @param [in] busInterface The bus interface to transform into the graph. + * @param [in] instanceNode The instance containing the interface. + * @param [in/out] graph The graph to add elements into. * - * @return The graph representation for the interface. + * @return The graph representation for the interface. */ QSharedPointer createInterfaceData(QSharedPointer busInterface, QSharedPointer instanceNode, QSharedPointer graph) const; @@ -302,12 +302,12 @@ class ConnectivityGraphFactory /*! * Creates an interfaces representation of a local memory map of an address space. * - * @param [in] addressSpace The selected address space. - * @param [in] interfacedMemory Memory item created for the address space. - * @param [in] instanceNode Component instance containing the interface. - * @param [in/out] graph The graph containing the interface. + * @param [in] addressSpace The selected address space. + * @param [in] interfacedMemory Memory item created for the address space. + * @param [in] instanceNode Component instance containing the interface. + * @param [in/out] graph The graph containing the interface. * - * @return The graph representation for the local memory map. + * @return The graph representation for the local memory map. */ QSharedPointer createLocalInterfaceData(QSharedPointer addressSpace, QSharedPointer interfacedMemory, QSharedPointer instanceNode, @@ -316,12 +316,12 @@ class ConnectivityGraphFactory /*! * Creates graph elements for component instance internal connections and a possible sub design. * - * @param [in] instancedComponent The instanced component to transform. - * @param [in] instanceNode The node containing the component instance. - * @param [in] instanceName The name of the instance. - * @param [in] activeView The active view of the component instance. - * @param [in] instanceInterfaces The graph interfaces for the instanced component. - * @param [in/out] graph The graph to add elements into. + * @param [in] instancedComponent The instanced component to transform. + * @param [in] instanceNode The node containing the component instance. + * @param [in] instanceName The name of the instance. + * @param [in] activeView The active view of the component instance. + * @param [in] instanceInterfaces The graph interfaces for the instanced component. + * @param [in/out] graph The graph to add elements into. */ void createInternalConnectionsAndDesigns(QSharedPointer instancedComponent, QSharedPointer instanceNode, QString const& instanceName, QString const& activeView, @@ -331,12 +331,12 @@ class ConnectivityGraphFactory /*! * Create a connection between an address space and its local memory map. * - * @param [in] instancedComponent Instanced component containing the address space. - * @param [in] instanceNode The node containing the component instance. - * @param [in] instanceName Name of the instance. - * @param [in] addressSpace The selected address space. - * @param [in] instanceInterfaces Interfaces within the instanced component. - * @param [in/out] graph The graph to add elements into. + * @param [in] instancedComponent Instanced component containing the address space. + * @param [in] instanceNode The node containing the component instance. + * @param [in] instanceName Name of the instance. + * @param [in] addressSpace The selected address space. + * @param [in] instanceInterfaces Interfaces within the instanced component. + * @param [in/out] graph The graph to add elements into. */ void createInternalSpaceMapConnection(QSharedPointer instancedComponent, QSharedPointer instanceNode, QString const& instanceName, @@ -347,10 +347,10 @@ class ConnectivityGraphFactory /*! * Get the bus interface that references the selected address space. * - * @param [in] instancedComponent Instanced component containing the address space. - * @param [in] spaceName Name of the selected address space. + * @param [in] instancedComponent Instanced component containing the address space. + * @param [in] spaceName Name of the selected address space. * - * @return The bus interface referencing the selected address space. + * @return The bus interface referencing the selected address space. */ QSharedPointer getBusInterfaceReferencingAddressSpace( QSharedPointer instancedComponent, QString const& spaceName) const; @@ -358,10 +358,10 @@ class ConnectivityGraphFactory /*! * Get the memory item node containing the selected memory item. * - * @param [in] memoryReference Name of the selected memory item. - * @param [in] instanceNode The node containing the component instance. + * @param [in] memoryReference Name of the selected memory item. + * @param [in] instanceNode The node containing the component instance. * - * @return The node containing the selected memory item. + * @return The node containing the selected memory item. */ QSharedPointer getMemoryItemNode(QString const& memoryReference, QSharedPointer instanceNode) const; @@ -369,10 +369,10 @@ class ConnectivityGraphFactory /*! * Creates graph elements for component instance sub designs. * - * @param [in] instancedComponent The instanced component whose sub design to transform. - * @param [in] activeView The active view of the component instance. - * @param [in] instanceInterfaces The graph interfaces for the instances component. - * @param [in/out] graph The graph to add elements into. + * @param [in] instancedComponent The instanced component whose sub design to transform. + * @param [in] activeView The active view of the component instance. + * @param [in] instanceInterfaces The graph interfaces for the instances component. + * @param [in/out] graph The graph to add elements into. */ void createConnectionsForDesign(QSharedPointer instancedComponent, QString const& activeView, QVector > instanceInterfaces, QSharedPointer graph) const; @@ -380,10 +380,10 @@ class ConnectivityGraphFactory /*! * Get the design instantiation for the selected view from the selected component. * - * @param [in] instancedComponent The selected component. - * @param [in] activeView The selected view. + * @param [in] instancedComponent The selected component. + * @param [in] activeView The selected view. * - * @return The design instantiation for the selected view from the selected component. + * @return The design instantiation for the selected view from the selected component. */ QSharedPointer getDesignInstantiation( QSharedPointer instancedComponent, QSharedPointer activeView) const; @@ -391,10 +391,10 @@ class ConnectivityGraphFactory /*! * Creates graph edges for the given design interconnection. * - * @param [in] interconnection The interconnection to transform into edge(s). - * @param [in] designInterfaces The interfaces in the component instances available for connections. - * @param [in] topInterfaces The top-level interfaces in the design available for connections. - * @param [in/out] graph The graph to add elements into. + * @param [in] interconnection The interconnection to transform into edge(s). + * @param [in] designInterfaces The interfaces in the component instances available for connections. + * @param [in] topInterfaces The top-level interfaces in the design available for connections. + * @param [in/out] graph The graph to add elements into. */ void createConnectionsForInterconnection(QSharedPointer interconnection, QVector > designInterfaces, @@ -404,11 +404,11 @@ class ConnectivityGraphFactory /*! * Finds the interface vertex for the given interface name and instance. * - * @param [in] interfaceName The name of the interface to find. - * @param [in] instanceName The name of the component instance containing the interface. - * @param [in] instanceInterfaces The interfaces available to search from. + * @param [in] interfaceName The name of the interface to find. + * @param [in] instanceName The name of the component instance containing the interface. + * @param [in] instanceInterfaces The interfaces available to search from. * - * @return The found interface vertex. + * @return The found interface vertex. */ QSharedPointer getInterface(QString const& interfaceName, QString const& instanceName, QVector > const& instanceInterfaces) const; @@ -416,10 +416,10 @@ class ConnectivityGraphFactory /*! * Finds the top-level interface vertex for the given interface. * - * @param [in] interfaceName The name of the interface to find. - * @param [in] topInterfaces The interfaces available to search from. + * @param [in] interfaceName The name of the interface to find. + * @param [in] topInterfaces The interfaces available to search from. * - * @return The found interface vertex. + * @return The found interface vertex. */ QSharedPointer getTopInterface(QString const& interfaceName, QVector > const& topInterfaces) const; @@ -427,20 +427,20 @@ class ConnectivityGraphFactory /*! * Finds the given view in a component. * - * @param [in] component The component to search the view for. - * @param [in] viewName The name of the view. + * @param [in] component The component to search the view for. + * @param [in] viewName The name of the view. * - * @return The view with the given name. + * @return The view with the given name. */ QSharedPointer findView(QSharedPointer component, QString const& viewName) const; /*! * Creates the graph edges for the given channel. * - * @param [in] channel The channel to transform into edge(s). - * @param [in] instanceName The name of the containing component instance. - * @param [in] instanceInterfaces The interface vertices of the instance. - * @param [in/out] graph The graph to add elements into. + * @param [in] channel The channel to transform into edge(s). + * @param [in] instanceName The name of the containing component instance. + * @param [in] instanceInterfaces The interface vertices of the instance. + * @param [in/out] graph The graph to add elements into. */ void createInternalConnectionsForChannel(QSharedPointer channel, QString const& instanceName, QVector > instanceInterfaces, @@ -449,10 +449,10 @@ class ConnectivityGraphFactory /*! * Creates the graph edges for the given transparently bridged bus interface. * - * @param [in] busInterface The interface whose bridge(s) to transform into edge(s). - * @param [in] instanceName The name of the containing component instance. - * @param [in] instanceInterfaces The interface vertices of the instance. - * @param [in/out] graph The graph to add elements into. + * @param [in] busInterface The interface whose bridge(s) to transform into edge(s). + * @param [in] instanceName The name of the containing component instance. + * @param [in] instanceInterfaces The interface vertices of the instance. + * @param [in/out] graph The graph to add elements into. */ void createInternalConnectionsForTransparentBridge(QSharedPointer busInterface, QString const& instanceName, QVector > const& instanceInterfaces, @@ -461,11 +461,11 @@ class ConnectivityGraphFactory /*! * Creates the graph edges for the given opaquely bridged bus interface. * - * @param [in] busInterface The interface whose bridge(s) to transform into edge(s). - * @param [in] instanceName The name of the containing component instance. - * @param [in] instanceInterfaces The interface vertices of the instance. - * @param [in/out] graph The graph to add elements into. - * @param [in] component The containing component. + * @param [in] busInterface The interface whose bridge(s) to transform into edge(s). + * @param [in] instanceName The name of the containing component instance. + * @param [in] instanceInterfaces The interface vertices of the instance. + * @param [in/out] graph The graph to add elements into. + * @param [in] component The containing component. */ void createInternalConnectionsForOpaqueBridge(QSharedPointer busInterface, QString const& instanceName, QVector > const& instanceInterfaces, @@ -474,10 +474,10 @@ class ConnectivityGraphFactory /*! * Get the design configuration from the selected view. * - * @param [in] component The component containing the selected view. - * @param [in] hierarchicalView The selected view. + * @param [in] component The component containing the selected view. + * @param [in] hierarchicalView The selected view. * - * @return The design configuration referenced by the selected view. + * @return The design configuration referenced by the selected view. */ QSharedPointer getHierarchicalDesignConfiguration( QSharedPointer component, QSharedPointer hierarchicalView) const; @@ -485,11 +485,11 @@ class ConnectivityGraphFactory /*! * Get the design from the selected view. * - * @param [in] component Component containing the selected view. - * @param [in] hierarchicalView The selected view. - * @param [in] designConfiguration Design configuration referenced by the selected view. + * @param [in] component Component containing the selected view. + * @param [in] hierarchicalView The selected view. + * @param [in] designConfiguration Design configuration referenced by the selected view. * - * @return The design referenced by the selected view. + * @return The design referenced by the selected view. */ QSharedPointer getHierarchicalDesign(QSharedPointer component, QSharedPointer hierarchicalView, @@ -498,10 +498,10 @@ class ConnectivityGraphFactory /*! * Gets the VLNV of the design referenced by the selected view. * - * @param [in] component Component containing the selected view. - * @param [in] hierarchicalView The selected view. + * @param [in] component Component containing the selected view. + * @param [in] hierarchicalView The selected view. * - * @return The VLNV of the design referenced by the selected view. + * @return The VLNV of the design referenced by the selected view. */ VLNV getHierarchicalDesignVLNV(QSharedPointer component, QSharedPointer hierarchicalView) const; @@ -509,12 +509,12 @@ class ConnectivityGraphFactory /*! * Creates an interconnection representation between bus interfaces. * - * @param [in] connectionName Name of the interconnection. - * @param [in] startPoint The starting interface of the connection. - * @param [in] endPoint The ending interface of the connection. - * @param [in/out] graph The graph to add elements into. + * @param [in] connectionName Name of the interconnection. + * @param [in] startPoint The starting interface of the connection. + * @param [in] endPoint The ending interface of the connection. + * @param [in/out] graph The graph to add elements into. * - * @return The graph representation for the interface. + * @return The graph representation for the interface. */ void createConnectionData(QString const& connectionName, QSharedPointer startPoint, QSharedPointer endPoint, QSharedPointer graph) const; diff --git a/editors/MemoryDesigner/ConnectivityInterface.h b/editors/MemoryDesigner/ConnectivityInterface.h index a8afaedd6..a0720df90 100644 --- a/editors/MemoryDesigner/ConnectivityInterface.h +++ b/editors/MemoryDesigner/ConnectivityInterface.h @@ -31,7 +31,7 @@ class ConnectivityInterface /*! * The constructor. * - * @param [in] name The name of the interface. + * @param [in] name The name of the interface. */ explicit ConnectivityInterface(QString const& name); @@ -43,98 +43,98 @@ class ConnectivityInterface /*! * Gets the name of the interface. * - * @return The name of the interface. + * @return The name of the interface. */ QString getName() const; /*! * Sets the mode for the interface. * - * @param [in] newMode The mode to set. + * @param [in] newMode The mode to set. */ void setMode(General::InterfaceMode newMode); /*! * Gets the mode of the interface. * - * @return The mode of the interface. + * @return The mode of the interface. */ General::InterfaceMode getMode() const; /*! * Sets the base address for the memories connected to the interface. * - * @param [in] address The base address to set. + * @param [in] address The base address to set. */ void setBaseAddress(QString const& address); /*! * Gets the base address for the memories connected to the interface. * - * @return The base address for the memories connected to the interface. + * @return The base address for the memories connected to the interface. */ QString getBaseAddress() const; /*! * Sets the remap address for the memories connected to the interface. * - * @param [in] address The remap address to set. + * @param [in] address The remap address to set. */ void setRemapAddress(QString const& address); /*! * Gets the remap address for the memories connected to the interface. * - * @return The remap address. + * @return The remap address. */ QString getRemapAddress() const; /*! * Sets the remap range for the memories connected to the interface. * - * @param [in] range The range to set. + * @param [in] range The range to set. */ void setRemapRange(QString const& range); /*! * Gets the remap range for the memories connected to the interface. * - * @return The remap range. + * @return The remap range. */ QString getRemapRange() const; /*! * Sets the instance the interface is a part of. * - * @param [in] instance The instance to set. + * @param [in] instance The instance to set. */ void setInstance(QSharedPointer instance); /*! * Gets the instance the interface is part of. * - * @return The instance containing the interface. + * @return The instance containing the interface. */ QSharedPointer getInstance() const; /*! * Checks if the interface is associated with a memory. * - * @return True, if the interface is connected to a memory, otherwise false. + * @return True, if the interface is connected to a memory, otherwise false. */ bool isConnectedToMemory() const; /*! * Sets the associated memory for the interface. * - * @param [in] memory The memory to associate the interface with. + * @param [in] memory The memory to associate the interface with. */ void setConnectedMemory(QSharedPointer memory); /*! * Gets the memory associated with the interface. * - * @return The associated memory if any. + * @return The associated memory if any. */ QSharedPointer getConnectedMemory() const; @@ -144,7 +144,7 @@ class ConnectivityInterface /*! * Checks if the interface is hierarchical. * - * @return True, if the interface is hierarchical, otherwise false. + * @return True, if the interface is hierarchical, otherwise false. */ bool isHierarchical() const; @@ -154,28 +154,28 @@ class ConnectivityInterface /*! * Checks if the interface is bridged. * - * @return True, if the interface is bridged, otherwise false. + * @return True, if the interface is bridged, otherwise false. */ bool isBridged() const; /*! * Get the next interface nodes for a connection tree. * - * @return List of the next interface nodes. + * @return List of the next interface nodes. */ QVector > getChildInterfaceNodes() const; /*! * Add an interface node to the tree. * - * @param [in] newChild The new tree interface node. + * @param [in] newChild The new tree interface node. */ void addChildInterfaceNode(QSharedPointer newChild); /*! * Remove a node from the tree. * - * @param [in] indexOfInterface Index of the tree node. + * @param [in] indexOfInterface Index of the tree node. */ void removeChildInterface(int const& indexOfInterface); diff --git a/editors/MemoryDesigner/FieldGraphicsItem.h b/editors/MemoryDesigner/FieldGraphicsItem.h index 66dbde0fd..88c461cb7 100644 --- a/editors/MemoryDesigner/FieldGraphicsItem.h +++ b/editors/MemoryDesigner/FieldGraphicsItem.h @@ -38,18 +38,18 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * The constructor. * - * @param [in] fieldName Name of the field. - * @param [in] displayName Display name of the field. - * @param [in] fieldOffset Offset of the field. - * @param [in] fieldLastBit Last bit used by the field. - * @param [in] fieldWidth Width of the field. - * @param [in] fieldHeight Height of the field. - * @param [in] isEmptyField Value for empty fields. - * @param [in] identifierChain Chain of strings identifying this item. - * @param [in] labelFont Font for the field labels. - * @param [in] containingInstance Name of the containing component instance. - * @param [in] isOutsideRegister Holds whether the field is out of bounds of the register or not. - * @param [in] parentItem The parent graphics item. + * @param [in] fieldName Name of the field. + * @param [in] displayName Display name of the field. + * @param [in] fieldOffset Offset of the field. + * @param [in] fieldLastBit Last bit used by the field. + * @param [in] fieldWidth Width of the field. + * @param [in] fieldHeight Height of the field. + * @param [in] isEmptyField Value for empty fields. + * @param [in] identifierChain Chain of strings identifying this item. + * @param [in] labelFont Font for the field labels. + * @param [in] containingInstance Name of the containing component instance. + * @param [in] isOutsideRegister Holds whether the field is out of bounds of the register or not. + * @param [in] parentItem The parent graphics item. */ FieldGraphicsItem(QSharedPointer fieldItem, quint64 fieldOffset, quint64 fieldLastBit, qreal fieldWidth, quint64 fieldHeight, bool isEmptyField, QVector identifierChain, @@ -69,30 +69,30 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Condense this graphics item. * - * @param [in] newItemHeight The new height. + * @param [in] newItemHeight The new height. */ virtual void condense(qreal newItemHeight); /*! * Change the width. * - * @param [in] widthChange Change in width.. + * @param [in] widthChange Change in width.. */ void changeWidth(qreal widthChange); /*! * Get the needed change in width to fully display the name label within this item. * - * @return The needed change in width to fully display the name label within this item. + * @return The needed change in width to fully display the name label within this item. */ qreal getNeededWithChangeToDisplayFullName() const; /*! * Add an overlap field item from the overlapping field graphics item. * - * @param [in] overlappingFieldItem The overlapping field graphics item. - * @param [in] overlapBrush Brush used to draw the overlap item. - * @param [in] containingScene Scene containing the overlapping field item. + * @param [in] overlappingFieldItem The overlapping field graphics item. + * @param [in] overlapBrush Brush used to draw the overlap item. + * @param [in] containingScene Scene containing the overlapping field item. */ void addOverlappingFieldItem(FieldGraphicsItem* overlappingFieldItem, QBrush overlapBrush, QGraphicsScene* containingScene); @@ -100,7 +100,7 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the text from the combined range label. * - * @return The text contained within the combined range label. + * @return The text contained within the combined range label. */ QString getCombinedRangeText() const; @@ -114,14 +114,14 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Handler for the mouse press event. * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ virtual void mousePressEvent(QGraphicsSceneMouseEvent *event); /*! * Handler for the hover leave event. * - * @param [in] event The hover leave event. + * @param [in] event The hover leave event. */ virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event); @@ -133,7 +133,7 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Set colors for ranges in an empty field graphics item. * - * @param [in] emptyItemRangeColour The color for the empty field item ranges. + * @param [in] emptyItemRangeColour The color for the empty field item ranges. */ virtual void setEmptyItemRangeColors(QColor emptyItemRangeColour); @@ -145,24 +145,24 @@ class FieldGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Fit the name label to the boundaries of the item. * - * @param [in] nameLabel The selected name label. + * @param [in] nameLabel The selected name label. */ void fitNameToBoundaries(QGraphicsTextItem* nameLabel); /*! * Create the rectangle for containing the overlapping field items. * - * @param [in] rectanglePositionY Y coordinate of the rectangle. - * @param [in] fieldRectangle The field bounding rectangle. - * @param [in] containingScene Scene containing the field item. + * @param [in] rectanglePositionY Y coordinate of the rectangle. + * @param [in] fieldRectangle The field bounding rectangle. + * @param [in] containingScene Scene containing the field item. */ void createOverlapRectangle(qreal rectanglePositionY, QRectF fieldRectangle, QGraphicsScene* containingScene); /*! * Setup the rectangle containing the overlapping field items. * - * @param [in] currentOverlapHeight Current height of the overlapping rectangle. - * @param [in] newOverlapItem The new overlapping field item. + * @param [in] currentOverlapHeight Current height of the overlapping rectangle. + * @param [in] newOverlapItem The new overlapping field item. */ void setupOverlapRectangle(qreal currentOverlapHeight, FieldGraphicsItem* newOverlapItem); diff --git a/editors/MemoryDesigner/FieldOverlapItem.h b/editors/MemoryDesigner/FieldOverlapItem.h index 9de626475..7a82058c1 100644 --- a/editors/MemoryDesigner/FieldOverlapItem.h +++ b/editors/MemoryDesigner/FieldOverlapItem.h @@ -33,11 +33,11 @@ class FieldOverlapItem : public QGraphicsRectItem /*! * The constructor. * - * @param [in] overlappingFieldItem Field graphics item from which this overlap item is created from. - * @param [in] containingScene Graphics scene containing the field graphics item. - * @param [in] overlapBrush Brush used to draw the overlap item. - * @param [in] labelFont Font used by the labels. - * @param [in] parentItem The parent graphics item. + * @param [in] overlappingFieldItem Field graphics item from which this overlap item is created from. + * @param [in] containingScene Graphics scene containing the field graphics item. + * @param [in] overlapBrush Brush used to draw the overlap item. + * @param [in] labelFont Font used by the labels. + * @param [in] parentItem The parent graphics item. */ FieldOverlapItem(FieldGraphicsItem* overlappingFieldItem, QGraphicsScene* containingScene, QBrush overlapBrush, QFont labelFont, QGraphicsItem* parentItem = 0); @@ -55,8 +55,8 @@ class FieldOverlapItem : public QGraphicsRectItem /*! * Resize this item to match the selected rectangle. * - * @param [in] rectangle The selected rectangle. - * @param [in] rectangleLineWidth Line width of the selected rectangle. + * @param [in] rectangle The selected rectangle. + * @param [in] rectangleLineWidth Line width of the selected rectangle. */ void resizeToRectangle(QRectF rectangle, int rectangleLineWidth); @@ -73,7 +73,7 @@ class FieldOverlapItem : public QGraphicsRectItem /*! * Fit the name label to the boundaries of the item. * - * @param [in] nameLabel The selected name label. + * @param [in] nameLabel The selected name label. */ void fitNameToBoundaries(QGraphicsTextItem* nameLabel); diff --git a/editors/MemoryDesigner/MainMemoryGraphicsItem.h b/editors/MemoryDesigner/MainMemoryGraphicsItem.h index bedcbb207..e74817113 100644 --- a/editors/MemoryDesigner/MainMemoryGraphicsItem.h +++ b/editors/MemoryDesigner/MainMemoryGraphicsItem.h @@ -37,12 +37,12 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * The constructor. * - * @param [in] memoryItem Memory item data. - * @param [in] containingInstance The containing instance. - * @param [in] subItemType Type of the memory sub items. - * @param [in] filterSubItems Value for filtering sub items. - * @param [in] identifierChain Chain of strings identifying this item. - * @param [in] parent The parent item. + * @param [in] memoryItem Memory item data. + * @param [in] containingInstance The containing instance. + * @param [in] subItemType Type of the memory sub items. + * @param [in] filterSubItems Value for filtering sub items. + * @param [in] identifierChain Chain of strings identifying this item. + * @param [in] parent The parent item. */ MainMemoryGraphicsItem(QSharedPointer memoryItem, QSharedPointer containingInstance, QString const& subItemType, @@ -56,87 +56,87 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * Add a memory connection to this item. * - * @param [in] connectionItem The selected memory connection item. + * @param [in] connectionItem The selected memory connection item. */ virtual void addMemoryConnection(MemoryConnectionItem* connectionItem); /*! * Get the memory collision items contained within this item. * - * @return Memory collision items contained within this item. + * @return Memory collision items contained within this item. */ QVector getMemoryCollisions() const; /*! * Compress the item and the sub items. * - * @param [in] compressMemoryItems Flag for compressing the memory items. + * @param [in] compressMemoryItems Flag for compressing the memory items. */ void compressItemAndChildItems(bool compressMemoryItems); /*! * Get the used coordinates of the item and all the connected items. * - * @param [in] visitedItems List of the visited memory items. - * @param [in] visitedConnections List of the visited memory connections. + * @param [in] visitedItems List of the visited memory items. + * @param [in] visitedConnections List of the visited memory connections. * - * @return List of visible coordinates. + * @return List of visible coordinates. */ QVector getUncutCoordinatesFromSet(QVector& visitedItems, QVector& visitedConnections); /*! * Move memory item and all the connected memory connections and the connected memory items. * - * @param [in] yTransfer The amount of movement in the y-coordinate. + * @param [in] yTransfer The amount of movement in the y-coordinate. */ void moveItemAndConnectedItems(qreal yTransfer); /*! * Get the last memory connection item connected to this memory graphics item. * - * @return The last memory connection item connected to this memory graphics item. + * @return The last memory connection item connected to this memory graphics item. */ MemoryConnectionItem* getLastConnection() const; /*! * Get the first memory connection item connected to this memory graphics item. * - * @return The memory connection item with the lowest base address. + * @return The memory connection item with the lowest base address. */ MemoryConnectionItem* getFirstConnection() const; /*! * Check if the memory graphics item has been compressed. * - * @return True, if the item has been compressed, false otherwise. + * @return True, if the item has been compressed, false otherwise. */ bool isCompressed() const; /*! * Set a memory extension item for this graphics item. * - * @param [in] newExtensionItem The new memory extension item. + * @param [in] newExtensionItem The new memory extension item. */ void setExtensionItem(MemoryExtensionGraphicsItem* newExtensionItem); /*! * Get the memory extension item contained within this graphics item. * - * @return The memory extension item contained within this graphics item. + * @return The memory extension item contained within this graphics item. */ MemoryExtensionGraphicsItem* getExtensionItem() const; /*! * Check whether this item has a memory extension item. * - * @return True, if a memory extension item exists, false otherwise. + * @return True, if a memory extension item exists, false otherwise. */ bool hasExtensionItem() const; /*! * Get the memory item from which this graphics item has been constructed from. * - * @return The contained memory item. + * @return The contained memory item. */ QSharedPointer getMemoryItem() const; @@ -148,25 +148,25 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * Check if the memory map is connected to any of the selected address spaces. * - * @param [in] spaceItems List of the selected address space graphics items. + * @param [in] spaceItems List of the selected address space graphics items. * - * @return True, if the memory map is connected to any of the selected address spaces. + * @return True, if the memory map is connected to any of the selected address spaces. */ bool isConnectedToSpaceItems(QVector spaceItems) const; /*! * Get the chained address space items connected to this item. * - * @return All the chained address space items connected to this item. + * @return All the chained address space items connected to this item. */ QVector getChainedSpaceItems() const; /*! * Compress this item to the uncut coordinates. * - * @param [in] unCutCoordinates List of the coordinates that are retained after compression. - * @param [in] CUTMODIFIER The modifier for the size of the cut area. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] unCutCoordinates List of the coordinates that are retained after compression. + * @param [in] CUTMODIFIER The modifier for the size of the cut area. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. */ virtual void compressToUnCutCoordinates(QVector unCutCoordinates, const qreal CUTMODIFIER, bool memoryItemsAreCompressed); @@ -174,28 +174,28 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * Change the address range of this item and its sub items. * - * @param [in] offsetChange The offset change of the item. + * @param [in] offsetChange The offset change of the item. */ virtual void changeAddressRange(quint64 offsetChange); /*! * Get the lowest point of all the connected memory items. * - * @return The lowest point of all the connected memory items. + * @return The lowest point of all the connected memory items. */ qreal getLowestPointOfConnectedItems(); /*! * Get the lowest base address of all the connected memory items. * - * @return The lowest base address of all the connected memory items. + * @return The lowest base address of all the connected memory items. */ quint64 getLowestConnectedBaseAddress() const; /*! * Get the highest last address of all the connected memory items. * - * @return The highest last address of all the connected memory items. + * @return The highest last address of all the connected memory items. */ quint64 getHighestConnectedLastAddress() const; @@ -209,23 +209,23 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * Get the instance name label. * - * @return Graphics text item containing the name of the containing component instance. + * @return Graphics text item containing the name of the containing component instance. */ QGraphicsTextItem* getInstanceNameLabel() const; /*! * Set a new compression value. * - * @param [in] newCompressValue The new memory compression value. + * @param [in] newCompressValue The new memory compression value. */ void setCompressed(bool newCompressValue); /*! * Get all the connections from connected memory items. * - * @param [in] visitedMemoryItems List of all the memory items that have been checked. + * @param [in] visitedMemoryItems List of all the memory items that have been checked. * - * @return All the connections from the connected memory items. + * @return All the connections from the connected memory items. */ QMultiMap getAllConnectionsFromConnectedItems( QSharedPointer > visitedMemoryItems) const; @@ -238,24 +238,24 @@ class MainMemoryGraphicsItem : public MemoryDesignerGraphicsItem, public SubMemo /*! * Get the available width for this item. * - * @return Available width for this item. + * @return Available width for this item. */ virtual qreal getItemWidth() const; /*! * Check if the selected label collides with range labels. * - * @param [in] label The selected label. - * @param [in] height Height of the label text. + * @param [in] label The selected label. + * @param [in] height Height of the label text. * - * @return True, if the selected label collides with range labels, false otherwise. + * @return True, if the selected label collides with range labels, false otherwise. */ virtual bool labelCollidesWithRangeLabels(QGraphicsTextItem* label, qreal fontHeight) const; /*! * Get the minimum height required to display for the memory item. * - * @return The minimum height required to display the memory item. + * @return The minimum height required to display the memory item. */ virtual qreal getMinimumHeightForSubItems() const = 0; diff --git a/editors/MemoryDesigner/MasterSlavePathSearch.h b/editors/MemoryDesigner/MasterSlavePathSearch.h index 2030ac66f..c239eb300 100644 --- a/editors/MemoryDesigner/MasterSlavePathSearch.h +++ b/editors/MemoryDesigner/MasterSlavePathSearch.h @@ -36,10 +36,10 @@ class MasterSlavePathSearch /*! * Finds all paths from master interfaces to slave interfaces. * - * @param [in] graph The connectivity graph to find the paths from. - * @param [in] allowOverlappingPaths Flag for allowing overlapping paths in the path search. + * @param [in] graph The connectivity graph to find the paths from. + * @param [in] allowOverlappingPaths Flag for allowing overlapping paths in the path search. * - * @return All paths from master interfaces. + * @return All paths from master interfaces. */ QVector > > findMasterSlavePaths( QSharedPointer graph, bool allowOverlappingPaths) const; @@ -49,9 +49,9 @@ class MasterSlavePathSearch /*! * Finds the bottom-most master interfaces for the starting points of the paths. * - * @param [in] graph The connectivity graph to find the interfaces from. + * @param [in] graph The connectivity graph to find the interfaces from. * - * @return The master interfaces for path start points. + * @return The master interfaces for path start points. */ QVector > findInitialMasterInterfaces( QSharedPointer graph) const; @@ -59,45 +59,45 @@ class MasterSlavePathSearch /*! * Check if the selected interface is a starting interface. * - * @param [in] vertex The selected interface. + * @param [in] vertex The selected interface. * - * @return True, if the interface is a starting interface, false otherwise. + * @return True, if the interface is a starting interface, false otherwise. */ bool isStartInterface(QSharedPointer vertex) const; /*! * Check if the selected interface is connected to a memory item. * - * @param [in] vertex The selected interface. + * @param [in] vertex The selected interface. * - * @return True, if the interface is a starting interface, false otherwise. + * @return True, if the interface is a starting interface, false otherwise. */ bool isConnectedToMemory(QSharedPointer vertex) const; /*! * Check if the selected interface is connected to a subspace map. * - * @param [in] vertex The selected interface. + * @param [in] vertex The selected interface. * - * @return True, if the interface is connected to a subspace map, false otherwise. + * @return True, if the interface is connected to a subspace map, false otherwise. */ bool isConnectedToSubspaceMap(QSharedPointer vertex) const; /*! * Finds all the paths branching from the given start vertex. * - * @param [in] startVertex The vertex to start the search from. - * @param [in] graph The connectivity graph to find the paths from. + * @param [in] startVertex The vertex to start the search from. + * @param [in] graph The connectivity graph to find the paths from. */ QVector findPaths(QSharedPointer startVertex, QSharedPointer graph) const; /*! * Find the interface connected to the selected interface. * - * @param [in] startInterface The selected interface. - * @param [in] edge The connection between the two interfaces. + * @param [in] startInterface The selected interface. + * @param [in] edge The connection between the two interfaces. * - * @return The interface connected to the selected interface. + * @return The interface connected to the selected interface. */ QSharedPointer findConnectedInterface( QSharedPointer startInterface, @@ -106,10 +106,10 @@ class MasterSlavePathSearch /*! * Check if the selected interfaces can be connected. * - * @param [in] startVertex The starting interface. - * @param [in] endVertex The end interface. + * @param [in] startVertex The starting interface. + * @param [in] endVertex The end interface. * - * @return True, if the interfaces can be connected, false otherwise. + * @return True, if the interfaces can be connected, false otherwise. */ bool canConnectInterfaces(QSharedPointer startVertex, QSharedPointer endVertex) const; @@ -117,29 +117,29 @@ class MasterSlavePathSearch /*! * Finds the path to the given vertex from the BFS tree root. * - * @param [in] endVertex The final (leaf) vertex of the path. + * @param [in] endVertex The final (leaf) vertex of the path. * - * @return The path from BFS tree root to the end vertex. + * @return The path from BFS tree root to the end vertex. */ MasterSlavePathSearch::Path findPathFromRoot(QSharedPointer endVertex) const; /*! * Finds the valid, longest paths in the given set of paths. * - * @param [in] paths The paths to search. - * @param [in] allowOverlappingPaths Flag for allowing overlapping paths in the path search. + * @param [in] paths The paths to search. + * @param [in] allowOverlappingPaths Flag for allowing overlapping paths in the path search. * - * @return The valid paths found in the set. + * @return The valid paths found in the set. */ QVector findValidPathsIn(QVector const& paths, bool allowOverlappingPaths) const; /*! * Check if the selected path should be kept in the master paths. * - * @param [in] currentPath The selected path. - * @param [in] availablePaths All the available paths. + * @param [in] currentPath The selected path. + * @param [in] availablePaths All the available paths. * - * @return True, if the path is a master path, otherwise false. + * @return True, if the path is a master path, otherwise false. */ bool pathIsFullPath(MasterSlavePathSearch::Path const& currentPath, QVector const& availablePaths) const; @@ -147,11 +147,11 @@ class MasterSlavePathSearch /*! * Check if a path contains another path. * - * @param [in] pathOne The first selected path. - * @param [in] pathTwo The second selected path. - * @param [in] areaSize Size of the smaller path. + * @param [in] pathOne The first selected path. + * @param [in] pathTwo The second selected path. + * @param [in] areaSize Size of the smaller path. * - * @return True, if another of the selected paths contains the other, false otherwise. + * @return True, if another of the selected paths contains the other, false otherwise. */ bool pathContainsAnotherPath(QVector > const& pathOne, QVector > const& pathTwo, int areaSize) const; @@ -159,9 +159,9 @@ class MasterSlavePathSearch /*! * Check if the path ends in a memory map. * - * @param [in] path The selected path. + * @param [in] path The selected path. * - * @return True, if the selected path ends in a memory map, false otherwise. + * @return True, if the selected path ends in a memory map, false otherwise. */ bool pathEndsInMemoryMap(QVector > const& path) const; diff --git a/editors/MemoryDesigner/MemoryCollisionItem.h b/editors/MemoryDesigner/MemoryCollisionItem.h index 95cd8238e..c9d31c31b 100644 --- a/editors/MemoryDesigner/MemoryCollisionItem.h +++ b/editors/MemoryDesigner/MemoryCollisionItem.h @@ -29,9 +29,9 @@ class MemoryCollisionItem : public QObject, public QGraphicsRectItem /*! * The constructor. * - * @param [in] firstItem The first memory connection. - * @param [in] secondItem The second memory connection. - * @param [in] containingScene The scene containing the memory connections. + * @param [in] firstItem The first memory connection. + * @param [in] secondItem The second memory connection. + * @param [in] containingScene The scene containing the memory connections. */ MemoryCollisionItem(MemoryConnectionItem* firstItem, MemoryConnectionItem* secondItem, QGraphicsScene* containingScene); diff --git a/editors/MemoryDesigner/MemoryColumn.h b/editors/MemoryDesigner/MemoryColumn.h index ef96fc422..b9ed3bfc5 100644 --- a/editors/MemoryDesigner/MemoryColumn.h +++ b/editors/MemoryDesigner/MemoryColumn.h @@ -40,9 +40,9 @@ class MemoryColumn : public GraphicsColumn /*! * Constructor. * - * @param [in] name The column description. - * @param [in] layout The parent column layout. - * @param [in] itemSpacing Spacing for the graphics items. + * @param [in] name The column description. + * @param [in] layout The parent column layout. + * @param [in] itemSpacing Spacing for the graphics items. */ MemoryColumn(QSharedPointer desc, GraphicsColumnLayout* layout, int itemSpacing = 30); @@ -54,9 +54,9 @@ class MemoryColumn : public GraphicsColumn /*! * Find a graphics item by a given memory item. * - * @param [in] containedMemoryItem The selected memory item. + * @param [in] containedMemoryItem The selected memory item. * - * @return Memory graphics item matching the selected memory item. + * @return Memory graphics item matching the selected memory item. */ MainMemoryGraphicsItem* findGraphicsItemByMemoryItem(QSharedPointer containedMemoryItem) const; @@ -69,21 +69,21 @@ class MemoryColumn : public GraphicsColumn /*! * Get the main memory graphics items contained within this column in the order of their scene positions. * - * @return Map containing y-coordinate, main memory graphics item pairs. + * @return Map containing y-coordinate, main memory graphics item pairs. */ QMultiMap getGraphicsItemInOrder() const; /*! * Check if the memory column contains memory map graphics items. * - * @return True, if the column contains memory map graphics items, false otherwise. + * @return True, if the column contains memory map graphics items, false otherwise. */ bool containsMemoryMapItems() const; /*! * Change the width of the memory column and the contained memory map graphics items. * - * @param [in] deltaWidth Change of width. + * @param [in] deltaWidth Change of width. */ void changeWidth(qreal deltaWidth); @@ -91,29 +91,29 @@ class MemoryColumn : public GraphicsColumn * Get the maximum needed change in width to display the name labels of all the field items contained within * the memory map items. * - * @return The maximum needed change in width to display the name labels of all the field items. + * @return The maximum needed change in width to display the name labels of all the field items. */ qreal getMaximumNeededChangeInWidth() const; /*! * Move the unconnected memory items to the bottom of the column. * - * @param [in] placedItems List of the connected items of the column. + * @param [in] placedItems List of the connected items of the column. */ void moveUnconnectedMemoryItems(QSharedPointer > placedItems) const; /*! * Check if a memory map overlaps within this column. * - * @param [in] connectionBaseAddress Lowest base address of the connections in the selected memory item. - * @param [in] connectionLastAddress Highest last address of the connections in the selected memory item. - * @param [in] memoryGraphicsItem The selected memory map item. - * @param [in] memoryItemRect Bounding rectangle of the selected memory map item. - * @param [in] memoryPenWidth Line width of the memory map item. - * @param [in] connectedSpaceItems List of address space items connected to the memory map item. - * @param [in] placedMaps List of the placed memory map items. + * @param [in] connectionBaseAddress Lowest base address of the connections in the selected memory item. + * @param [in] connectionLastAddress Highest last address of the connections in the selected memory item. + * @param [in] memoryGraphicsItem The selected memory map item. + * @param [in] memoryItemRect Bounding rectangle of the selected memory map item. + * @param [in] memoryPenWidth Line width of the memory map item. + * @param [in] connectedSpaceItems List of address space items connected to the memory map item. + * @param [in] placedMaps List of the placed memory map items. * - * @return True if the memory map overlaps another item in this column, false otherwise. + * @return True if the memory map overlaps another item in this column, false otherwise. */ bool memoryMapOverlapsInColumn(quint64 connectionBaseAddress, quint64 connectionLastAddress, MainMemoryGraphicsItem const* memoryGraphicsItem, QRectF memoryItemRect, int memoryPenWidth, @@ -123,12 +123,12 @@ class MemoryColumn : public GraphicsColumn /*! * Check if the item overlaps another placed column item. * - * @param [in] memoryItem The selected memory item. - * @param [in] itemRectangle Scene rectangle of the memory item. - * @param [in] lineWidth Line width of the rectangle. - * @param [in] placedItems List of the placed memory items. + * @param [in] memoryItem The selected memory item. + * @param [in] itemRectangle Scene rectangle of the memory item. + * @param [in] lineWidth Line width of the rectangle. + * @param [in] placedItems List of the placed memory items. * - * @return True, if the item overlaps another placed item, false otherwise. + * @return True, if the item overlaps another placed item, false otherwise. */ bool itemOverlapsAnotherPlacedColumnItem(MainMemoryGraphicsItem const* memoryItem, QRectF const& itemRectangle, int lineWidth, QSharedPointer > placedItems) const; @@ -136,8 +136,8 @@ class MemoryColumn : public GraphicsColumn /*! * Compress the unconnected memory items. * - * @param [in] compressMemoryItems Flag for compressing the memory items. - * @param [in] placedItems List of the placed memory items. + * @param [in] compressMemoryItems Flag for compressing the memory items. + * @param [in] placedItems List of the placed memory items. */ void compressUnconnectedMemoryItems(bool compressMemoryItems, QSharedPointer > placedItems); @@ -146,8 +146,8 @@ class MemoryColumn : public GraphicsColumn /*! * Returns true if the given item is allowed to reside in the column based on the allowed items. * - * @param [in] item The item. - * @param [in] allowedItems The allowed items flags. + * @param [in] item The item. + * @param [in] allowedItems The allowed items flags. */ virtual bool isItemAllowed(QGraphicsItem* item, unsigned int allowedItems) const; @@ -159,9 +159,9 @@ class MemoryColumn : public GraphicsColumn /*! * Get the position for the unconnected memory items. * - * @param [in] placedItems List of the placed memory graphics items. + * @param [in] placedItems List of the placed memory graphics items. * - * @return Y-coordinate for the unconnected memory items. + * @return Y-coordinate for the unconnected memory items. */ quint64 getUnconnectedItemPosition(QSharedPointer > placedItems) const; }; diff --git a/editors/MemoryDesigner/MemoryColumnHandler.h b/editors/MemoryDesigner/MemoryColumnHandler.h index 9c9cdd213..2ad13de54 100644 --- a/editors/MemoryDesigner/MemoryColumnHandler.h +++ b/editors/MemoryDesigner/MemoryColumnHandler.h @@ -27,7 +27,7 @@ class MemoryColumnHandler /*! * The constructor. * - * @param [in] layout Layout for the memory columns. + * @param [in] layout Layout for the memory columns. */ MemoryColumnHandler(QSharedPointer layout); @@ -39,65 +39,65 @@ class MemoryColumnHandler /*! * Set a new column width for memory map columns. * - * @param [in] newMapColumnWidth The new column width. + * @param [in] newMapColumnWidth The new column width. */ void setNewMemoryMapColumnWidth(int newMapColumnWidth); /*! * Get the width of the memory map columns. * - * @return Width of the memory map columns. + * @return Width of the memory map columns. */ int getMemoryMapColumnWidth() const; /*! * Set a new layout for the memory columns. * - * @param [in] newLayout The new layout for the memory columns. + * @param [in] newLayout The new layout for the memory columns. */ void setNewLayout(QSharedPointer newLayout); /*! * Get the memory columns. * - * @return The memory columns in the layout. + * @return The memory columns in the layout. */ QVector getMemoryColumns() const; /*! * Get the address space columns. * - * @return The address space columns in the layout. + * @return The address space columns in the layout. */ QVector getAddressSpaceColumns() const; /*! * Get the memory map columns. * - * @return The memory map columns in the layout. + * @return The memory map columns in the layout. */ QVector getMemoryMapColumns() const; /*! * Get the memory map overlap columns. * - * @return The memory map overlap columns in the layout. + * @return The memory map overlap columns in the layout. */ QVector getMapOverlapColumns() const; /*! * Get the column located at the given position. * - * @param [in] position Position of the selected column. + * @param [in] position Position of the selected column. * - * @return Column located at the given position, or 0, if no column was found. + * @return Column located at the given position, or 0, if no column was found. */ MemoryColumn* findColumnAtPosition(QPointF position) const; /*! * Remove the selected column from the layout. * - * @param [in] selectedColumn The selected column. + * @param [in] selectedColumn The selected column. */ void removeColumnFromLayout(MemoryColumn* selectedColumn); @@ -109,39 +109,39 @@ class MemoryColumnHandler /*! * Create an address space column. * - * @return The created address space column. + * @return The created address space column. */ MemoryColumn* createAddressSpaceColumn(); /*! * Create a new memory overlap column. * - * @return The created memory overlap column. + * @return The created memory overlap column. */ MemoryColumn* createMemoryOverlapColumn(); /*! * Get the selected memory column. * - * @param [in] columnName Name of the selected memory column. + * @param [in] columnName Name of the selected memory column. * - * @return The found memory column. + * @return The found memory column. */ MemoryColumn* findColumnByName(QString const& columnName) const; /*! * Get the specified columns. * - * @param [in] columnSpecification Identifier for the wanted columns. + * @param [in] columnSpecification Identifier for the wanted columns. * - * @return A vector containing the specified columns. + * @return A vector containing the specified columns. */ QVector getSpecifiedColumns(QString const& columnSpecification) const; /*! * Change the column widths by the selected amount. * - * @param [in] deltaWidth The selected width change. + * @param [in] deltaWidth The selected width change. */ void changeColumnWidths(qreal deltaWidth); diff --git a/editors/MemoryDesigner/MemoryConnectionAddressCalculator.h b/editors/MemoryDesigner/MemoryConnectionAddressCalculator.h index b68cefbb9..453eb486b 100644 --- a/editors/MemoryDesigner/MemoryConnectionAddressCalculator.h +++ b/editors/MemoryDesigner/MemoryConnectionAddressCalculator.h @@ -86,10 +86,10 @@ namespace MemoryConnectionAddressCalculator /*! * Get the starting base address of the memory connection. * - * @param [in] startInterface Start interface of the memory connection path. - * @param [in] endInterface End interface of the memory connection path. + * @param [in] startInterface Start interface of the memory connection path. + * @param [in] endInterface End interface of the memory connection path. * - * @return Starting base address of the memory connection. + * @return Starting base address of the memory connection. */ quint64 getStartingBaseAddress(QSharedPointer startInterface, QSharedPointer endInterface); @@ -106,13 +106,13 @@ namespace MemoryConnectionAddressCalculator /*! * Calculate the remapped base address for the memory connection. * - * @param [in] memoryMapBaseAddress Base address of the memory map item. - * @param [in] baseAddressNumber Base address of the memory connection. - * @param [in] spaceChainConnectionBaseAddress Base address modifier caused by the bridged interfaces. - * @param [in] mirroredSlaveAddressChange Address change caused by the mirrored slave interfaces. - * @param [in] hasRemapRange Flag for remapped connection range. + * @param [in] memoryMapBaseAddress Base address of the memory map item. + * @param [in] baseAddressNumber Base address of the memory connection. + * @param [in] spaceChainConnectionBaseAddress Base address modifier caused by the bridged interfaces. + * @param [in] mirroredSlaveAddressChange Address change caused by the mirrored slave interfaces. + * @param [in] hasRemapRange Flag for remapped connection range. * - * @return The remapped base address of the memory connection. + * @return The remapped base address of the memory connection. */ quint64 getRemappedBaseAddress(quint64 memoryMapBaseAddress, quint64 baseAddressNumber, quint64 spaceChainConnectionBaseAddress, quint64 mirroredSlaveAddressChange, bool hasRemapRange); diff --git a/editors/MemoryDesigner/MemoryConnectionHandler.h b/editors/MemoryDesigner/MemoryConnectionHandler.h index 5c0a7ffaf..0ac258aa9 100644 --- a/editors/MemoryDesigner/MemoryConnectionHandler.h +++ b/editors/MemoryDesigner/MemoryConnectionHandler.h @@ -42,7 +42,7 @@ class MemoryConnectionHandler /*! * The constructor. * - * @param [in] columnHandler Handler for memory columns. + * @param [in] columnHandler Handler for memory columns. */ MemoryConnectionHandler(QSharedPointer columnHandler); @@ -54,28 +54,28 @@ class MemoryConnectionHandler /*! * Change the condensing of memory graphics items. * - * @param [in] condenseMemoryItems Value for condensing memory graphics items. + * @param [in] condenseMemoryItems Value for condensing memory graphics items. */ void setCondenseMemoryItems(bool condenseMemoryItems); /*! * Check whether the memory graphics items are condensed or not. * - * @return True, if the memory graphics items are condensed, otherwise false. + * @return True, if the memory graphics items are condensed, otherwise false. */ bool memoryItemsAreCondensed() const; /*! * Set the filtering for chained address space memory connections. * - * @param [in] filterChains Value for the chained address space memory connection filtering. + * @param [in] filterChains Value for the chained address space memory connection filtering. */ void setFilterAddressSpaceChains(bool filterChains); /*! * Check whether the chained address space memory connections are filtered or not. * - * @return True, if the chained address space memory connections are filtered, false otherwise. + * @return True, if the chained address space memory connections are filtered, false otherwise. */ bool addressSpaceChainsAreFiltered() const; @@ -92,9 +92,9 @@ class MemoryConnectionHandler /*! * Create the connections and place the connected items. * - * @param [in] connectionGraph Graph containing the memory connection paths. - * @param [in] spaceColumn Column containing the address space graphics items. - * @param [in] memoryMapColumn Column containing the memory map graphics items. + * @param [in] connectionGraph Graph containing the memory connection paths. + * @param [in] spaceColumn Column containing the address space graphics items. + * @param [in] memoryMapColumn Column containing the memory map graphics items. */ void createConnectedItems(QSharedPointer connectionGraph, MemoryColumn* spaceColumn, @@ -108,19 +108,19 @@ class MemoryConnectionHandler /*! * Combine paths containing the same memory items. * - * @param [in] masterSlavePaths Interface paths from master to slave. + * @param [in] masterSlavePaths Interface paths from master to slave. * - * @return A list of combined path sets. + * @return A list of combined path sets. */ QVector > > findPathSets(QVector masterSlavePaths) const; /*! * Find the indexes of the path sets that the selected path belongs to. * - * @param [in] currentPath The selected path. - * @param [in] pathSets List of the path sets. + * @param [in] currentPath The selected path. + * @param [in] pathSets List of the path sets. * - * @return List of path set indexes. + * @return List of path set indexes. */ QQueue findPathSetIndexes(Path currentPath, QVector > > pathSets) const; @@ -128,20 +128,20 @@ class MemoryConnectionHandler /*! * Check if an interface of the selected path is contained with the selected path set. * - * @param [in] currentPath The selected path. - * @param [in] pathSet The selected comparison path set. + * @param [in] currentPath The selected path. + * @param [in] pathSet The selected comparison path set. * - * @return True, if an interface is contained within the path set, false otherwise. + * @return True, if an interface is contained within the path set, false otherwise. */ bool pathIsContainedWithPathSet(Path currentPath, QSharedPointer > pathSet) const; /*! * Check if the selected interface is contained within the selected path. * - * @param [in] pathInterface The selected interface. - * @param [in] comparisonPath The selected comparison path. + * @param [in] pathInterface The selected interface. + * @param [in] comparisonPath The selected comparison path. * - * @return True, if the interface is contained within the path, false otherwise. + * @return True, if the interface is contained within the path, false otherwise. */ bool interfacedItemIsWithinPath(QSharedPointer pathInterface, MemoryConnectionHandler::Path comparisonPath) const; @@ -149,14 +149,14 @@ class MemoryConnectionHandler /*! * Create a combined connection set from the selected path set. * - * @param [in] connectionSet The selected path set. - * @param [in] placedMapItems List of already placed memory map items. - * @param [in] memoryMapColumn The memory map column. - * @param [in] spaceYPlacement Placement of the top item in the connection set. - * @param [in] placedSpaceItems List of already placed address space items. - * @param [in] spaceColumn The address space column. + * @param [in] connectionSet The selected path set. + * @param [in] placedMapItems List of already placed memory map items. + * @param [in] memoryMapColumn The memory map column. + * @param [in] spaceYPlacement Placement of the top item in the connection set. + * @param [in] placedSpaceItems List of already placed address space items. + * @param [in] spaceColumn The address space column. * - * @return List of the created memory connections. + * @return List of the created memory connections. */ QVector createConnectionSet(QSharedPointer > connectionSet, QSharedPointer > placedMapItems, @@ -168,11 +168,11 @@ class MemoryConnectionHandler /*! * Create a connection from the set. * - * @param [in] connectionPath The connection path. - * @param [in] placedMapItems List of the already placed memory maps. - * @param [in] memoryMapColumn The memory map column. - * @param [in] placedSpaceItems List of the already placed address spaces. - * @param [in] spaceColumn The address space column. + * @param [in] connectionPath The connection path. + * @param [in] placedMapItems List of the already placed memory maps. + * @param [in] memoryMapColumn The memory map column. + * @param [in] placedSpaceItems List of the already placed address spaces. + * @param [in] spaceColumn The address space column. */ void createConnectionFromSet(Path const& connectionPath, QSharedPointer > placedMapItems, @@ -184,10 +184,10 @@ class MemoryConnectionHandler /*! * Get the main graphics item corresponding to the selected connection interface. * - * @param [in] connectionInterface The selected connection interface. - * @param [in] columnType The column type of the main graphics item. + * @param [in] connectionInterface The selected connection interface. + * @param [in] columnType The column type of the main graphics item. * - * @return The found main graphics item. + * @return The found main graphics item. */ MainMemoryGraphicsItem* getMainGraphicsItem(QSharedPointer connectionInterface, QString columnType) const; @@ -195,9 +195,9 @@ class MemoryConnectionHandler /*! * Get the starting interface that references an address space for the connection path. * - * @param [in] connectionPath The selected connection path. + * @param [in] connectionPath The selected connection path. * - * @return The starting interface for the connection. + * @return The starting interface for the connection. */ QSharedPointer getStartInterface( QVector > connectionPath); @@ -205,10 +205,10 @@ class MemoryConnectionHandler /*! * Get the end item for the memory connection. * - * @param [in] startInterface Start interface of the memory connection path. - * @param [in] endInterface End interface of the memory connection path. + * @param [in] startInterface Start interface of the memory connection path. + * @param [in] endInterface End interface of the memory connection path. * - * @return The end item of the memory connection. + * @return The end item of the memory connection. */ MainMemoryGraphicsItem* getConnectionEndItem(QSharedPointer startInterface, QSharedPointer endInterface) const; @@ -216,22 +216,22 @@ class MemoryConnectionHandler /*! * Get the local memory map graphics item of the selected address space interface. * - * @param [in] spaceInterface Interface node referencing the selected address space item. + * @param [in] spaceInterface Interface node referencing the selected address space item. * - * @return The local memory map graphics item of contained within the selected interface node. + * @return The local memory map graphics item of contained within the selected interface node. */ MainMemoryGraphicsItem* getLocalMemoryMapItem(QSharedPointer spaceInterface) const; /*! * Get the initial transfer in y-coordinate for the memory connection. * - * @param [in] baseAddressNumber Base address of the memory connection. - * @param [in] mirroredSlaveAddressChange Address change caused by the mirrored slave interfaces. - * @param [in] hasRemapRange Flag for remapped connection range. - * @param [in] memoryMapBaseAddress Base address of the connected memory map item. - * @param [in] spaceChainConnectionBaseAddress Base address modified caused by the bridged interfaces. + * @param [in] baseAddressNumber Base address of the memory connection. + * @param [in] mirroredSlaveAddressChange Address change caused by the mirrored slave interfaces. + * @param [in] hasRemapRange Flag for remapped connection range. + * @param [in] memoryMapBaseAddress Base address of the connected memory map item. + * @param [in] spaceChainConnectionBaseAddress Base address modified caused by the bridged interfaces. * - * @return The initial transfer value for the memory connection item. + * @return The initial transfer value for the memory connection item. */ qreal getConnectionInitialTransferY(quint64 baseAddressNumber, quint64 mirroredSlaveAddressChange, @@ -242,12 +242,12 @@ class MemoryConnectionHandler /*! * Place the memory map item. * - * @param [in] mapItem The connected memory map item. - * @param [in] startItem The connection starting item. - * @param [in] yTransfer The initial position of the connection from the starting memory item. - * @param [in] pathVariables The calculated variables for the connection. - * @param [in] placedMapItems List of the placed memory map items. - * @param [in] mapColumn The memory map column. + * @param [in] mapItem The connected memory map item. + * @param [in] startItem The connection starting item. + * @param [in] yTransfer The initial position of the connection from the starting memory item. + * @param [in] pathVariables The calculated variables for the connection. + * @param [in] placedMapItems List of the placed memory map items. + * @param [in] mapColumn The memory map column. */ void placeMemoryMap(MainMemoryGraphicsItem* mapItem, MainMemoryGraphicsItem* startItem, @@ -259,12 +259,12 @@ class MemoryConnectionHandler /*! * Check and reposition a memory map to a memory map overlap column if needed. * - * @param [in] connectionBaseAddress Lowest base address connected to the selected memory item. - * @param [in] connectionLastAddress Highest last address connected to the selected memory item. - * @param [in] placedMaps A list of placed memory map items. - * @param [in] memoryItem The selected memory map item. - * @param [in] originalColumn The original column of the memory map item. - * @param [in] connectionStartItem The start item of the memory map connection. + * @param [in] connectionBaseAddress Lowest base address connected to the selected memory item. + * @param [in] connectionLastAddress Highest last address connected to the selected memory item. + * @param [in] placedMaps A list of placed memory map items. + * @param [in] memoryItem The selected memory map item. + * @param [in] originalColumn The original column of the memory map item. + * @param [in] connectionStartItem The start item of the memory map connection. */ void checkMemoryMapRepositionToOverlapColumn(quint64 connectionBaseAddress, quint64 connectionLastAddress, @@ -276,21 +276,21 @@ class MemoryConnectionHandler /*! * Place the address space item. * - * @param [in] spaceItem The selected address space item. - * @param [in] placedSpaceItems List of the placed address space items. - * @param [in] originalColumn Original column of the address space items. - * @param [in] targetItem End item of the connection. - * @param [in] connectionBaseAddress Base address of the connection. + * @param [in] spaceItem The selected address space item. + * @param [in] placedSpaceItems List of the placed address space items. + * @param [in] originalColumn Original column of the address space items. + * @param [in] targetItem End item of the connection. + * @param [in] connectionBaseAddress Base address of the connection. */ void positionSpaceItem(MainMemoryGraphicsItem* spaceItem, qreal ypos); /*! * Place the address space item to a column. * - * @param [in] spaceItem The selected address space item. - * @param [in] spaceRectangle Scene rectangle of the new position for the address space item. - * @param [in] spaceLineWidth Line width of the address space item. - * @param [in] placedSpaceItems List of the placed address space items. + * @param [in] spaceItem The selected address space item. + * @param [in] spaceRectangle Scene rectangle of the new position for the address space item. + * @param [in] spaceLineWidth Line width of the address space item. + * @param [in] placedSpaceItems List of the placed address space items. */ void placeSpaceItemToColumn(MainMemoryGraphicsItem* spaceItem, QRectF const& spaceRectangle, @@ -300,13 +300,13 @@ class MemoryConnectionHandler /*! * Create the connection item. * - * @param [in] startItem The starting item of the connection. - * @param [in] endItem The end item of the connection. - * @param [in] remappedAddress Base address for the connection. - * @param [in] remappedEndAddress End address for the connection. - * @param [in] memoryMapBaseAddress Base address of the connected memory map. - * @param [in] hasRemapRange Flag for the remap range. - * @param [in] yTransfer Position of the connection relative to the starting item. + * @param [in] startItem The starting item of the connection. + * @param [in] endItem The end item of the connection. + * @param [in] remappedAddress Base address for the connection. + * @param [in] remappedEndAddress End address for the connection. + * @param [in] memoryMapBaseAddress Base address of the connected memory map. + * @param [in] hasRemapRange Flag for the remap range. + * @param [in] yTransfer Position of the connection relative to the starting item. */ void createConnectionItem(MainMemoryGraphicsItem* startItem, MainMemoryGraphicsItem* endItem, @@ -319,10 +319,10 @@ class MemoryConnectionHandler /*! * Change the address range of the selected memory graphics item. * - * @param [in] connectionEndItem The selected memory graphics item. - * @param [in] remappedAddress Remapped address of the memory connection. - * @param [in] memoryMapBaseAddress Base address of the memory graphics item. - * @param [in] hasRemappedRange Value for connections through mirrored slaves. + * @param [in] connectionEndItem The selected memory graphics item. + * @param [in] remappedAddress Remapped address of the memory connection. + * @param [in] memoryMapBaseAddress Base address of the memory graphics item. + * @param [in] hasRemappedRange Value for connections through mirrored slaves. */ void changeConnectionEndItemRanges(MainMemoryGraphicsItem* connectionEndItem, quint64 remappedAddress, @@ -332,10 +332,10 @@ class MemoryConnectionHandler /*! * Get the memory item in the highest position of the set. * - * @param [in] currentHighestItem The currently highest memory item. - * @param [in] itemSet The selected set. + * @param [in] currentHighestItem The currently highest memory item. + * @param [in] itemSet The selected set. * - * @return The highest memory item. + * @return The highest memory item. */ MainMemoryGraphicsItem* getHighestPlacedItemInSet(MainMemoryGraphicsItem* currentHighestItem, QSharedPointer > itemSet) const; @@ -343,10 +343,10 @@ class MemoryConnectionHandler /*! * Compress and reposition the connection set. * - * @param [in] placedSpaceItems List of the address space items of the connection set. - * @param [in] placedMapItems List of the memory map items of the connection set. + * @param [in] placedSpaceItems List of the address space items of the connection set. + * @param [in] placedMapItems List of the memory map items of the connection set. * - * @return The memory connections of the set. + * @return The memory connections of the set. */ QVector compressConnectedMemoryItems( QSharedPointer > placedSpaceItems, @@ -355,27 +355,27 @@ class MemoryConnectionHandler /*! * Calculate the area movements of the compressed set. * - * @param [in] uncutCoordinates Coordinates that must be visible in the compressed set. - * @param [in] CUTMODIFIER Maximum height of the compressed set. + * @param [in] uncutCoordinates Coordinates that must be visible in the compressed set. + * @param [in] CUTMODIFIER Maximum height of the compressed set. * - * @return Map with Y-coordinate as the key and total movement up to this coordinate as the value. + * @return Map with Y-coordinate as the key and total movement up to this coordinate as the value. */ QMap calculateAreaMovements(QVector uncutCoordinates, qreal const& CUTMODIFIER) const; /*! * Check if an address space item should be repositioned to another column. * - * @param [in] placedSpaceItems List of the placed address space items. + * @param [in] placedSpaceItems List of the placed address space items. */ void repositionCompressedAddressSpaces(QSharedPointer > placedSpaceItems); /*! * Check if the selected memory item collides with other placed memory items. * - * @param [in] memoryItem The selected memory item. - * @param [in] placedItems List of the placed memory items. + * @param [in] memoryItem The selected memory item. + * @param [in] placedItems List of the placed memory items. * - * @return True, if the item collides, false otherwise. + * @return True, if the item collides, false otherwise. */ bool itemCollidesWithOtherPlacedItems(MainMemoryGraphicsItem const* memoryItem, QSharedPointer > placedItems) const; @@ -383,8 +383,8 @@ class MemoryConnectionHandler /*! * Place the space item to a column. * - * @param [in] spaceItem The space item. - * @param [in] placedSpaceItems List of the placed space items. + * @param [in] spaceItem The space item. + * @param [in] placedSpaceItems List of the placed space items. */ void placeCompressedSpaceToColumn(MainMemoryGraphicsItem* spaceItem, QSharedPointer > placedSpaceItems); @@ -392,8 +392,8 @@ class MemoryConnectionHandler /*! * Reposition compressed memory maps to previous columns. * - * @param [in] placedMapItems A list of the placed memory map items. - * @param [in] memoryMapColumn The main memory map column. + * @param [in] placedMapItems A list of the placed memory map items. + * @param [in] memoryMapColumn The main memory map column. */ void repositionCompressedMemoryMaps(QSharedPointer > placedMapItems, MemoryColumn const* memoryMapColumn); @@ -401,16 +401,16 @@ class MemoryConnectionHandler /*! * Redraw the memory connections. * - * @param [in] connectionItems List of the memory connection items. + * @param [in] connectionItems List of the memory connection items. * - * @return + * @return */ void redrawMemoryConnections(QVector connectionItems) const; /*! * Create markers for the overlapping connections. * - * @param [in] placedSpaceItems List of the placed address space items. + * @param [in] placedSpaceItems List of the placed address space items. */ void createOverlappingConnectionMarkers(QSharedPointer > placedSpaceItems); diff --git a/editors/MemoryDesigner/MemoryConnectionItem.h b/editors/MemoryDesigner/MemoryConnectionItem.h index a59ca9d56..bce3db8e1 100644 --- a/editors/MemoryDesigner/MemoryConnectionItem.h +++ b/editors/MemoryDesigner/MemoryConnectionItem.h @@ -30,13 +30,13 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * The constructor. * - * @param [in] startItem The start item of the connection (address space). - * @param [in] firstStartValue Start address in the start item. - * @param [in] firstEndValue End address in the start item. - * @param [in] endItem The end item of the connection (memory map). - * @param [in] containingScene Graphics scene containing the memory connection item. - * @param [in] yTransfer Y transfer of the memory connection. - * @param [in] parent Parent item of the connection. + * @param [in] startItem The start item of the connection (address space). + * @param [in] firstStartValue Start address in the start item. + * @param [in] firstEndValue End address in the start item. + * @param [in] endItem The end item of the connection (memory map). + * @param [in] containingScene Graphics scene containing the memory connection item. + * @param [in] yTransfer Y transfer of the memory connection. + * @param [in] parent Parent item of the connection. */ MemoryConnectionItem(MainMemoryGraphicsItem* startItem, quint64 firstStartValue, @@ -58,21 +58,21 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Change the position relative to the connection start item. * - * @param [in] movementInY Movement in the containig scene. + * @param [in] movementInY Movement in the containig scene. */ void moveItemBy(qreal const& movementInY); /*! * Get the start value of the connection. * - * @return The start value of the connection. + * @return The start value of the connection. */ quint64 getRangeStartValue() const; /*! * Get the end value of the connection. * - * @return The end value of the connection. + * @return The end value of the connection. */ quint64 getRangeEndValue() const; @@ -84,21 +84,21 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Get the lowest point of the connection. * - * @return The lowest point of the connection item. + * @return The lowest point of the connection item. */ quint64 getSceneEndPoint() const; /*! * Get the connected start memory item. * - * @return The connected start memory item. + * @return The connected start memory item. */ MainMemoryGraphicsItem* getConnectionStartItem() const; /*! * Get the connected end memory item. * - * @return The connected end memory item. + * @return The connected end memory item. */ MainMemoryGraphicsItem* getConnectionEndItem() const; @@ -110,11 +110,11 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Check if the selected label collides with the range labels. * - * @param [in] label The selected label. - * @param [in] fontHeight Height of the font used in the selected label. - * @param [in] connectedItem Owner of the selected label. + * @param [in] label The selected label. + * @param [in] fontHeight Height of the font used in the selected label. + * @param [in] connectedItem Owner of the selected label. * - * @return True, if the selected label collides with the range labels, false otherwise. + * @return True, if the selected label collides with the range labels, false otherwise. */ bool labelCollidesWithRanges(QGraphicsTextItem* label, qreal fontHeight, const MainMemoryGraphicsItem* connectedItem) const; @@ -122,10 +122,10 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Compress this and the connected end items to the selected coordinates. * - * @param [in] condensedItems List of memory items that have been compressed. - * @param [in] unCutCoordinates List of the visible coordinates. - * @param [in] CUTMODIFIER Maximum height for a compressed area. - * @param [in] memoryItemsAreCompressed Flag for compressing the memory items. + * @param [in] condensedItems List of memory items that have been compressed. + * @param [in] unCutCoordinates List of the visible coordinates. + * @param [in] CUTMODIFIER Maximum height for a compressed area. + * @param [in] memoryItemsAreCompressed Flag for compressing the memory items. */ void compressToUnCutCoordinates(QVector& condensedItems, QVector unCutCoordinates, const qreal CUTMODIFIER, bool memoryItemsAreCompressed); @@ -133,9 +133,9 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Move the connected memory items. * - * @param [in] movedItems Memory items that have already been moved. - * @param [in] movementOrigin Origin of the movement. - * @param [in] transferY The amount to move in y-coordinate. + * @param [in] movedItems Memory items that have already been moved. + * @param [in] movementOrigin Origin of the movement. + * @param [in] transferY The amount to move in y-coordinate. */ void moveConnectedItems(QSharedPointer > movedItems, MainMemoryGraphicsItem* movementOrigin, qreal transferY); @@ -143,7 +143,7 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Get the lowest point of the memory connection and the other connected memory item. * - * @param [in] originItem The origin memory item. + * @param [in] originItem The origin memory item. */ qreal getConnectionLowPoint(MainMemoryGraphicsItem const* originItem) const; @@ -152,10 +152,10 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Compress the contained end item using coordinates. * - * @param [in] condensedItems Memory items that have already been condensed. - * @param [in] unCutCoordinates The addresses tha remain after the compression. - * @param [in] CUTMODIFIER Modifier for the cut areas. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] condensedItems Memory items that have already been condensed. + * @param [in] unCutCoordinates The addresses tha remain after the compression. + * @param [in] CUTMODIFIER Modifier for the cut areas. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. */ void compressEndItemToCoordinates(QVector& compressedItems, QVector unCutCoordinates, const qreal CUTMODIFIER, bool memoryItemsAreCompressed); @@ -163,15 +163,15 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Set a new height for the memory connection. * - * @param [in] newHeight The new height. + * @param [in] newHeight The new height. */ void setCondensedHeight(qreal newHeight); /*! * Setup the range labels. * - * @param [in] startValue Base address of the connection. - * @param [in] endValue Last address of the connection. + * @param [in] startValue Base address of the connection. + * @param [in] endValue Last address of the connection. */ void setupLabels(quint64 startValue, quint64 endValue); @@ -183,10 +183,10 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Avoid collisions on the connection path. * - * @param [in] highStartPoint The top start point of the connection. - * @param [in] highEndPoint The top end point of the connection. - * @param [in] lowStartPoint The low start point of the connection. - * @param [in] lowEndPoint The low end point of the connection. + * @param [in] highStartPoint The top start point of the connection. + * @param [in] highEndPoint The top end point of the connection. + * @param [in] lowStartPoint The low start point of the connection. + * @param [in] lowEndPoint The low end point of the connection. */ void avoidCollisionsOnPath(QPointF const& highStartPoint, QPointF const& highEndPoint, QPointF const& lowStartPoint, QPointF const& lowEndPoint); @@ -194,12 +194,12 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Create a collision path according to the collision points. * - * @param [in] highStartPoint The top start point of the connection. - * @param [in] highEndPoint The top end point of the connection. - * @param [in] lowStartPoint The low start point of the connection. - * @param [in] lowEndPoint The low end point of the connection. - * @param [in] highCollisionPoints Map containing the top collision points of the connection item. - * @param [in] lowCollisionPoints Map containing the low collision points of the connection item. + * @param [in] highStartPoint The top start point of the connection. + * @param [in] highEndPoint The top end point of the connection. + * @param [in] lowStartPoint The low start point of the connection. + * @param [in] lowEndPoint The low end point of the connection. + * @param [in] highCollisionPoints Map containing the top collision points of the connection item. + * @param [in] lowCollisionPoints Map containing the low collision points of the connection item. */ void createCollisionPath(QPointF highStartPoint, QPointF highEndPoint, QPointF lowStartPoint, QPointF lowEndPoint, QMultiMap > highCollisionPoints, @@ -213,27 +213,27 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Get the width of the connection. * - * @return The width of the connection. + * @return The width of the connection. */ qreal getConnectionWidth() const; /*! * Reposition a single colliding range label. * - * @param [in] textLabel The selected range label. + * @param [in] textLabel The selected range label. */ void repositionSingleRangeLabel(QGraphicsTextItem* rangeLabel) const; /*! * Create a path for the memory connection. * - * @param [in] highStartPoint High start point of the memory connection. - * @param [in] highEndPoint High end point of the memory connection. - * @param [in] lowStartPoint Low start point of the memory connection. - * @param [in] lowEndPoint Low end point of the memory connection. - * @param [in] LINEWIDTH Line width of the memory connection. + * @param [in] highStartPoint High start point of the memory connection. + * @param [in] highEndPoint High end point of the memory connection. + * @param [in] lowStartPoint Low start point of the memory connection. + * @param [in] lowEndPoint Low end point of the memory connection. + * @param [in] LINEWIDTH Line width of the memory connection. * - * @return The created painter path. + * @return The created painter path. */ QPainterPath createConnectionPath(QPointF const& highStartPoint, QPointF const& highEndPoint, QPointF const& lowStartPoint, QPointF const& lowEndPoint, int const& LINEWIDTH); @@ -241,10 +241,10 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Move the connected items without moving connected memory connections. * - * @param [in] movedItems Memory items that have already been moved. - * @param [in] movementOrigin Origin of the movement. - * @param [in] connectedItem The item to be moved. - * @param [in] transferY The amount to move in y-coordinate. + * @param [in] movedItems Memory items that have already been moved. + * @param [in] movementOrigin Origin of the movement. + * @param [in] connectedItem The item to be moved. + * @param [in] transferY The amount to move in y-coordinate. */ void moveConnectedItemWithoutConnections(QSharedPointer > movedItems, MainMemoryGraphicsItem const* movementOrigin, MainMemoryGraphicsItem* connectedItem, qreal transferY); @@ -252,22 +252,22 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Check if this connection is between an address space and its local memory map. * - * @return True, if the connection is a local memory map connection. + * @return True, if the connection is a local memory map connection. */ bool isLocalMapConnection() const; /*! * Create a path for a local memory map connection or an address space connection avoiding colliding items. * - * @param [in] connectionIsLocal Flag for identifying the connection type. - * @param [in] highStartPoint High start point of the connection. - * @param [in] highEndPoint High end point of the connection. - * @param [in] lowStartPoint Low start point of the connection. - * @param [in] lowEndPoint Low end point of the connection. - * @param [in] highCollisionPoints High collision points. - * @param [in] lowCollisionPoints Low collision points. + * @param [in] connectionIsLocal Flag for identifying the connection type. + * @param [in] highStartPoint High start point of the connection. + * @param [in] highEndPoint High end point of the connection. + * @param [in] lowStartPoint Low start point of the connection. + * @param [in] lowEndPoint Low end point of the connection. + * @param [in] highCollisionPoints High collision points. + * @param [in] lowCollisionPoints Low collision points. * - * @return The memory connection path for local memory connection and address space connection with the + * @return The memory connection path for local memory connection and address space connection with the * colliding lines removed. */ QPainterPath createCollidingPathForUnusualConnection(bool connectionIsLocal, QPointF highStartPoint, @@ -278,11 +278,11 @@ class MemoryConnectionItem : public QGraphicsPathItem /*! * Erase the colliding lines from the memory connection. * - * @param [in] collisionPath The selected memory connection path. - * @param [in] collisionBegin Start point of the colliding connection line. - * @param [in] collisionPoints List of the colliding points. + * @param [in] collisionPath The selected memory connection path. + * @param [in] collisionBegin Start point of the colliding connection line. + * @param [in] collisionPoints List of the colliding points. * - * @return The memory connection path with the colliding lines removed. + * @return The memory connection path with the colliding lines removed. */ QPainterPath eraseCollisionsFromPath(QPainterPath collisionPath, QPointF collisionBegin, QMultiMap > collisionPoints); diff --git a/editors/MemoryDesigner/MemoryDesignConstructor.h b/editors/MemoryDesigner/MemoryDesignConstructor.h index 42874fa72..3d6fbd103 100644 --- a/editors/MemoryDesigner/MemoryDesignConstructor.h +++ b/editors/MemoryDesigner/MemoryDesignConstructor.h @@ -37,7 +37,7 @@ class MemoryDesignConstructor : public QObject /*! * The constructor. * - * @param [in] layout Layout for the memory graphics items. + * @param [in] layout Layout for the memory graphics items. */ MemoryDesignConstructor(QSharedPointer layout); @@ -49,28 +49,28 @@ class MemoryDesignConstructor : public QObject /*! * Change the condensing of memory graphics items. * - * @param [in] condenseItems Value for condensing memory graphics items. + * @param [in] condenseItems Value for condensing memory graphics items. */ void setCondenseMemoryItems(bool condenseMemoryItems); /*! * Check whether the memory graphics items are condensed or not. * - * @return True, if the memory graphics items are condensed, otherwise false. + * @return True, if the memory graphics items are condensed, otherwise false. */ bool memoryItemsAreCondensed() const; /*! * Set the filtering for chained address space memory connections. * - * @param [in] filterChains Value for the chained address space memory connection filtering. + * @param [in] filterChains Value for the chained address space memory connection filtering. */ void setFilterAddressSpaceChains(bool filterChains); /*! * Check whether the chained address space memory connections are filtered or not. * - * @return True, if the chained address space memory connections are filtered, false otherwise. + * @return True, if the chained address space memory connections are filtered, false otherwise. */ bool addressSpaceChainsAreFiltered() const; @@ -87,100 +87,100 @@ class MemoryDesignConstructor : public QObject /*! * Set a new value for filtering the address space segments. * - * @param [in] filterSegments Value for filtering address space segments. + * @param [in] filterSegments Value for filtering address space segments. */ void setFilterAddressSpaceSegments(bool filterSegments); /*! * Check if the address space segments are filtered. * - * @return True, if the address space segments are filtered, false otherwise. + * @return True, if the address space segments are filtered, false otherwise. */ bool addressSpaceSegmentsAreFiltered() const; /*! * Set a new value for filtering the address blocks. * - * @param [in] filterBlocks Value for filtering address blocks. + * @param [in] filterBlocks Value for filtering address blocks. */ void setFilterAddressBlocks(bool filterBlocks); /*! * Check if the address blocks are filtered. * - * @return True, if the address blocks are filtered, false otherwise. + * @return True, if the address blocks are filtered, false otherwise. */ bool addressBlocksAreFiltered() const; /*! * Set a new value for filtering the address block registers. * - * @param [in] filterSegments Value for filtering address block registers. + * @param [in] filterSegments Value for filtering address block registers. */ void setFilterAddressBlockRegisters(bool filterRegisters); /*! * Check if the address block registers are filtered. * - * @return True, if the address block registers are filtered, false otherwise. + * @return True, if the address block registers are filtered, false otherwise. */ bool addressBlockRegistersAreFiltered() const; /*! * Set a new value for filtering the register fields. * - * @param [in] filterFields Value for filtering register fields. + * @param [in] filterFields Value for filtering register fields. */ void setFilterFields(bool filterFields); /*! * Check if the register fields are filtered. * - * @return True, if the register fields are filtered, false otherwise. + * @return True, if the register fields are filtered, false otherwise. */ bool fieldsAreFiltered() const; /*! * Set a new value for filtering the unconnected memory items. * - * @param [in] filterUnconnected Value for filtering unconnected memory items. + * @param [in] filterUnconnected Value for filtering unconnected memory items. */ void filterUnconnectedMemoryItems(bool filterUnconnected); /*! * Check if the unconnected memory items are filtered. * - * @return True, if the unconnected memory items are filtered, false otherwise. + * @return True, if the unconnected memory items are filtered, false otherwise. */ bool unconnectedMemoryItemsAreFiltered() const; /*! * Set a new value for filtering the memory overlap items. * - * @param [in] filterOverlap Value for filtering memory overlap. + * @param [in] filterOverlap Value for filtering memory overlap. */ void filterMemoryOverlapItems(bool filterOverlap); /*! * Check if the memory overlap items are filtered. * - * @return True, if the memory overlap items are filtered, false otherwise. + * @return True, if the memory overlap items are filtered, false otherwise. */ bool memoryOverlapItemsAreFiltered() const; /*! * Construct memory design items from the selected connection graph. * - * @param [in] connectionGraph Connection graph containing connection routes. + * @param [in] connectionGraph Connection graph containing connection routes. * - * @return True, if memory items can be created from the graph, false otherwise. + * @return True, if memory items can be created from the graph, false otherwise. */ bool constructMemoryDesignItems(QSharedPointer connectionGraph); /*! * Set a new graphics layout for the memory graphics items. * - * @param [in] newLayout The new graphics layout. + * @param [in] newLayout The new graphics layout. */ void setNewLayout(QSharedPointer newLayout); @@ -192,14 +192,14 @@ class MemoryDesignConstructor : public QObject /*! * Set a new width change. * - * @param [in] newWidthBoundary The new width change. + * @param [in] newWidthBoundary The new width change. */ void setNewWidthBoundary(int newWidthBoundary); /*! * Change the width of the memory map columns and their contained memory map graphics items. * - * @param [in] deltaWidth The change in width. + * @param [in] deltaWidth The change in width. */ void changeMemoryMapWidths(qreal deltaWidth); @@ -208,8 +208,8 @@ class MemoryDesignConstructor : public QObject /*! * Open the component document for the selected VLNV. * - * @param [in] vlnv VLNV of the containing component. - * @param [in] identifierChain List of strings to identify the component item. + * @param [in] vlnv VLNV of the containing component. + * @param [in] identifierChain List of strings to identify the component item. */ void openComponentDocument(VLNV const& vlnv, QVector identifierChain); diff --git a/editors/MemoryDesigner/MemoryDesignDocument.h b/editors/MemoryDesigner/MemoryDesignDocument.h index 2ec7d5564..9bace57ad 100644 --- a/editors/MemoryDesigner/MemoryDesignDocument.h +++ b/editors/MemoryDesigner/MemoryDesignDocument.h @@ -36,8 +36,8 @@ class MemoryDesignDocument : public TabDocument /*! * The constructor. * - * @param [in] library The library interface. - * @param [in] parent The parent. + * @param [in] library The library interface. + * @param [in] parent The parent. */ MemoryDesignDocument(LibraryInterface* libHandler, QWidget* parent = 0); @@ -54,46 +54,46 @@ class MemoryDesignDocument : public TabDocument /*! * Set the memory design. * - * @param [in] componentVLNV VLNV of the component. - * @param [in] viewName The selected component view. + * @param [in] componentVLNV VLNV of the component. + * @param [in] viewName The selected component view. * - * @return True, if the memory design was opened successfully, false otherwise. + * @return True, if the memory design was opened successfully, false otherwise. */ bool setDesign(VLNV const& componentVLNV, QString const& viewName); /*! * Get the supported draw modes. * - * @return The supported draw modes. + * @return The supported draw modes. */ virtual unsigned int getSupportedDrawModes() const; /*! * Get the VLNV that can be used to identify the document. * - * @return The VLNV that identifies the document. + * @return The VLNV that identifies the document. */ virtual VLNV getIdentifyingVLNV() const; /*! * Get the document VLNV. * - * @return The VLNV of the containing document. + * @return The VLNV of the containing document. */ virtual VLNV getDocumentVLNV() const; /*! * Changes the state of a visibility control. * - * @param [in] name The name of the visibility control. - * @param [in] state The new state for the visibility control. + * @param [in] name The name of the visibility control. + * @param [in] state The new state for the visibility control. */ virtual void setVisibilityControlState(QString const& name, bool state); /*! * Sets the zoom level of the design. * - * @param [in] level The zoom level in percents. + * @param [in] level The zoom level in percents. */ virtual void setZoomLevel(int level); @@ -105,42 +105,42 @@ class MemoryDesignDocument : public TabDocument /*! * Centers the current view to a point. * - * @param [in] centerPoint The point to center to. + * @param [in] centerPoint The point to center to. */ void centerViewTo(QPointF const& centerPoint); /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); /*! * Change the condensing of memory graphics items. * - * @param [in] condenseItems Value for condensing memory graphics items. + * @param [in] condenseItems Value for condensing memory graphics items. */ void setCondenseMemoryItems(bool condenseItems); /*! * Check whether the memory graphics items are condensed or not. * - * @return True, if the memory graphics items are condensed, otherwise false. + * @return True, if the memory graphics items are condensed, otherwise false. */ bool memoryItemsAreCondensed() const; /*! * Change the filtering of chained address space memory connections. * - * @param [in] filterChains Value for filtering chained address space memory connections. + * @param [in] filterChains Value for filtering chained address space memory connections. */ void filterAddressSpaceChains(bool filterChains); /*! * Check whether the chained address space memory connections are filtered or not. * - * @return True, if the chained connections are filtered, otherwise false. + * @return True, if the chained connections are filtered, otherwise false. */ bool addressSpaceChainsAreFiltered() const; @@ -157,56 +157,56 @@ class MemoryDesignDocument : public TabDocument /*! * Check whether the address space segments are filtered or not. * - * @return True, if address space segments are filtered, otherwise false. + * @return True, if address space segments are filtered, otherwise false. */ bool addressSpaceSegmentsAreFilterted() const; /*! * Check whether the address blocks are filtered or not. * - * @return True, if address blocks are filtered, otherwise false. + * @return True, if address blocks are filtered, otherwise false. */ bool addressBlocksAreFiltered() const; /*! * Check whether the address block registers are filtered or not. * - * @return True, if address block registers are filtered, otherwise false. + * @return True, if address block registers are filtered, otherwise false. */ bool addressBlockRegistersAreFiltered() const; /*! * Check whether the register fields are filtered or not. * - * @return True, if register fields are filtered, otherwise false. + * @return True, if register fields are filtered, otherwise false. */ bool fieldsAreFiltered() const; /*! * Check whether the unconnected memory items are filtered or not. * - * @return True, if the unconnected memory items are filtered, otherwise false. + * @return True, if the unconnected memory items are filtered, otherwise false. */ bool unconnectedMemoryItemsAreFiltered() const; /*! * Filter the unconnected memory items. * - * @param [in] filterUnconnected Value for filtering the unconnected memory items. + * @param [in] filterUnconnected Value for filtering the unconnected memory items. */ void filterUnconnectedMemoryItems(bool filterUnconnected); /*! * Filter the memory overlap items. * - * @param [in] filterOverlap Value for filtering. + * @param [in] filterOverlap Value for filtering. */ void filterMemoryOverlapItems(bool filterOverlap); /*! * Check if the memory overlap items are filtered. * - * @return True, if the memory overlap items are filtered, false otherwise. + * @return True, if the memory overlap items are filtered, false otherwise. */ bool memoryOverlapItemsAreFiltered() const; @@ -215,28 +215,28 @@ public slots: /*! * Filter the address space segments. * - * @param [in] filterSegments Value for filtering the segments. + * @param [in] filterSegments Value for filtering the segments. */ void filterAddressSpaceSegments(bool filterSegments); /*! * Filter the address blocks. * - * @param [in] filterBlocks Value for filtering the address blocks. + * @param [in] filterBlocks Value for filtering the address blocks. */ void filterAddressBlocks(bool filterBlocks); /*! * Filter the address block registers. * - * @param [in] filterRegisters Value for filtering the registers. + * @param [in] filterRegisters Value for filtering the registers. */ void filterAddressBlockRegisters(bool filterRegisters); /*! * Filter the register fields. * - * @param [in] filterFields Value for filtering the fields. + * @param [in] filterFields Value for filtering the fields. */ void filterFields(bool filterFields); @@ -259,8 +259,8 @@ public slots: /*! * Open the component document for the selected VLNV. * - * @param [in] vlnv VLNV of the containing component. - * @param [in] identifierChain List of strings to identify the component item. + * @param [in] vlnv VLNV of the containing component. + * @param [in] identifierChain List of strings to identify the component item. */ void openComponentDocument(VLNV const& vlnv, QVector identifierChain); @@ -269,7 +269,7 @@ public slots: /*! * Show the document. * - * @param [in] event The selected show event. + * @param [in] event The selected show event. */ void showEvent(QShowEvent* event); @@ -281,8 +281,8 @@ public slots: /*! * Get the design from the selected view. * - * @param [in] component Component whose views are used. - * @param [in] viewName The name of the selected view. + * @param [in] component Component whose views are used. + * @param [in] viewName The name of the selected view. */ QSharedPointer getDesignFromView(QSharedPointer component, QString const& viewName); diff --git a/editors/MemoryDesigner/MemoryDesignerChildGraphicsItem.h b/editors/MemoryDesigner/MemoryDesignerChildGraphicsItem.h index 69c8c243d..2aadea9e0 100644 --- a/editors/MemoryDesigner/MemoryDesignerChildGraphicsItem.h +++ b/editors/MemoryDesigner/MemoryDesignerChildGraphicsItem.h @@ -28,14 +28,14 @@ class MemoryDesignerChildGraphicsItem : public MemoryDesignerGraphicsItem /*! * The constructor. * - * @param [in] subMemoryItem The sub memory item. - * @param [in] toolTipType The type of the memory item. - * @param [in] baseAddress Base address of the memory item. - * @param [in] range Range of the memory item. - * @param [in] blockWidth Width of the memory item. - * @param [in] identifierChain List of strings to identify the component item. - * @param [in] containingInstance Component instance containing the sub memory item. - * @param [in] parent The parent item. + * @param [in] subMemoryItem The sub memory item. + * @param [in] toolTipType The type of the memory item. + * @param [in] baseAddress Base address of the memory item. + * @param [in] range Range of the memory item. + * @param [in] blockWidth Width of the memory item. + * @param [in] identifierChain List of strings to identify the component item. + * @param [in] containingInstance Component instance containing the sub memory item. + * @param [in] parent The parent item. */ MemoryDesignerChildGraphicsItem(QSharedPointer subMemoryItem, QString const& toolTipType, quint64 baseAddress, quint64 range, qreal blockWidth, QVector identifierChain, @@ -61,8 +61,8 @@ class MemoryDesignerChildGraphicsItem : public MemoryDesignerGraphicsItem /*! * Set the colors for the memory item. * - * @param [in] itemColor The main color for the memory item. - * @param [in] itemIsEmpty Boolean for determining empty memory item. + * @param [in] itemColor The main color for the memory item. + * @param [in] itemIsEmpty Boolean for determining empty memory item. */ void setColors(QColor itemColor, bool itemIsEmpty); @@ -74,14 +74,14 @@ class MemoryDesignerChildGraphicsItem : public MemoryDesignerGraphicsItem /*! * Set colors for ranges in an empty sub graphics item. * - * @param [in] emptyItemRangeColour The color for the empty sub graphics item ranges. + * @param [in] emptyItemRangeColour The color for the empty sub graphics item ranges. */ virtual void setEmptyItemRangeColors(QColor emptyItemRangeColour); /*! * Get the width of the available area used by the memory sub item. * - * @return The width of the available area used by the memory sub item. + * @return The width of the available area used by the memory sub item. */ virtual qreal getItemWidth() const; }; diff --git a/editors/MemoryDesigner/MemoryDesignerConstants.h b/editors/MemoryDesigner/MemoryDesignerConstants.h index 36d52e701..26a08ef5c 100644 --- a/editors/MemoryDesigner/MemoryDesignerConstants.h +++ b/editors/MemoryDesigner/MemoryDesignerConstants.h @@ -71,10 +71,10 @@ namespace MemoryDesignerConstants /*! * Check if the bounding rectangle of an item overlaps the bounding rectangle of another item. * - * @param [in] firstRectangle The bounding rectangle of the selected item. - * @param [in] firstLineWidth Line width of the selected item. - * @param [in] secondRectangle The bounding rectangle of the comparison item. - * @param [in] secondLineWidth Line width of the comparison item. + * @param [in] firstRectangle The bounding rectangle of the selected item. + * @param [in] firstLineWidth Line width of the selected item. + * @param [in] secondRectangle The bounding rectangle of the comparison item. + * @param [in] secondLineWidth Line width of the comparison item. */ bool itemOverlapsAnotherItem(QRectF const& firstRectangle, int firstLineWidth, QRectF const& secondRectangle, int secondLineWidth); @@ -82,57 +82,57 @@ namespace MemoryDesignerConstants /*! * Get the amount of numbers required for the given ranges. * - * @param [in] rangeStart The selected address range start. - * @param [in] rangeEnd The selected address range end. + * @param [in] rangeStart The selected address range start. + * @param [in] rangeEnd The selected address range end. * - * @return The amount of numbers used to display the address ranges. + * @return The amount of numbers used to display the address ranges. */ int getAmountOfNumbersInRange(QString const& rangeStart, QString const& rangeEnd); /*! * Change the selected value into a value with zeros appended to the beginning. * - * @param [in] value The selected value. - * @param [in] amountOfNumbers Amount of numbers used to display the value. + * @param [in] value The selected value. + * @param [in] amountOfNumbers Amount of numbers used to display the value. * - * @return The value with zeros appended to display the value. + * @return The value with zeros appended to display the value. */ QString getValueWithZerosAdded(QString const& value, int amountOfNumbers); /*! * Get the area size required for the selected address range. * - * @param [in] addressRange The selected address range. + * @param [in] addressRange The selected address range. * - * @return The area size for the selected address range. + * @return The area size for the selected address range. */ qreal getAreaSizeForRange(quint64 addressRange); /*! * Get the required rows for the selected address range. * - * @param [in] addressRange The selected address range. + * @param [in] addressRange The selected address range. * - * @return The required rows for the selected address range. + * @return The required rows for the selected address range. */ int getRequiredRowsForRange(quint64 addressRange); /*! * Get the required area size for the selected area. * - * @param [in] usedArea The selected area. + * @param [in] usedArea The selected area. * - * @return The required area size for the selected area. + * @return The required area size for the selected area. */ qreal getRequiredAreaForUsedArea(qreal usedArea); /*! * Get the memory map item node of the connection. * - * @param [in] startInterface Interface node containing the first interface of the connection path. - * @param [in] endInterface Interface node containing the last interface of the connection path. + * @param [in] startInterface Interface node containing the first interface of the connection path. + * @param [in] endInterface Interface node containing the last interface of the connection path. * - * @return The memory map item node of the connection. + * @return The memory map item node of the connection. */ QSharedPointer getMapItem(QSharedPointer startInterface, QSharedPointer endInterface); diff --git a/editors/MemoryDesigner/MemoryDesignerDiagram.h b/editors/MemoryDesigner/MemoryDesignerDiagram.h index 925d9fa21..95408ff96 100644 --- a/editors/MemoryDesigner/MemoryDesignerDiagram.h +++ b/editors/MemoryDesigner/MemoryDesignerDiagram.h @@ -38,8 +38,8 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * The constructor. * - * @param [in] library The library interface. - * @param [in] parent The parent widget. + * @param [in] library The library interface. + * @param [in] parent The parent widget. */ MemoryDesignerDiagram(LibraryInterface* library, MemoryDesignDocument* parent = 0); @@ -51,28 +51,28 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * Change the condensing of memory graphics items. * - * @param [in] condenseItems Value for condensing memory graphics items. + * @param [in] condenseItems Value for condensing memory graphics items. */ void setCondenseMemoryItems(bool condenseMemoryItems); /*! * Check whether the memory graphics items are condensed or not. * - * @return True, if the memory graphics items are condensed, otherwise false. + * @return True, if the memory graphics items are condensed, otherwise false. */ bool memoryItemsAreCondensed() const; /*! * Set the filtering for chained address space memory connections. * - * @param [in] filterChains Value for the chained address space memory connection filtering. + * @param [in] filterChains Value for the chained address space memory connection filtering. */ void setFilterAddressSpaceChains(bool filterChains); /*! * Check whether the chained address space memory connections are filtered or not. * - * @return True, if the chained address space memory connections are filtered, false otherwise. + * @return True, if the chained address space memory connections are filtered, false otherwise. */ bool addressSpaceChainsAreFiltered() const; @@ -89,92 +89,92 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * Set a new value for filtering the address space segments. * - * @param [in] filterSegments Value for filtering address space segments. + * @param [in] filterSegments Value for filtering address space segments. */ void setFilterAddressSpaceSegments(bool filterSegments); /*! * Check if the address space segments are filtered. * - * @return True, if the address space segments are filtered, false otherwise. + * @return True, if the address space segments are filtered, false otherwise. */ bool addressSpaceSegmentsAreFiltered() const; /*! * Set a new value for filtering the address blocks. * - * @param [in] filterBlocks Value for filtering address blocks. + * @param [in] filterBlocks Value for filtering address blocks. */ void setFilterAddressBlocks(bool filterBlocks); /*! * Check if the address blocks are filtered. * - * @return True, if the address blocks are filtered, false otherwise. + * @return True, if the address blocks are filtered, false otherwise. */ bool addressBlocksAreFiltered() const; /*! * Set a new value for filtering the address block registers. * - * @param [in] filterSegments Value for filtering address block registers. + * @param [in] filterSegments Value for filtering address block registers. */ void setFilterAddressBlockRegisters(bool filterRegisters); /*! * Check if the address block registers are filtered. * - * @return True, if the address block registers are filtered, false otherwise. + * @return True, if the address block registers are filtered, false otherwise. */ bool addressBlockRegistersAreFiltered() const; /*! * Set a new value for filtering the register fields. * - * @param [in] filterFields Value for filtering register fields. + * @param [in] filterFields Value for filtering register fields. */ void setFilterFields(bool filterFields); /*! * Check if the register fields are filtered. * - * @return True, if the register fields are filtered, false otherwise. + * @return True, if the register fields are filtered, false otherwise. */ bool fieldsAreFiltered() const; /*! * Set a new value for filtering the unconnected memory items. * - * @param [in] filterUnconnected Value for filtering unconnected memory items. + * @param [in] filterUnconnected Value for filtering unconnected memory items. */ void filterUnconnectedMemoryItems(bool filterUnconnected); /*! * Check if the unconnected memory items are filtered. * - * @return True, if the unconnected memory items are filtered, false otherwise. + * @return True, if the unconnected memory items are filtered, false otherwise. */ bool unconnectedMemoryItemsAreFiltered() const; /*! * Set a new value for filtering the memory overlap items. * - * @param [in] filterOverlap Value for filtering memory overlap. + * @param [in] filterOverlap Value for filtering memory overlap. */ void filterMemoryOverlapItems(bool filterOverlap); /*! * Check if the memory overlap items are filtered. * - * @return True, if the memory overlap items are filtered, false otherwise. + * @return True, if the memory overlap items are filtered, false otherwise. */ bool memoryOverlapItemsAreFiltered() const; /*! * Load a design using the selected view. * - * @param [in] component Component containing the view. - * @param [in] viewName The name of the selected view. + * @param [in] component Component containing the view. + * @param [in] viewName The name of the selected view. */ bool loadDesignFromCurrentView(QSharedPointer component, QString const& viewName); @@ -191,7 +191,7 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * Handle the vertical scroll. * - * @param [in] y The amount of vertical scrolling. + * @param [in] y The amount of vertical scrolling. */ void onVerticalScroll(qreal y); @@ -200,15 +200,15 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * Handle the mouse wheel event. * - * @param [in] event The wheel event. + * @param [in] event The wheel event. */ virtual void wheelEvent(QGraphicsSceneWheelEvent *event); /*! * Draw the diagram background. * - * @param [in] painter The used painter. - * @param [in] rect The containing rectangle of the diagram. + * @param [in] painter The used painter. + * @param [in] rect The containing rectangle of the diagram. */ virtual void drawBackground(QPainter *painter, const QRectF &rect); @@ -217,8 +217,8 @@ class MemoryDesignerDiagram : public QGraphicsScene /*! * Open the component document for the selected VLNV. * - * @param [in] vlnv VLNV of the containing component. - * @param [in] identifierChain List of strings to identify the component item. + * @param [in] vlnv VLNV of the containing component. + * @param [in] identifierChain List of strings to identify the component item. */ void openComponentDocument(VLNV const& vlnv, QVector identifierChain); diff --git a/editors/MemoryDesigner/MemoryDesignerGraphicsItem.h b/editors/MemoryDesigner/MemoryDesignerGraphicsItem.h index 7a880b26e..d84ac1241 100644 --- a/editors/MemoryDesigner/MemoryDesignerGraphicsItem.h +++ b/editors/MemoryDesigner/MemoryDesignerGraphicsItem.h @@ -41,11 +41,11 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * The constructor. * - * @param [in] itemName Name of the memory graphics item. - * @param [in] displayName Display name of the memory graphics item. - * @param [in] identifierChain List of string containing the identifying information of the item. - * @param [in] componentInstance Component instance containing the memory item. - * @param [in] parent The parent item. + * @param [in] itemName Name of the memory graphics item. + * @param [in] displayName Display name of the memory graphics item. + * @param [in] identifierChain List of string containing the identifying information of the item. + * @param [in] componentInstance Component instance containing the memory item. + * @param [in] parent The parent item. */ MemoryDesignerGraphicsItem(QString const& itemName, QString const& displayName, QVector identifierChain, QSharedPointer componentInstance, @@ -68,14 +68,14 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Get the name of the memory item. * - * @return The name of the memory item. + * @return The name of the memory item. */ QString name() const; /*! * Get the display name of the memory item. * - * @return The display name of the memory item. + * @return The display name of the memory item. */ QString displayName() const; @@ -87,8 +87,8 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Hide the colliding memory item range labels. * - * @param [in] connectionBaseAddress Base address of the memory connection item. - * @param [in] connectionLastAddress Last address of the memory connection item. + * @param [in] connectionBaseAddress Base address of the memory connection item. + * @param [in] connectionLastAddress Last address of the memory connection item. */ void hideCollidingRangeLabels(quint64 connectionBaseAddress, quint64 connectionLastAddress); @@ -105,79 +105,79 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Get the current base address of the memory item. * - * @return The current base address of the memory item. + * @return The current base address of the memory item. */ quint64 getBaseAddress() const; /*! * Get the original base address of the memory item. * - * @return The original base address of the memory item. + * @return The original base address of the memory item. */ quint64 getOriginalBaseAddress() const; /*! * Get the current last address of the memory item. * - * @return The current last address of the memory item. + * @return The current last address of the memory item. */ quint64 getLastAddress() const; /*! * Get the original last address of the memory item. * - * @return The original last address of the memory item. + * @return The original last address of the memory item. */ quint64 getOriginalLastAddress() const; /*! * Compress this graphics item. * - * @param [in] newItemHeight The new height of the graphics item. + * @param [in] newItemHeight The new height of the graphics item. */ virtual void condense(qreal newItemHeight); /*! * Add a memory connection graphics item. * - * @param [in] connectionItem The selected memory connection item. + * @param [in] connectionItem The selected memory connection item. */ virtual void addMemoryConnection(MemoryConnectionItem* connectionItem); /*! * Get the connected memory connection items. * - * @return A map containing the memory connection items in the order of their base addresses. + * @return A map containing the memory connection items in the order of their base addresses. */ QMultiMap getMemoryConnections() const; /*! * Fit the selected label to this item. * - * @param [in] label The selected label. + * @param [in] label The selected label. */ virtual void fitLabel(QGraphicsTextItem* label); /*! * Get the containing component instance. * - * @return The containing component instance. + * @return The containing component instance. */ QSharedPointer getContainingInstance() const; /*! * Change the address range of the memory item. * - * @param [in] offset The offset of the parent item. + * @param [in] offset The offset of the parent item. */ virtual void changeAddressRange(quint64 offset); /*! * Compress this item to contain the selected coordinates. * - * @param [in] unCutCoordinates Coordinates that remain after the compression. - * @param [in] CUTMODIFIER Modifier for the cut area. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] unCutCoordinates Coordinates that remain after the compression. + * @param [in] CUTMODIFIER Modifier for the cut area. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. */ virtual void compressToUnCutCoordinates(QVector unCutCoordinates, const qreal CUTMODIFIER, bool memoryItemsAreCompressed); @@ -185,14 +185,14 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Get the identifying information of the memory item. * - * @return The identifying information. + * @return The identifying information. */ QVector getIdentifierChain() const; /*! * Set a new identifier chain. * - * @param [in] newIdentifiers A list of strings containing the new memory identifier chain. + * @param [in] newIdentifiers A list of strings containing the new memory identifier chain. */ virtual void setNewIdentifierChain(QVector newIdentifiers); @@ -201,55 +201,55 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Setup the graphics rectangle. * - * @param [in] rectangleWidth Width of the graphics rectangle. - * @param [in] rectangleHeight Height of the graphics rectangle. + * @param [in] rectangleWidth Width of the graphics rectangle. + * @param [in] rectangleHeight Height of the graphics rectangle. */ void setGraphicsRectangle(qreal rectangleWidth, qreal rectangleHeight); /*! * Setup the memory graphics item. * - * @param [in] memoryStart Base address of the memory item. - * @param [in] memoryEnd Last address of the memory item. - * @param [in] identifier Identifier of the memory item. + * @param [in] memoryStart Base address of the memory item. + * @param [in] memoryEnd Last address of the memory item. + * @param [in] identifier Identifier of the memory item. */ void setupGraphicsItem(quint64 memoryStart, quint64 memoryEnd, QString const& identifier); /*! * Add text to the tooltip. * - * @param [in] toolTipAddition Text to be added to the tooltip. + * @param [in] toolTipAddition Text to be added to the tooltip. */ void addToToolTip(QString const& toolTipAddition); /*! * Get the name label. * - * @return The label containing the item name. + * @return The label containing the item name. */ QGraphicsTextItem* getNameLabel() const; /*! * Get the range start label. * - * @return The label containing the item range start. + * @return The label containing the item range start. */ QGraphicsTextItem* getRangeStartLabel() const; /*! * Get the range end label. * - * @return The label containing the item range end. + * @return The label containing the item range end. */ QGraphicsTextItem* getRangeEndLabel() const; /*! * Check if the selected label collides with range labels. * - * @param [in] label The selected label. - * @param [in] fontHeight Height of the text used in the selected label. + * @param [in] label The selected label. + * @param [in] fontHeight Height of the text used in the selected label. * - * @return True, if the selected label collides with range labels, otherwise false. + * @return True, if the selected label collides with range labels, otherwise false. */ virtual bool labelCollidesWithRangeLabels(QGraphicsTextItem* label, qreal fontHeight) const; @@ -261,7 +261,7 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem /*! * Handler for context menu. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ void contextMenuEvent(QGraphicsSceneContextMenuEvent *event); @@ -271,8 +271,8 @@ class MemoryDesignerGraphicsItem : public QObject, public QGraphicsRectItem * Open the document from which the containing component instance has been built from. Identifying * information allows the editor to be opened from the memory item. * - * @param [in] vlnv VLNV of the component. - * @param [in] identifierChain Identifying information for the memory item. + * @param [in] vlnv VLNV of the component. + * @param [in] identifierChain Identifying information for the memory item. */ void openComponentDocument(VLNV const& vlnv, QVector identifierChain); @@ -293,37 +293,37 @@ private slots: /*! * Get the available width of this item. * - * @return The available width of this item. + * @return The available width of this item. */ virtual qreal getItemWidth() const; /*! * Setup range labels. * - * @param [in] memoryStart The range start. - * @param [in] memoryEnd The range end. + * @param [in] memoryStart The range start. + * @param [in] memoryEnd The range end. */ void setupLabels(quint64 memoryStart, quint64 memoryEnd); /*! * Setup the original addresses for the memory item. * - * @param [in] memoryStart Base address of the memory item. - * @param [in] memoryEnd Last address of the memory item. + * @param [in] memoryStart Base address of the memory item. + * @param [in] memoryEnd Last address of the memory item. */ void setupOriginalAddresses(quint64 memoryStart, quint64 memoryEnd); /*! * Setup the tooltip and the memory range labels. * - * @param [in] identifier Selected identifier. + * @param [in] identifier Selected identifier. */ void setupToolTip(QString const& identifier); /*! * Get the VLNV of the component from the containing component instance. * - * @return The VLNV of the component. + * @return The VLNV of the component. */ VLNV getVLNVFromContainingInstance(); diff --git a/editors/MemoryDesigner/MemoryExtensionGraphicsItem.h b/editors/MemoryDesigner/MemoryExtensionGraphicsItem.h index de5c787a5..842f3556e 100644 --- a/editors/MemoryDesigner/MemoryExtensionGraphicsItem.h +++ b/editors/MemoryDesigner/MemoryExtensionGraphicsItem.h @@ -25,12 +25,12 @@ class MemoryExtensionGraphicsItem : public MemoryDesignerGraphicsItem /*! * The constructor. * - * @param [in] positionX X position of the extension. - * @param [in] positionY Y position of the extension. - * @param [in] extensionWidth Width of the extension. - * @param [in] extensionHeight Height of the extension. - * @param [in] containingInstance Component instance containing this memory item. - * @param [in] parentItem Parent item. + * @param [in] positionX X position of the extension. + * @param [in] positionY Y position of the extension. + * @param [in] extensionWidth Width of the extension. + * @param [in] extensionHeight Height of the extension. + * @param [in] containingInstance Component instance containing this memory item. + * @param [in] parentItem Parent item. */ MemoryExtensionGraphicsItem(qreal positionX, qreal positionY, qreal extensionWidth, qreal extensionHeight, QSharedPointer containingInstance, QGraphicsItem* parentItem); diff --git a/editors/MemoryDesigner/MemoryGraphicsItemHandler.h b/editors/MemoryDesigner/MemoryGraphicsItemHandler.h index 70214b383..8b573d2e0 100644 --- a/editors/MemoryDesigner/MemoryGraphicsItemHandler.h +++ b/editors/MemoryDesigner/MemoryGraphicsItemHandler.h @@ -48,93 +48,93 @@ class MemoryGraphicsItemHandler : public QObject /*! * Set a new value for filtering the address space segments. * - * @param [in] filterSegments Value for filtering address space segments. + * @param [in] filterSegments Value for filtering address space segments. */ void setFilterAddressSpaceSegments(bool filterSegments); /*! * Check if the address space segments are filtered. * - * @return True, if the address space segments are filtered, false otherwise. + * @return True, if the address space segments are filtered, false otherwise. */ bool addressSpaceSegmentsAreFiltered() const; /*! * Set a new value for filtering the address blocks. * - * @param [in] filterBlocks Value for filtering address blocks. + * @param [in] filterBlocks Value for filtering address blocks. */ void setFilterAddressBlocks(bool filterBlocks); /*! * Check if the address blocks are filtered. * - * @return True, if the address blocks are filtered, false otherwise. + * @return True, if the address blocks are filtered, false otherwise. */ bool addressBlocksAreFiltered() const; /*! * Set a new value for filtering the address block registers. * - * @param [in] filterSegments Value for filtering address block registers. + * @param [in] filterSegments Value for filtering address block registers. */ void setFilterAddressBlockRegisters(bool filterRegisters); /*! * Check if the address block registers are filtered. * - * @return True, if the address block registers are filtered, false otherwise. + * @return True, if the address block registers are filtered, false otherwise. */ bool addressBlockRegistersAreFiltered() const; /*! * Set a new value for filtering the register fields. * - * @param [in] filterFields Value for filtering register fields. + * @param [in] filterFields Value for filtering register fields. */ void setFilterFields(bool filterFields); /*! * Check if the register fields are filtered. * - * @return True, if the register fields are filtered, false otherwise. + * @return True, if the register fields are filtered, false otherwise. */ bool fieldsAreFiltered() const; /*! * Set a new value for filtering the unconnected memory items. * - * @param [in] filterUnconnected Value for filtering unconnected memory items. + * @param [in] filterUnconnected Value for filtering unconnected memory items. */ void filterUnconnectedMemoryItems(bool filterUnconnected); /*! * Check if the unconnected memory items are filtered. * - * @return True, if the unconnected memory items are filtered, false otherwise. + * @return True, if the unconnected memory items are filtered, false otherwise. */ bool unconnectedMemoryItemsAreFiltered() const; /*! * Set a new value for filtering the memory overlap items. * - * @param [in] filterOverlap Value for filtering memory overlap. + * @param [in] filterOverlap Value for filtering memory overlap. */ void filterMemoryOverlapItems(bool filterOverlap); /*! * Check if the memory overlap items are filtered. * - * @return True, if the memory overlap items are filtered, false otherwise. + * @return True, if the memory overlap items are filtered, false otherwise. */ bool memoryOverlapItemsAreFiltered() const; /*! * Create the memory items found in the design. * - * @param [in] connectionGraph Graph containing the connection paths. - * @param [in] spaceColumn Column for the address space graphics items. - * @param [in] memoryMapColumn Column for the memory map graphics items. + * @param [in] connectionGraph Graph containing the connection paths. + * @param [in] spaceColumn Column for the address space graphics items. + * @param [in] memoryMapColumn Column for the memory map graphics items. */ void createMemoryItems(QSharedPointer connectionGraph, MemoryColumn* spaceColumn, MemoryColumn* memoryMapColumn); @@ -149,8 +149,8 @@ class MemoryGraphicsItemHandler : public QObject /*! * Open the component document for the selected VLNV. * - * @param [in] vlnv VLNV of the containing component. - * @param [in] identifierChain List of string identifying the memory item. + * @param [in] vlnv VLNV of the containing component. + * @param [in] identifierChain List of string identifying the memory item. */ void openComponentDocument(VLNV const& vlnv, QVector identifierChain); @@ -162,11 +162,11 @@ class MemoryGraphicsItemHandler : public QObject /*! * Create an address space item. * - * @param [in] spaceItem Memory item containing address space data. - * @param [in] identifierChain List of string identifying the memory item. - * @param [in] containingInstance The component instance containing the selected address space. - * @param [in] spaceColumn The address space column. - * @param [in] mapColumn The memory map column. + * @param [in] spaceItem Memory item containing address space data. + * @param [in] identifierChain List of string identifying the memory item. + * @param [in] containingInstance The component instance containing the selected address space. + * @param [in] spaceColumn The address space column. + * @param [in] mapColumn The memory map column. */ void createAddressSpaceItem(QSharedPointer spaceItem, QVector identifierChain, QSharedPointer containingInstance, MemoryColumn* spaceColumn, @@ -175,10 +175,10 @@ class MemoryGraphicsItemHandler : public QObject /*! * Create a memory map item. * - * @param [in] mapItem Memory item containing memory map data. - * @param [in] identifierChain List of string identifying the memory item. - * @param [in] containingInstance The component instance containing the selected memory map. - * @param [in] containingColumn The memory map column. + * @param [in] mapItem Memory item containing memory map data. + * @param [in] identifierChain List of string identifying the memory item. + * @param [in] containingInstance The component instance containing the selected memory map. + * @param [in] containingColumn The memory map column. */ void createMemoryMapItem(QSharedPointer mapItem, QVector identifierChain, QSharedPointer containingInstance, MemoryColumn* containingColumn); @@ -186,14 +186,14 @@ class MemoryGraphicsItemHandler : public QObject /*! * Connect the signals from the selected memory graphics item. * - * @param [in] graphicsItem The selected memory graphics item. + * @param [in] graphicsItem The selected memory graphics item. */ void connectGraphicsItemSignals(MainMemoryGraphicsItem* graphicsItem); /*! * Filter a single unconnected memory item. * - * @param [in] memoryItem The selected memory item. + * @param [in] memoryItem The selected memory item. */ void filterUnconnectedMemoryItem(MainMemoryGraphicsItem* memoryItem); diff --git a/editors/MemoryDesigner/MemoryItem.h b/editors/MemoryDesigner/MemoryItem.h index 2dcb02258..f538646ba 100644 --- a/editors/MemoryDesigner/MemoryItem.h +++ b/editors/MemoryDesigner/MemoryItem.h @@ -28,239 +28,239 @@ class MemoryItem /*! * The constructor. * - * @param [in] name The name of the memory. - * @param [in] type The type of the memory. + * @param [in] name The name of the memory. + * @param [in] type The type of the memory. */ MemoryItem(QString const& name, QString const& type); /*! * Gets the name of the memory. * - * @return The name of the memory. + * @return The name of the memory. */ QString getName() const; /*! * Gets the type of the memory e.g. address space or register. * - * @return The type of the memory. + * @return The type of the memory. */ QString getType() const; /*! * Sets a display name for the memory. * - * @param [in] displayName The display name to set. + * @param [in] displayName The display name to set. */ void setDisplayName(QString const& displayName); /*! * Gets the display name of the memory. * - * @return The display name of the memory. + * @return The display name of the memory. */ QString getDisplayName() const; /*! * Sets an identifier for the memory. * - * @param [in] identifier The identifier to set. + * @param [in] identifier The identifier to set. */ void setIdentifier(QString const& identifier); /*! * Gets the memory identifier. * - * @return The identifier for the memory. + * @return The identifier for the memory. */ QString getIdentifier() const; /*! * Gets the number of addressable unit bits in the memory. * - * @return The number addressable unit bits in the memory. + * @return The number addressable unit bits in the memory. */ QString getAUB() const; /*! * Sets the number of addressable unit bits in the memory. * - * @param [in] aub The number of bits in an addressable unit. + * @param [in] aub The number of bits in an addressable unit. */ void setAUB(QString const& aub); /*! * Sets the address for the memory. * - * @param [in] address The memory address to set. + * @param [in] address The memory address to set. */ void setAddress(QString const& address); /*! * Gets the memory address. * - * @return The address for the memory. + * @return The address for the memory. */ QString getAddress() const; /*! * Sets the range for the memory. * - * @param [in] range The range to set. + * @param [in] range The range to set. */ void setRange(QString const& range); /*! * Gets the range for the memory. * - * @return The range for the memory. + * @return The range for the memory. */ QString getRange() const; /*! * Sets the width for the memory. * - * @param [in] width The memory width to set. + * @param [in] width The memory width to set. */ void setWidth(QString const& width); /*! * Gets the memory width in bits. * - * @return The width of the memory. + * @return The width of the memory. */ QString getWidth() const; /*! * Sets the size for the memory. * - * @param [in] size The size to set. + * @param [in] size The size to set. */ void setSize(QString const& size); /*! * Gets the size for the memory. * - * @return The memory size. + * @return The memory size. */ QString getSize() const; /*! * Sets the offset for the memory. * - * @param [in] offset The offset to set. + * @param [in] offset The offset to set. */ void setOffset(QString const& offset); /*! * Gets the offset for the memory. * - * @return The memory offset. + * @return The memory offset. */ QString getOffset() const; /*! * Adds a sub-element for the memory. * - * @param [in] child The sub-element to add. + * @param [in] child The sub-element to add. */ void addChild(QSharedPointer child); /*! * Gets the sub-elements for the memory. * - * @return The sub-elements for the memory. + * @return The sub-elements for the memory. */ QVector > getChildItems() const; /*! * Set the dimension of the memory item. * - * @param [in] dimension The new dimension value. + * @param [in] dimension The new dimension value. */ void setDimension(QString const& dimension); /*! * Gets the dimension of the memory. Only used for registers. * - * @return The dimension of the memory. + * @return The dimension of the memory. */ QString getDimension() const; /*! * Set the usage for the memory item. * - * @param [in] newUsage The new usage value. + * @param [in] newUsage The new usage value. */ void setUsage(General::Usage const& newUsage); /*! * Get the usage of the memory item. * - * @return The usage value. + * @return The usage value. */ General::Usage getUsage() const; /*! * Set the value for the memory item. * - * @param [in] newValue The new value. + * @param [in] newValue The new value. */ void setValue(QString const& newValue); /*! * Get the value of the memory item. * - * @return The value. + * @return The value. */ QString getValue() const; /*! * Get the reset value of the memory item. * - * @return The reset value of the memory item. + * @return The reset value of the memory item. */ QString getResetValue() const; /*! * Set a new reset value for the memory item. * - * @param [in] newResetValue The new reset value. + * @param [in] newResetValue The new reset value. */ void setResetValue(QString const& newResetValue); /*! * Get the reset mask of the memory item. * - * @return The reset mask of the memory item. + * @return The reset mask of the memory item. */ QString getResetMask() const; /*! * Set a new reset mask for the memory item. * - * @param [in] newResetMask The new reset mask. + * @param [in] newResetMask The new reset mask. */ void setResetMask(QString const& newResetMask); /*! * Get the is present of the memory item. * - * @return The is present of the memory item. + * @return The is present of the memory item. */ QString getIsPresent() const; /*! * Set a new is present for the memory item. * - * @param [in] newIsPresent The new is present. + * @param [in] newIsPresent The new is present. */ void setIsPresent(QString const& newIsPresent); /*! * Set a new initiator reference for the memory item. * - * @param [in] newReference The new initiator reference. + * @param [in] newReference The new initiator reference. */ void setInitiatorReference(QString const& newReference); @@ -272,7 +272,7 @@ class MemoryItem /*! * Set a new segment reference for the memory item. * - * @param [in] newReference The new segment reference. + * @param [in] newReference The new segment reference. */ void setSegmentReference(QString const& newReference); diff --git a/editors/MemoryDesigner/MemoryMapGraphicsItem.h b/editors/MemoryDesigner/MemoryMapGraphicsItem.h index f3ba0eaa5..43396c565 100644 --- a/editors/MemoryDesigner/MemoryMapGraphicsItem.h +++ b/editors/MemoryDesigner/MemoryMapGraphicsItem.h @@ -36,13 +36,13 @@ class MemoryMapGraphicsItem : public MainMemoryGraphicsItem /*! * The constructor. * - * @param [in] memoryItem Memory item containing memory map data. - * @param [in] identifierChain List of string identifying the memory item. - * @param [in] filterAddressBlocks Value for filtering memory map address blocks. - * @param [in] filterRegisters Value for filtering address block registers. - * @param [in] filterFields Value for filtering register fields. - * @param [in] containingInstance Instance containing the memory map. - * @param [in] parent The parent item. + * @param [in] memoryItem Memory item containing memory map data. + * @param [in] identifierChain List of string identifying the memory item. + * @param [in] filterAddressBlocks Value for filtering memory map address blocks. + * @param [in] filterRegisters Value for filtering address block registers. + * @param [in] filterFields Value for filtering register fields. + * @param [in] containingInstance Instance containing the memory map. + * @param [in] parent The parent item. */ MemoryMapGraphicsItem(QSharedPointer memoryItem, QVector identifierChain, bool filterAddressBlocks, bool filterRegisters, bool filterFields, @@ -61,7 +61,7 @@ class MemoryMapGraphicsItem : public MainMemoryGraphicsItem /*! * Change the width of this item and the contained register graphics items. * - * @param [in] widthChange The change in width. + * @param [in] widthChange The change in width. */ void changeWidth(qreal widthChange); @@ -69,7 +69,7 @@ class MemoryMapGraphicsItem : public MainMemoryGraphicsItem * Get the maximum needed change in width to fully display the name labels of all the field items within the * address block items. * - * @return The maximum needed change in width to display the name labels of all the field items. + * @return The maximum needed change in width to display the name labels of all the field items. */ qreal getMaximumNeededChangeInFieldWidth() const; @@ -91,10 +91,10 @@ class MemoryMapGraphicsItem : public MainMemoryGraphicsItem /*! * Create a new address block graphics item. * - * @param [in] subMemoryItem Memory item containing address block data. - * @param [in] isEmpty Boolean value for an empty address block. + * @param [in] subMemoryItem Memory item containing address block data. + * @param [in] isEmpty Boolean value for an empty address block. * - * @return The created address block graphics item. + * @return The created address block graphics item. */ virtual MemoryDesignerChildGraphicsItem* createNewSubItem(QSharedPointer subMemoryItem, bool isEmpty) override; @@ -102,42 +102,42 @@ class MemoryMapGraphicsItem : public MainMemoryGraphicsItem /*! * Get the name of the address block containing the selected register. * - * @param [in] registerBaseAddress Base address of the selected register. - * @param [in] registerLastAddress Last address of the selected register. + * @param [in] registerBaseAddress Base address of the selected register. + * @param [in] registerLastAddress Last address of the selected register. * - * @return The name of the address block containing the selected register. + * @return The name of the address block containing the selected register. */ QString getContainingAddressBlockName(quint64 registerBaseAddress, quint64 registerLastAddress) const; /*! * Create an empty address block graphics item. * - * @param [in] beginAddress Base address of the empty address block graphics item. - * @param [in] rangeEnd End address of the empty address block graphics item. + * @param [in] beginAddress Base address of the empty address block graphics item. + * @param [in] rangeEnd End address of the empty address block graphics item. * - * @return The created address block graphics item. + * @return The created address block graphics item. */ virtual MemoryDesignerChildGraphicsItem* createEmptySubItem(quint64 beginAddress, quint64 rangeEnd); /*! * Get the minimum height for the memory map sub items. * - * @return The minimum height for the memory map sub items. + * @return The minimum height for the memory map sub items. */ virtual qreal getMinimumHeightForSubItems() const override final; /*! * Setup sub items for the memory map. * - * @param [in] blockXPosition X coordinate of the memory sub items. - * @param [in] memoryItem The memory map memory item. + * @param [in] blockXPosition X coordinate of the memory sub items. + * @param [in] memoryItem The memory map memory item. */ void setupSubItems(qreal blockXPosition, QSharedPointer memoryItem); /*! * Get the width of the memory map sub items. * - * @return Width of the memory map sub items. + * @return Width of the memory map sub items. */ qreal getSubItemWidth() const; diff --git a/editors/MemoryDesigner/RegisterGraphicsItem.h b/editors/MemoryDesigner/RegisterGraphicsItem.h index 3c0997458..5e4e15b3a 100644 --- a/editors/MemoryDesigner/RegisterGraphicsItem.h +++ b/editors/MemoryDesigner/RegisterGraphicsItem.h @@ -35,13 +35,13 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * The constructor. * - * @param [in] registerItem Memory item containing the register data. - * @param [in] isEmptyRegister Boolean value to represent empty registers. - * @param [in] registerWidth Width of the register graphics item. - * @param [in] identifierChain List of string identifying the memory item. - * @param [in] filterFields Value for filtering register fields. - * @param [in] containingInstance Name of the containing component instance. - * @param [in] parentItem The parent memory graphics item. + * @param [in] registerItem Memory item containing the register data. + * @param [in] isEmptyRegister Boolean value to represent empty registers. + * @param [in] registerWidth Width of the register graphics item. + * @param [in] identifierChain List of string identifying the memory item. + * @param [in] filterFields Value for filtering register fields. + * @param [in] containingInstance Name of the containing component instance. + * @param [in] parentItem The parent memory graphics item. */ RegisterGraphicsItem(QSharedPointer registerItem, bool isEmptyRegister, qreal registerWidth, QVector identifierChain, bool filterFields, @@ -60,21 +60,21 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Condense this item and the contained field graphics items. * - * @param [in] newItemHeight The condensed height. + * @param [in] newItemHeight The condensed height. */ virtual void condense(qreal newItemHeight); /*! * Change the width of this item and the contained field graphics items. * - * @param [in] widthChange The change in width. + * @param [in] widthChange The change in width. */ void changeWidth(qreal widthChange); /*! * Get the maximum needed change in width to fully display the name labels of all the contained field items. * - * @return The maximum needed change in width to display the name labels of all the field items. + * @return The maximum needed change in width to display the name labels of all the field items. */ qreal getMaximumNeededChangeInFieldWidth() const; @@ -86,7 +86,7 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Set a new identifier chain. * - * @param [in] newIdentifiers A list of strings containing the new memory identifier chain. + * @param [in] newIdentifiers A list of strings containing the new memory identifier chain. */ virtual void setNewIdentifierChain(QVector newIdentifiers); @@ -111,10 +111,10 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the register end. * - * @param [in] addressUnitBits Address unit bits of the register. - * @param [in] registerSize Size of the register. + * @param [in] addressUnitBits Address unit bits of the register. + * @param [in] registerSize Size of the register. * - * @return The end range of the register item. + * @return The end range of the register item. */ quint64 getRegisterEnd(unsigned int addressUnitBits, quint64 registerSize) const; @@ -126,16 +126,16 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Setup the field graphics items. * - * @param [in] registerItem The selected register memory item. + * @param [in] registerItem The selected register memory item. */ void setupFields(QSharedPointer registerItem); /*! * Get the field items in last bit order. * - * @param [in] registerItem Memory item containing the register data. + * @param [in] registerItem Memory item containing the register data. * - * @return Field items in last bit order with calculated offsets and widths. + * @return Field items in last bit order with calculated offsets and widths. */ QMultiMap getFieldItemsInLastBitOrder( QSharedPointer registerItem) const; @@ -143,12 +143,12 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Create an empty field graphics item. * - * @param [in] currentOffset Offset of the field. - * @param [in] lastBit Last bit used by the field. - * @param [in] oneBitWidth Width of a one bit. - * @param [in] registerEnd End of the containing register. - * @param [in] fieldsStartPosition The start coordinate for the field graphics items. - * @param [in] fieldFont Font used in fields. + * @param [in] currentOffset Offset of the field. + * @param [in] lastBit Last bit used by the field. + * @param [in] oneBitWidth Width of a one bit. + * @param [in] registerEnd End of the containing register. + * @param [in] fieldsStartPosition The start coordinate for the field graphics items. + * @param [in] fieldFont Font used in fields. */ void createEmptyFieldItem(quint64 currentOffset, quint64 lastBit, qreal oneBitWidth, quint64 registerEnd, qreal fieldsStartPosition, QFont fieldFont); @@ -156,14 +156,14 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Create a field graphics item. * - * @param [in] fieldItem The field memory item. - * @param [in] fieldOffset Offset of the field. - * @param [in] fieldWidth Width of the field. - * @param [in] isEmptyField Holds whether the field is empty or not. - * @param [in] oneBitWidth Width of a one bit. - * @param [in] registerEnd End of the containing register. - * @param [in] fieldsStartPosition The start coordinate for the field graphics items. - * @param [in] fieldFont Font used in fields. + * @param [in] fieldItem The field memory item. + * @param [in] fieldOffset Offset of the field. + * @param [in] fieldWidth Width of the field. + * @param [in] isEmptyField Holds whether the field is empty or not. + * @param [in] oneBitWidth Width of a one bit. + * @param [in] registerEnd End of the containing register. + * @param [in] fieldsStartPosition The start coordinate for the field graphics items. + * @param [in] fieldFont Font used in fields. */ void createFieldGraphicsItem(QSharedPointer fieldItem, quint64 fieldOffset, quint64 fieldWidth, bool isEmptyField, qreal oneBitWidth, quint64 registerEnd, qreal fieldsStartPosition, QFont fieldFont); @@ -171,20 +171,20 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the width available for the register item. * - * @return The width available for the register item. + * @return The width available for the register item. */ virtual qreal getItemWidth() const; /*! * Create overlapping markers for the selected field. * - * @param [in] fieldIndex Index of the selected field. - * @param [in] fieldCount Number of fields contained within the register. - * @param [in] fieldItem The selected field item. - * @param [in] fieldRectangle Bounding rectangle of the field item. - * @param [in] fieldLineWidth Line width of the field item. - * @param [in] overlapBrush Brush used to draw the field item. - * @param [in] containingScene Scene containing field item. + * @param [in] fieldIndex Index of the selected field. + * @param [in] fieldCount Number of fields contained within the register. + * @param [in] fieldItem The selected field item. + * @param [in] fieldRectangle Bounding rectangle of the field item. + * @param [in] fieldLineWidth Line width of the field item. + * @param [in] overlapBrush Brush used to draw the field item. + * @param [in] containingScene Scene containing field item. */ void createOverlappingMarkersForField(int fieldIndex, int fieldCount, FieldGraphicsItem* fieldItem, QRectF fieldRectangle, int fieldLineWidth, QBrush overlapBrush, QGraphicsScene* containingScene); @@ -192,12 +192,12 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Check if a field overlaps another field. * - * @param [in] firstItemRectangle Bounding rectangle of the first field item. - * @param [in] firstItemLineWidth Line width of the first field item. - * @param [in] secondItemRectangle Bounding rectangle of the second field item. - * @param [in] secondItemLineWidth Line width of the first field item. + * @param [in] firstItemRectangle Bounding rectangle of the first field item. + * @param [in] firstItemLineWidth Line width of the first field item. + * @param [in] secondItemRectangle Bounding rectangle of the second field item. + * @param [in] secondItemLineWidth Line width of the first field item. * - * @return True, if the field overlaps another field, false otherwise. + * @return True, if the field overlaps another field, false otherwise. */ bool fieldOverlapsAnotherField(QRectF firstItemRectangle, int firstItemLineWidth, QRectF secondItemRectangle, int secondItemLineWidth) const; @@ -205,13 +205,13 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the x coordinate modifier for the overlapping field. * - * @param [in] firstOffset Offset of the first field. - * @param [in] firstLastBit Last bit of the first field. - * @param [in] secondOffset Offset of the second field. - * @param [in] secondLastbit Last bit of the second field. - * @param [in] changePerBit Width change per bit. + * @param [in] firstOffset Offset of the first field. + * @param [in] firstLastBit Last bit of the first field. + * @param [in] secondOffset Offset of the second field. + * @param [in] secondLastbit Last bit of the second field. + * @param [in] changePerBit Width change per bit. * - * @return The x coordinate modifier for the overlapping field. + * @return The x coordinate modifier for the overlapping field. */ qreal getOverlappingFieldPositionModifier(quint64 firstOffset, quint64 firstLastBit, quint64 secondOffset, quint64 secondLastbit, qreal changePerBit) const; @@ -219,15 +219,15 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the new x coordinate for the selected field item. * - * @param [in] fieldItem The selected field item. - * @param [in] fieldLastBit Last bit of the selected field. - * @param [in] fieldItemWidthChange Width change of the selected field item. - * @param [in] overallWidthChange Overall width change of the contained field items. - * @param [in] overallOverlapModifier Overlap modifier of the selected field item. - * @param [in] currentOverlapModifier Overall overlap modifier of the contained field items. - * @param [in] fieldsStartPosition Start position of the field items. + * @param [in] fieldItem The selected field item. + * @param [in] fieldLastBit Last bit of the selected field. + * @param [in] fieldItemWidthChange Width change of the selected field item. + * @param [in] overallWidthChange Overall width change of the contained field items. + * @param [in] overallOverlapModifier Overlap modifier of the selected field item. + * @param [in] currentOverlapModifier Overall overlap modifier of the contained field items. + * @param [in] fieldsStartPosition Start position of the field items. * - * @return The new x coordinate. + * @return The new x coordinate. */ qreal getNewFieldPositionX(FieldGraphicsItem* fieldItem, quint64 fieldLastBit, qreal fieldItemWidthChange, qreal overallWidthChange, qreal overallOverlapModifier, qreal currentOverlapModifier, @@ -236,10 +236,10 @@ class RegisterGraphicsItem : public MemoryDesignerChildGraphicsItem /*! * Get the field width modified to fit into the register bounds. * - * @param [in] fieldLastBit Last bit of the selected field. - * @param [in] fieldOffset Offset of the selected field. + * @param [in] fieldLastBit Last bit of the selected field. + * @param [in] fieldOffset Offset of the selected field. * - * @return Modified width of the field item. + * @return Modified width of the field item. */ quint64 getModifiedFieldWidth(quint64 fieldLastBit, quint64 fieldOffset) const; diff --git a/editors/MemoryDesigner/SubMemoryLayout.h b/editors/MemoryDesigner/SubMemoryLayout.h index 0542fd54e..11bc5395b 100644 --- a/editors/MemoryDesigner/SubMemoryLayout.h +++ b/editors/MemoryDesigner/SubMemoryLayout.h @@ -33,10 +33,10 @@ class SubMemoryLayout /*! * The constructor. * - * @param [in] memoryItem Memory item containing main memory item data. - * @param [in] subItemType Type of the sub items. - * @param [in] filterSubItems Value for filtering memory sub items. - * @param [in] mainGraphicsItem The main graphics item. + * @param [in] memoryItem Memory item containing main memory item data. + * @param [in] subItemType Type of the sub items. + * @param [in] filterSubItems Value for filtering memory sub items. + * @param [in] mainGraphicsItem The main graphics item. */ SubMemoryLayout(QSharedPointer memoryItem, QString const& subItemType, bool filterSubItems, MemoryDesignerGraphicsItem* mainGraphicsItem); @@ -49,28 +49,28 @@ class SubMemoryLayout /*! * Change the ranges of the child items. * - * @param [in] offset The offset of the main item. + * @param [in] offset The offset of the main item. */ void changeChildItemRanges(quint64 offset); /*! * Get the sub memory items. * - * @return A map containing the sub memory items with the base addresses. + * @return A map containing the sub memory items with the base addresses. */ QMultiMap getSubMemoryItems() const; /*! * Add the memory connection item to the correct memory sub items. * - * @param [in] connectionItem The selected memory connection item. + * @param [in] connectionItem The selected memory connection item. */ void addConnectionToSubItems(MemoryConnectionItem* connectionItem); /*! * Check whether the sub items are filtered or not. * - * @return True, if the sub items are filtered, otherwise false. + * @return True, if the sub items are filtered, otherwise false. */ bool subItemsAreFiltered() const; @@ -87,30 +87,30 @@ class SubMemoryLayout /*! * Get the height addition of the out of bounds sub memory items. * - * @return The height addition of the out of bounds sub memory items. + * @return The height addition of the out of bounds sub memory items. */ quint64 getSubItemHeightAddition() const; /*! * Get the addresses that are retained after item compression. * - * @return Addresses that are retained after compressing the item. + * @return Addresses that are retained after compressing the item. */ QVector getUnCutAddresses() const; /*! * Get the coordinates that are retained after item compression. * - * @return Coordinates that are retained after compressing the item. + * @return Coordinates that are retained after compressing the item. */ QVector getUnCutCoordinates() const; /*! * Compress the contained sub memory items to contain the retained coordinates. * - * @param [in] unCutCoordinates The retained coordinates. - * @param [in] CUTMODIFIER Modifier for the cut area. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] unCutCoordinates The retained coordinates. + * @param [in] CUTMODIFIER Modifier for the cut area. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. */ void compressSubItemsToUnCutCoordinates(QVector unCutCoordinates, const qreal CUTMODIFIER, bool memoryItemsAreCompressed); @@ -118,14 +118,14 @@ class SubMemoryLayout /*! * Get layout height modified by the height of the out of bounds sub memory items. * - * @return True height of the layout. + * @return True height of the layout. */ virtual quint64 getHeightWithSubItems() const; /*! * Get the scene bounding rectangle of the layout modified by the height of the sub memory items. * - * @return True scene bounding rectangle of the layout. + * @return True scene bounding rectangle of the layout. */ virtual QRectF getSceneRectangleWithSubItems() const; @@ -134,23 +134,23 @@ class SubMemoryLayout /*! * Set a new value for filtering memory sub items. * - * @param [in] filterValue New filtering value for the memory sub items. + * @param [in] filterValue New filtering value for the memory sub items. */ void setFilterSubItems(bool filterValue); /*! * Get the type of the memory sub items. * - * @return The type of the memory sub items. + * @return The type of the memory sub items. */ QString getSubItemType() const; /*! * Setup the sub memory items. * - * @param [in] subItemPositionX X position of the sub memory items. - * @param [in] subItemType Type of the memory sub items. - * @param [in] memoryItem The memory item containing the sub items. + * @param [in] subItemPositionX X position of the sub memory items. + * @param [in] subItemType Type of the memory sub items. + * @param [in] memoryItem The memory item containing the sub items. */ void setupSubItems(qreal subItemPositionX, QString const& subItemType, QSharedPointer memoryItem); @@ -158,12 +158,12 @@ class SubMemoryLayout /*! * Compress the sub items. * - * @param [in] itemBaseAddress Base address of the containing item. - * @param [in] itemLastAddress Last address of the containing item. - * @param [in] minimumSubItemHeight The minimum height of the sub items. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] itemBaseAddress Base address of the containing item. + * @param [in] itemLastAddress Last address of the containing item. + * @param [in] minimumSubItemHeight The minimum height of the sub items. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. * - * @return The total height of the condensed sub items. + * @return The total height of the condensed sub items. */ qreal compressChildItems(quint64 itemBaseAddress, quint64 itemLastAddress, qreal minimumSubItemHeight, bool memoryItemsAreCondensed); @@ -171,10 +171,10 @@ class SubMemoryLayout /*! * Compress the selected sub item. * - * @param [in] subItem The selected sub item. - * @param [in] minimumSubItemHeight Minimum height of the sub item. - * @param [in] positionY Y-coordinate for the sub item. - * @param [in] memoryItemsAreCompressed Flag for condensing memory items. + * @param [in] subItem The selected sub item. + * @param [in] minimumSubItemHeight Minimum height of the sub item. + * @param [in] positionY Y-coordinate for the sub item. + * @param [in] memoryItemsAreCompressed Flag for condensing memory items. */ quint64 compressSubItem(MemoryDesignerChildGraphicsItem* subItem, qreal minimumSubItemHeight, quint64 positionY, bool memoryItemsAreCondensed); @@ -187,10 +187,10 @@ class SubMemoryLayout /*! * Create a new sub memory graphics item. * - * @param [in] subMemoryItem Memory item containing sub memory item data. - * @param [in] isEmpty Boolean value for an empty sub memory item. + * @param [in] subMemoryItem Memory item containing sub memory item data. + * @param [in] isEmpty Boolean value for an empty sub memory item. * - * @return The created sub memory graphics item. + * @return The created sub memory graphics item. */ virtual MemoryDesignerChildGraphicsItem* createNewSubItem(QSharedPointer subMemoryItem, bool isEmpty) = 0; @@ -198,10 +198,10 @@ class SubMemoryLayout /*! * Create an empty sub memory graphics item and position it. * - * @param [in] subItemBaseAddress Base address of the empty sub memory item. - * @param [in] subItemLastAddress Last address of the empty sub memory item. - * @param [in] subItemPositionX X coordinate of the empty sub memory item. - * @param [in] mainItemBaseAddress Base address of the main memory item. + * @param [in] subItemBaseAddress Base address of the empty sub memory item. + * @param [in] subItemLastAddress Last address of the empty sub memory item. + * @param [in] subItemPositionX X coordinate of the empty sub memory item. + * @param [in] mainItemBaseAddress Base address of the main memory item. */ void createAndPositionNewEmptySubItem(quint64 subItemBaseAddress, quint64 subItemLastAddress, qreal subItemPositionX, quint64 mainItemBaseAddress); @@ -209,20 +209,20 @@ class SubMemoryLayout /*! * Create an empty sub memory graphics item. * - * @param [in] beginAddress Base address of the empty sub memory graphics item. - * @param [in] rangeEnd End address of the empty sub memory graphics item. + * @param [in] beginAddress Base address of the empty sub memory graphics item. + * @param [in] rangeEnd End address of the empty sub memory graphics item. * - * @return The created sub memory graphics item. + * @return The created sub memory graphics item. */ virtual MemoryDesignerChildGraphicsItem* createEmptySubItem(quint64 beginAddress, quint64 rangeEnd) = 0; /*! * Place a sub memory graphics item. * - * @param [in] subItemXPosition X position of the sub memory item. - * @param [in] mainItemBaseAddress Base address of the main memory item. - * @param [in] subItemOffset Offset of the sub memory item. - * @param [in] newSubItem The selected sub memory item. + * @param [in] subItemXPosition X position of the sub memory item. + * @param [in] mainItemBaseAddress Base address of the main memory item. + * @param [in] subItemOffset Offset of the sub memory item. + * @param [in] newSubItem The selected sub memory item. */ void positionNewSubItem(qreal const& subItemXPosition, quint64 const& mainItemBaseAddress, quint64 const& subItemOffset, MemoryDesignerChildGraphicsItem* newSubItem); @@ -230,7 +230,7 @@ class SubMemoryLayout /*! * Set the color for a faulty sub memory item. * - * @param [in] subItem The selected sub memory item. + * @param [in] subItem The selected sub memory item. */ void setFaultySubItemColor(MemoryDesignerChildGraphicsItem* subItem); diff --git a/editors/PythonSourceEditor/PythonSourceEditor.h b/editors/PythonSourceEditor/PythonSourceEditor.h index d65f0c65a..6c9dfc9f0 100644 --- a/editors/PythonSourceEditor/PythonSourceEditor.h +++ b/editors/PythonSourceEditor/PythonSourceEditor.h @@ -42,9 +42,9 @@ class PythonSourceEditor : public QWidget /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. * - * @return + * @return */ explicit PythonSourceEditor(QWidget* parent = nullptr); @@ -103,24 +103,24 @@ private slots: /*! * Update the tab label and path in tooltip. * - * @param [in] filePath Path to the edited file. - * @param [in] modified True, if file content is modified, otherwise false. + * @param [in] filePath Path to the edited file. + * @param [in] modified True, if file content is modified, otherwise false. */ void updateTabLabel(QString const& filePath, bool modified); /*! * Create a new editor and add it in the tabs. * - * @param [in] label The label on the tab for the editor. + * @param [in] label The label on the tab for the editor. * - * @return The created editor. + * @return The created editor. */ ScriptInputEditor* createEditor(QString const& label); /*! * Apply formatting settings to a single editor. * - * @param [in] editor The editor to apply to. + * @param [in] editor The editor to apply to. */ void applySettings(ScriptInputEditor* editor) const; @@ -128,7 +128,7 @@ private slots: /*! * Setup the Python interpreter. * - * @return True, if the setup was successful and interpreter stated, otherwise false. + * @return True, if the setup was successful and interpreter stated, otherwise false. */ bool setupInterpreter(); @@ -138,7 +138,7 @@ private slots: /* * Setup the toolbar and actions. * - * @param[in] enableRun Enable flag for script run actions. + * @param[in] enableRun Enable flag for script run actions. */ void setupToolbar(bool enableRun); diff --git a/editors/PythonSourceEditor/PythonSourceHighlight.h b/editors/PythonSourceEditor/PythonSourceHighlight.h index d37de37c8..016203cf8 100644 --- a/editors/PythonSourceEditor/PythonSourceHighlight.h +++ b/editors/PythonSourceEditor/PythonSourceHighlight.h @@ -38,21 +38,21 @@ class PythonSourceHighlight: public SourceHighlightStyle /*! * Get the language specific keywords. * - * @return The language keywords. + * @return The language keywords. */ virtual QStringList keywords() const; /*! * Get the language specific preprocessor directives. * - * @return The preprocessor directives. + * @return The preprocessor directives. */ virtual QStringList preprocessorDirectives() const; /*! * Apply other language specific rules to highlighting. * - * @param [in] highlighter The highlighter to apply the rules to. + * @param [in] highlighter The highlighter to apply the rules to. */ virtual void applyLanguageSpecificRules(LanguageHighlighter* highlighter) const; diff --git a/editors/PythonSourceEditor/ScriptInputEditor.h b/editors/PythonSourceEditor/ScriptInputEditor.h index fd74bcb20..00b589c14 100644 --- a/editors/PythonSourceEditor/ScriptInputEditor.h +++ b/editors/PythonSourceEditor/ScriptInputEditor.h @@ -27,7 +27,7 @@ class ScriptInputEditor : public QPlainTextEdit /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ explicit ScriptInputEditor(QWidget* parent = nullptr); @@ -37,29 +37,29 @@ class ScriptInputEditor : public QPlainTextEdit /*! * Get the required width of the side area. * - * @return The width of the side area in pixels. + * @return The width of the side area in pixels. */ int sideAreaWidth() const; /*! * Handler for side area paint event. * - * @param [in] The paint event. + * @param [in] The paint event. */ void sideAreaPaintEvent(QPaintEvent* event); /*! * Get the text on selected lines. * - * @return The text on the currently selected lines. + * @return The text on the currently selected lines. */ QString getSelectedLines() const; /*! * Set the style for automatic indentation. * - * @param [in] useTabs Whether to use tabs or spaces. - * @param [in] width Number of spaces to use. + * @param [in] useTabs Whether to use tabs or spaces. + * @param [in] width Number of spaces to use. */ void setIndentStyle(bool useTabs, unsigned int width); @@ -79,15 +79,15 @@ private slots: /*! * Update the side area width when the number of lines (blocks) change. * - * @param [in] newBlockCount The number of blocks in the text. + * @param [in] newBlockCount The number of blocks in the text. */ void updateSideAreaWidth(int newBlockCount); /*! * Handler for side area update event. * - * @param [in] rect The area being updated. - * @param [in] dy The change of y coordinate in the update. + * @param [in] rect The area being updated. + * @param [in] dy The change of y coordinate in the update. */ void updateSideArea(const QRect &rect, int dy); diff --git a/editors/PythonSourceEditor/ScriptViewEditor.h b/editors/PythonSourceEditor/ScriptViewEditor.h index 83151db98..99d43c41a 100644 --- a/editors/PythonSourceEditor/ScriptViewEditor.h +++ b/editors/PythonSourceEditor/ScriptViewEditor.h @@ -25,7 +25,7 @@ class ScriptViewEditor : public QPlainTextEdit /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ explicit ScriptViewEditor(QWidget* parent = nullptr); @@ -36,19 +36,19 @@ public slots: /*! Print the given text in the editor. * - * @param [in] input The text to print. + * @param [in] input The text to print. */ void printInput(QString const& input); /*! Print the given text in the editor. * - * @param [in] input The text to print. + * @param [in] input The text to print. */ void print(QString const& input); /*! Print the given error text in the editor. * - * @param [in] input The error text to print. + * @param [in] input The error text to print. */ void printError(QString const& input); @@ -57,8 +57,8 @@ public slots: /*! * Print the given input with given color. * - * @param [in] input The input text to print. - * @param [in] textColor The color of the text to use. + * @param [in] input The input text to print. + * @param [in] textColor The color of the text to use. */ void printWithColor(QString const& input, QColor const& textColor); diff --git a/editors/SystemDesign/ApiGraphicsConnection.h b/editors/SystemDesign/ApiGraphicsConnection.h index e141dcc38..acdf4fc1d 100644 --- a/editors/SystemDesign/ApiGraphicsConnection.h +++ b/editors/SystemDesign/ApiGraphicsConnection.h @@ -39,11 +39,11 @@ class ApiGraphicsConnection : public ConnectionItem /*! * Constructor which creates an open-ended diagram interconnection. * - * @param [in] p1 The start point of the connection. - * @param [in] dir1 Direction of the start point. - * @param [in] p2 The end point of the connection. - * @param [in] dir2 Direction of the end point. - * @param [in] parent The design diagram containing the connection. + * @param [in] p1 The start point of the connection. + * @param [in] dir1 Direction of the start point. + * @param [in] p2 The end point of the connection. + * @param [in] dir2 Direction of the end point. + * @param [in] parent The design diagram containing the connection. */ ApiGraphicsConnection(QPointF const& p1, QVector2D const& dir1, QPointF const& p2, QVector2D const& dir2, DesignDiagram* parent); @@ -51,12 +51,12 @@ class ApiGraphicsConnection : public ConnectionItem /*! * The constructor containing the API interconnection. * - * @param [in] endpoint1 The start point of the connection. - * @param [in] endpoint2 The end point of the connection. - * @param [in] apiInterconnection The API interconnection being connected. - * @param [in] route The route of the connection. - * @param [in] autoConnect If true, automatically connects the two end points. - * @param [in] parent The design diagram containing the connection. + * @param [in] endpoint1 The start point of the connection. + * @param [in] endpoint2 The end point of the connection. + * @param [in] apiInterconnection The API interconnection being connected. + * @param [in] route The route of the connection. + * @param [in] autoConnect If true, automatically connects the two end points. + * @param [in] parent The design diagram containing the connection. */ ApiGraphicsConnection(ConnectionEndpoint* endpoint1, ConnectionEndpoint* endpoint2, QSharedPointer apiInterconnection, @@ -70,7 +70,7 @@ class ApiGraphicsConnection : public ConnectionItem /*! * Get the type of the graphics item. * - * @return GFX_TYPE_SW_API_CONNECTION. + * @return GFX_TYPE_SW_API_CONNECTION. */ int type() const final { return Type; } diff --git a/editors/SystemDesign/ComGraphicsConnection.h b/editors/SystemDesign/ComGraphicsConnection.h index c2a160f2b..dc3f672fc 100644 --- a/editors/SystemDesign/ComGraphicsConnection.h +++ b/editors/SystemDesign/ComGraphicsConnection.h @@ -38,11 +38,11 @@ class ComGraphicsConnection : public ConnectionItem /*! * Constructor which creates an open-ended diagram interconnection. * - * @param [in] p1 The start point. - * @param [in] dir1 Direction of the start point. - * @param [in] p2 The end point. - * @param [in] dir2 Direction of the end point. - * @param [in] parent The design diagram containing the connection. + * @param [in] p1 The start point. + * @param [in] dir1 Direction of the start point. + * @param [in] p2 The end point. + * @param [in] dir2 Direction of the end point. + * @param [in] parent The design diagram containing the connection. */ ComGraphicsConnection(QPointF const& p1, QVector2D const& dir1, QPointF const& p2, QVector2D const& dir2, DesignDiagram* parent); @@ -50,12 +50,12 @@ class ComGraphicsConnection : public ConnectionItem /*! * The constructor containing the connected COM interconnection. * - * @param [in] endpoint1 The start point of the connection. - * @param [in] endpoint2 The end point of the connection. - * @param [in] comInterconnection The connected COM interconnection. - * @param [in] route Route of the interconnection. - * @param [in] autoConnect If true, the end points are automatically connected. - * @param [in] parent The containing design diagram. + * @param [in] endpoint1 The start point of the connection. + * @param [in] endpoint2 The end point of the connection. + * @param [in] comInterconnection The connected COM interconnection. + * @param [in] route Route of the interconnection. + * @param [in] autoConnect If true, the end points are automatically connected. + * @param [in] parent The containing design diagram. */ ComGraphicsConnection(ConnectionEndpoint* endpoint1, ConnectionEndpoint* endpoint2, QSharedPointer comInterconnection, @@ -69,7 +69,7 @@ class ComGraphicsConnection : public ConnectionItem /*! * Get the type of the graphical COM connection. * - * @return The type of the COM connection item. + * @return The type of the COM connection item. */ int type() const { return Type; } diff --git a/editors/SystemDesign/HWMappingItem.h b/editors/SystemDesign/HWMappingItem.h index e66bf023b..01250a3d1 100644 --- a/editors/SystemDesign/HWMappingItem.h +++ b/editors/SystemDesign/HWMappingItem.h @@ -32,13 +32,13 @@ class HWMappingItem : public SystemComponentItem, public IGraphicsItemStack /*! * The constructor. * - * @param [in] libInterface The library interface. - * @param [in] component The contained component. - * @param [in] instanceName The instance name. - * @param [in] displayName The instance display name. - * @param [in] description The instance description. - * @param [in] uuid The instance id. - * @param [in] configurableElementValues The configurable element values. + * @param [in] libInterface The library interface. + * @param [in] component The contained component. + * @param [in] instanceName The instance name. + * @param [in] displayName The instance display name. + * @param [in] description The instance description. + * @param [in] uuid The instance id. + * @param [in] configurableElementValues The configurable element values. */ HWMappingItem(LibraryInterface* libInterface, QSharedPointer component, QSharedPointer instance); @@ -69,29 +69,29 @@ class HWMappingItem : public SystemComponentItem, public IGraphicsItemStack /*! * Adds an item to the system column. * - * @param [in] item The item to add. - * @param [in] load If true, the item is being loaded from a design. + * @param [in] item The item to add. + * @param [in] load If true, the item is being loaded from a design. */ void addItem(QGraphicsItem* item, bool load = false); /*! * Removes an item from the system column. * - * @param [in] item the item to remove. + * @param [in] item the item to remove. */ void removeItem(QGraphicsItem* item); /*! * Called when an item is moved within the column. * - * @param [in] item The item that has been moved. + * @param [in] item The item that has been moved. */ void onMoveItem(QGraphicsItem* item); /*! * Called when an item is released from being moved by mouse. * - * @param [in] item The item that has been released. + * @param [in] item The item that has been released. */ void onReleaseItem(QGraphicsItem* item); @@ -113,7 +113,7 @@ class HWMappingItem : public SystemComponentItem, public IGraphicsItemStack /*! * Returns true if the stack is allowed to contain the given item. * - * @param [in] item The item to test for. + * @param [in] item The item to test for. */ bool isItemAllowed(QGraphicsItem* item) const; diff --git a/editors/SystemDesign/SWComponentItem.h b/editors/SystemDesign/SWComponentItem.h index f958533dc..cb1f0dfa9 100644 --- a/editors/SystemDesign/SWComponentItem.h +++ b/editors/SystemDesign/SWComponentItem.h @@ -34,13 +34,13 @@ class SWComponentItem : public SystemComponentItem /*! * The constructor. * - * @param [in] libInterface Library interface. - * @param [in] component The instantiated component. - * @param [in] instanceName The instance name. - * @param [in] displayName The instance display name. - * @param [in] description The instance description. - * @param [in] uuid The instance id. - * @param [in] configurableElementValues The configurable element values. + * @param [in] libInterface Library interface. + * @param [in] component The instantiated component. + * @param [in] instanceName The instance name. + * @param [in] displayName The instance display name. + * @param [in] description The instance description. + * @param [in] uuid The instance id. + * @param [in] configurableElementValues The configurable element values. */ SWComponentItem(LibraryInterface* libInterface, QSharedPointer component, QSharedPointer instance); @@ -53,7 +53,7 @@ class SWComponentItem : public SystemComponentItem /*! * Sets the file set reference. * - * @param [in] fileSetName The name of the referenced file set in the top-level component. + * @param [in] fileSetName The name of the referenced file set in the top-level component. */ void setFileSetRef(QString const& fileSetName); @@ -87,7 +87,7 @@ class SWComponentItem : public SystemComponentItem /*! * Checks if the component instance is a draft. * - * @return True, if the instance is a draft, otherwise false. + * @return True, if the instance is a draft, otherwise false. */ bool isDraft() const; diff --git a/editors/SystemDesign/SWConnectionEndpoint.h b/editors/SystemDesign/SWConnectionEndpoint.h index 5c24321ef..c91c1541f 100644 --- a/editors/SystemDesign/SWConnectionEndpoint.h +++ b/editors/SystemDesign/SWConnectionEndpoint.h @@ -34,10 +34,10 @@ class SWConnectionEndpoint : public ConnectionEndpoint /*! * Constructor. * - * @param [in] component Component containing the end point. - * @param [in] name Name of the item. - * @param [in] parent The parent graphics item. - * @param [in] dir The initial direction for the endpoint. + * @param [in] component Component containing the end point. + * @param [in] name Name of the item. + * @param [in] parent The parent graphics item. + * @param [in] dir The initial direction for the endpoint. */ SWConnectionEndpoint(QSharedPointer component, QString const& name = QString(), QGraphicsItem* parent = 0, QVector2D const& dir = QVector2D(0.0f, -1.0f)); @@ -54,7 +54,7 @@ class SWConnectionEndpoint : public ConnectionEndpoint /*! * Sets the COM/API type. The type of the VLNV determines the type of the endpoint. * - * @param [in] type The VLNV of the COM/API definition. + * @param [in] type The VLNV of the COM/API definition. */ virtual void setTypeDefinition(VLNV const& type) = 0; @@ -76,7 +76,7 @@ class SWConnectionEndpoint : public ConnectionEndpoint /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks Does not take existing connections into account but simply * validates whether a connection between the endpoints would be valid @@ -118,14 +118,14 @@ class SWConnectionEndpoint : public ConnectionEndpoint /*! * Set the type for the end point. * - * @param [in] newType The new end point type. + * @param [in] newType The new end point type. */ void setType(ConnectionEndpoint::EndpointType newType); /*! * Get the name label. * - * @return The name label. + * @return The name label. */ GraphicsItemLabel* getNameLabel() const; diff --git a/editors/SystemDesign/SWInterfaceItem.h b/editors/SystemDesign/SWInterfaceItem.h index 1ac5fed2b..cffc2a24d 100644 --- a/editors/SystemDesign/SWInterfaceItem.h +++ b/editors/SystemDesign/SWInterfaceItem.h @@ -37,10 +37,10 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Constructor which creates a graphics item for an undefined interface. * - * @param [in] component The selected component. - * @param [in] name The name of the item. - * @param [in] interfaceGraphics Container for the interface graphics data. - * @param [in] parent Owner of this item. + * @param [in] component The selected component. + * @param [in] name The name of the item. + * @param [in] interfaceGraphics Container for the interface graphics data. + * @param [in] parent Owner of this item. */ SWInterfaceItem(QSharedPointer component, QString const& name, QSharedPointer interfaceGraphics, QGraphicsItem *parent); @@ -48,10 +48,10 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Constructor which creates a graphics item for an API interface. * - * @param [in] component The selected component. - * @param [in] apiIf The API interface. - * @param [in] interfaceGraphics Container for the interface graphics data. - * @param [in] parent Owner of this item. + * @param [in] component The selected component. + * @param [in] apiIf The API interface. + * @param [in] interfaceGraphics Container for the interface graphics data. + * @param [in] parent Owner of this item. */ SWInterfaceItem(QSharedPointer component, QSharedPointer apiIf, QSharedPointer interfaceGraphics, QGraphicsItem *parent = 0); @@ -59,10 +59,10 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Constructor which creates a graphics item for a COM interface. * - * @param [in] component The selected component. - * @param [in] comIf The COM interface. - * @param [in] interfaceGraphics Container for the interface graphics data. - * @param [in] parent Owner of this item. + * @param [in] component The selected component. + * @param [in] comIf The COM interface. + * @param [in] interfaceGraphics Container for the interface graphics data. + * @param [in] parent Owner of this item. */ SWInterfaceItem(QSharedPointer component, QSharedPointer comIf, QSharedPointer interfaceGraphics, QGraphicsItem *parent = 0); @@ -85,7 +85,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Defines the interface as an API interface. * - * @param [in] apiIf The API interface to set. + * @param [in] apiIf The API interface to set. */ void define(QSharedPointer apiIf); @@ -102,7 +102,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Sets the COM/API type. The type of the VLNV determines the type of the endpoint. * - * @param [in] type The VLNV of the COM/API definition. + * @param [in] type The VLNV of the COM/API definition. */ virtual void setTypeDefinition(VLNV const& type); @@ -114,7 +114,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Sets the draw direction of the endpoint. * - * @param [in] dir The draw direction to set. + * @param [in] dir The draw direction to set. * * @remarks The direction can be changed only if isDirectionFixed() returns false. */ @@ -144,7 +144,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Sets the name for the interface. * - * @param [in] name The name to set for the interface. + * @param [in] name The name to set for the interface. */ virtual void setName(QString const& name); @@ -156,16 +156,16 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Sets the description for the interface. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ virtual void setDescription(QString const& description); /*! * Called when a connection between this and another end point is done. * - * @param [in] other The other end point of the connection. + * @param [in] other The other end point of the connection. * - * @return False if there was an error in the connection. Otherwise true. + * @return False if there was an error in the connection. Otherwise true. */ virtual bool onConnect(ConnectionEndpoint const* other); @@ -177,7 +177,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks Does not take existing connections into account but simply * validates whether a connection between the endpoints would be valid @@ -219,7 +219,7 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Get the graphics data. * - * @return The container containing graphical data. + * @return The container containing graphical data. */ QSharedPointer getInterfaceGraphicsData() const; @@ -238,31 +238,31 @@ class SWInterfaceItem : public SWConnectionEndpoint /*! * Handles item changes. * - * @param [in] change The change. - * @param [in] value Value for change. + * @param [in] change The change. + * @param [in] value Value for change. * - * @return The item change. + * @return The item change. */ virtual QVariant itemChange(GraphicsItemChange change, QVariant const& value); /*! * Handles mouse press events. * - * @param [in] event The mouse press event. + * @param [in] event The mouse press event. */ virtual void mousePressEvent(QGraphicsSceneMouseEvent *event); /*! * Handles mouse move events. * - * @param [in] event The mouse move event. + * @param [in] event The mouse move event. */ virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event); /*! * Handles mouse release events. * - * @param [in] event The mouse release event. + * @param [in] event The mouse release event. */ virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event); diff --git a/editors/SystemDesign/SWPortItem.h b/editors/SystemDesign/SWPortItem.h index d769c293b..059f3610c 100644 --- a/editors/SystemDesign/SWPortItem.h +++ b/editors/SystemDesign/SWPortItem.h @@ -32,18 +32,18 @@ class SWPortItem : public SWConnectionEndpoint /*! * Constructor which creates a graphics item for an undefined interface. * - * @param [in] name Name of the item. - * @param [in] containingComponent Component containing the item. - * @param [in] parent The parent item. + * @param [in] name Name of the item. + * @param [in] containingComponent Component containing the item. + * @param [in] parent The parent item. */ SWPortItem(QString const& name, QSharedPointer containingComponent, QGraphicsItem *parent); /*! * Constructor which creates a graphics item for an API interface. * - * @param [in] apiIf The API interface. - * @param [in] containingComponent Component containing the item. - * @param [in] parent The parent item. + * @param [in] apiIf The API interface. + * @param [in] containingComponent Component containing the item. + * @param [in] parent The parent item. */ SWPortItem(QSharedPointer apiIf, QSharedPointer containingComponent = QSharedPointer(), QGraphicsItem *parent = 0); @@ -51,9 +51,9 @@ class SWPortItem : public SWConnectionEndpoint /*! * Constructor which creates a graphics item for a COM interface. * - * @param [in] comIf The COM interface. - * @param [in] containingComponent Component containing the item. - * @param [in] parent The parent item. + * @param [in] comIf The COM interface. + * @param [in] containingComponent Component containing the item. + * @param [in] parent The parent item. */ SWPortItem(QSharedPointer comIf, QSharedPointer containingComponent = QSharedPointer(), QGraphicsItem *parent = 0); @@ -76,14 +76,14 @@ class SWPortItem : public SWConnectionEndpoint /*! * Sets the selection highlight on/off. * - * @param [in] on If true, the selection highlight is turned on. Otherwise it is turned off. + * @param [in] on If true, the selection highlight is turned on. Otherwise it is turned off. */ virtual void setSelectionHighlight(bool on); /*! * Sets the COM/API type. The type of the VLNV determines the type of the endpoint. * - * @param [in] type The VLNV of the COM/API definition. + * @param [in] type The VLNV of the COM/API definition. */ virtual void setTypeDefinition(VLNV const& type); @@ -101,14 +101,14 @@ class SWPortItem : public SWConnectionEndpoint /*! * Attaches the endpoint to a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ virtual void addConnection(GraphicsConnection* connection); /*! * Unattaches the endpoint from a connection. * - * @param [in] connection The connection. + * @param [in] connection The connection. */ virtual void removeConnection(GraphicsConnection* connection); @@ -130,7 +130,7 @@ class SWPortItem : public SWConnectionEndpoint /*! * Sets the name for the port. * - * @param [in] name The name to set for the port. + * @param [in] name The name to set for the port. */ virtual void setName(QString const& name); @@ -142,16 +142,16 @@ class SWPortItem : public SWConnectionEndpoint /*! * Sets the description for the port. * - * @param [in] description The description to set. + * @param [in] description The description to set. */ virtual void setDescription(QString const& description); /*! * Called when a connection between this and another end point is done. * - * @param [in] other The other end point of the connection. + * @param [in] other The other end point of the connection. * - * @return False if there was an error in the connection. Otherwise true. + * @return False if there was an error in the connection. Otherwise true. */ virtual bool onConnect(ConnectionEndpoint const* other); @@ -163,7 +163,7 @@ class SWPortItem : public SWConnectionEndpoint /*! * Returns true if a connection is valid between the two endpoints. * - * @param [in] other The other endpoint. + * @param [in] other The other endpoint. * * @remarks Does not take existing connections into account but simply * validates whether a connection between the endpoints would be valid @@ -215,7 +215,7 @@ class SWPortItem : public SWConnectionEndpoint /*! * Shorten the name label to better fit the component. * - * @param [in] width The width of the shortened name. + * @param [in] width The width of the shortened name. */ void shortenNameLabel( qreal width ) final; @@ -234,29 +234,29 @@ class SWPortItem : public SWConnectionEndpoint /*! * Item changes. * - * @param [in] change The changed graphics item. - * @param [in] value The new value. + * @param [in] change The changed graphics item. + * @param [in] value The new value. */ virtual QVariant itemChange(GraphicsItemChange change, QVariant const& value); /*! * Handler for mouse press events. * - * @param [in] event The caught mouse press event. + * @param [in] event The caught mouse press event. */ virtual void mousePressEvent(QGraphicsSceneMouseEvent *event); /*! * Handler for mouse move events. * - * @param [in] event The mouse movement event. + * @param [in] event The mouse movement event. */ virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event); /*! * Handler for mouse release event. * - * @param [in] event The mouse release event. + * @param [in] event The mouse release event. */ virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event); diff --git a/editors/SystemDesign/SystemColumn.h b/editors/SystemDesign/SystemColumn.h index 1a9bcabaa..69edc6f98 100644 --- a/editors/SystemDesign/SystemColumn.h +++ b/editors/SystemDesign/SystemColumn.h @@ -30,8 +30,8 @@ class SystemColumn : public GraphicsColumn /*! * Constructor. * - * @param [in] name The column description. - * @param [in] layout The parent column layout. + * @param [in] name The column description. + * @param [in] layout The parent column layout. */ SystemColumn(QSharedPointer desc, GraphicsColumnLayout* layout); @@ -43,7 +43,7 @@ class SystemColumn : public GraphicsColumn /*! * Get the type of this column. * - * @return Number representing the column type. + * @return Number representing the column type. */ int type() const { return Type; } @@ -51,8 +51,8 @@ class SystemColumn : public GraphicsColumn /*! * Returns true if the given item is allowed to reside in the column based on the allowed items. * - * @param [in] item The item. - * @param [in] allowedItems The allowed items flags. + * @param [in] item The item. + * @param [in] allowedItems The allowed items flags. */ virtual bool isItemAllowed(QGraphicsItem* item, unsigned int allowedItems) const; @@ -64,7 +64,7 @@ class SystemColumn : public GraphicsColumn /*! * Creates an undo command for the column move. * - * @return The created undo command. + * @return The created undo command. */ virtual QSharedPointer createMoveUndoCommand(); diff --git a/editors/SystemDesign/SystemComponentItem.h b/editors/SystemDesign/SystemComponentItem.h index 34d2c55fc..296fee483 100644 --- a/editors/SystemDesign/SystemComponentItem.h +++ b/editors/SystemDesign/SystemComponentItem.h @@ -37,11 +37,11 @@ class SystemComponentItem : public ComponentItem /*! * Constructor. * - * @param [in] size The initial rectangle size. - * @param [in] libInterface The library interface. - * @param [in] instance The component instance. - * @param [in] component The component referenced by the component instance. - * @param [in] parent The parent graphics item. + * @param [in] size The initial rectangle size. + * @param [in] libInterface The library interface. + * @param [in] instance The component instance. + * @param [in] component The component referenced by the component instance. + * @param [in] parent The parent graphics item. */ SystemComponentItem(QRectF const& size, LibraryInterface* libInterface, QSharedPointer instance, @@ -60,7 +60,7 @@ class SystemComponentItem : public ComponentItem /*! * Sets the property values. * - * @param [in] values The property values. + * @param [in] values The property values. */ void setPropertyValues(QMap const& values); @@ -72,37 +72,37 @@ class SystemComponentItem : public ComponentItem /*! * Adds a new, empty port to the component. * - * @param [in] pos The position hint for the port. + * @param [in] pos The position hint for the port. * - * @return The newly created port. + * @return The newly created port. */ SWPortItem* addPort(QPointF const& pos); /*! * Adds an already created port to the component. * - * @param [in] port The port to add. Must not be used in any other component. + * @param [in] port The port to add. Must not be used in any other component. */ void addPort(SWPortItem* port); /*! * Removes the given port from the component. * - * @param [in] port The port to remove. + * @param [in] port The port to remove. */ void removePort(SWPortItem* port); /*! * Sets the flag whether the component has been imported or not. * - * @param [in] imported If true, the component is marked as imported. + * @param [in] imported If true, the component is marked as imported. */ void setImported(bool imported); /*! * Sets the name of the import source instance. * - * @param [in] nameRef The name of the import source instance. + * @param [in] nameRef The name of the import source instance. */ void setImportRef(QString const& nameRef); @@ -119,7 +119,7 @@ class SystemComponentItem : public ComponentItem /*! * Called when a port is being moved. * - * @param [in] port The port that is being moved. + * @param [in] port The port that is being moved. */ virtual void onMovePort(ConnectionEndpoint* port); @@ -132,7 +132,7 @@ class SystemComponentItem : public ComponentItem /*! * Sets the connection update disabled/enabled. * - * @param [in] disabled If true, the connection update is set disabled, otherwise it is enabled. + * @param [in] disabled If true, the connection update is set disabled, otherwise it is enabled. */ void setConnectionUpdateDisabled(bool disabled); @@ -144,19 +144,19 @@ class SystemComponentItem : public ComponentItem /*! * Retrieves the port with the given name and type (API/COM). * - * @param [in] name The name of the port. - * @param [in] type The endpoint type. + * @param [in] name The name of the port. + * @param [in] type The endpoint type. * - * @return The corresponding port item, or null if no match was found. + * @return The corresponding port item, or null if no match was found. */ SWPortItem* getSWPort(QString const& name, SWConnectionEndpoint::EndpointType type) const; /*! * Retrieves the port with properties similar to the selected end point. * - * @param [in] otherEndPoint The selected end point. + * @param [in] otherEndPoint The selected end point. * - * @return An SW port with similar properties to the selected port. + * @return An SW port with similar properties to the selected port. */ SWPortItem* getSWPortMatchingOtherEndPoint(ConnectionEndpoint* otherEndPoint) const; @@ -168,16 +168,16 @@ class SystemComponentItem : public ComponentItem /*! * Sets the API interface positions. * - * @param [in] positions The positions to set. - * @param [in] createMissing If true, the missing bus interfaces are created. + * @param [in] positions The positions to set. + * @param [in] createMissing If true, the missing bus interfaces are created. */ void setApiInterfacePositions(QMap const& positions, bool createMissing = false); /*! * Sets the COM interface positions. * - * @param [in] positions The positions to set. - * @param [in] createMissing If true, the missing bus interfaces are created. + * @param [in] positions The positions to set. + * @param [in] createMissing If true, the missing bus interfaces are created. */ void setComInterfacePositions(QMap const& positions, bool createMissing = false); diff --git a/editors/SystemDesign/SystemDesignDiagram.h b/editors/SystemDesign/SystemDesignDiagram.h index b6ecbc18e..a9bfa2ac3 100644 --- a/editors/SystemDesign/SystemDesignDiagram.h +++ b/editors/SystemDesign/SystemDesignDiagram.h @@ -159,9 +159,9 @@ class SystemDesignDiagram : public ComponentDesignDiagram /*! * Constructor. * - * @param [in] lh The library interface. - * @param [in] editProvider The edit provider. - * @param [in] parent The parent widget. + * @param [in] lh The library interface. + * @param [in] editProvider The edit provider. + * @param [in] parent The parent widget. */ SystemDesignDiagram(bool onlySW, LibraryInterface* lh, QSharedPointer editProvider, SystemDesignWidget* parent = 0); @@ -179,7 +179,7 @@ class SystemDesignDiagram : public ComponentDesignDiagram /*! * Adds a new column to the diagram. * - * @param [in] desc The column description. + * @param [in] desc The column description. */ void addColumn(QSharedPointer desc); @@ -205,8 +205,8 @@ public slots: /*! * Opens a design for a given component. * - * @param [in] component The component whose design to open. - * @param [in] viewName The name of the view to open. + * @param [in] component The component whose design to open. + * @param [in] viewName The name of the view to open. */ virtual void openDesignForComponent(ComponentItem* component, QString const& viewName); @@ -230,74 +230,74 @@ public slots: /*! * Checks if open component action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool openComponentActionEnabled() const; /*! * Check if the selected items are of a type used in the system design. * - * @return True, if the items are used in system design, false otherwise. + * @return True, if the items are used in system design, false otherwise. */ virtual bool selectedItemIsCorrectType() const; /*! * Checks if the given item is a hierarchical component. * - * @param [in] item The item to check. + * @param [in] item The item to check. * - * @return True, if item is a hierarchical component, otherwise false. + * @return True, if item is a hierarchical component, otherwise false. */ virtual bool isHierarchicalComponent(QGraphicsItem* item) const; /*! * Checks if copy action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool copyActionEnabled() const; /*! * Checks if paste action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool pasteActionEnabled() const; /*! * Opens the given component according to the active view of the component. * - * @param [in] comp The component to open. + * @param [in] comp The component to open. */ virtual void openComponentByActiveView(ComponentItem* comp); /*! * Gets the names of hierarchical views of a component. * - * @param [in] component The component whose hierarchical views to get. + * @param [in] component The component whose hierarchical views to get. * - * @return The names of the hierarchical views. + * @return The names of the hierarchical views. */ virtual QStringList hierarchicalViewsOf(ComponentItem* component) const; /*! * Gets the graphics item type of the components in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int componentType() const; /*! * Gets the graphics item type of the off page connectors in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int offpageConnectorType() const; /*! * Gets the graphics item type of the connections in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int connectionType() const; @@ -309,7 +309,7 @@ public slots: /*! * Called when an item has been selected in the diagram. * - * @param [in] newSelection The selected item. + * @param [in] newSelection The selected item. */ virtual void onSelected(QGraphicsItem* newSelection); @@ -321,17 +321,17 @@ public slots: /*! * Load interfaces from the component containing the design. * - * @param [in] design The selected design. + * @param [in] design The selected design. */ void loadInterfaces(QSharedPointer design); /*! * Get the interface graphics data. * - * @param [in] design Design containing the interface. - * @param [in] interfaceName The name of the interface. + * @param [in] design Design containing the interface. + * @param [in] interfaceName The name of the interface. * - * @return Graphics data of the interface. + * @return Graphics data of the interface. */ QSharedPointer findOrCreateInterfaceGraphicsData(QSharedPointer design, QString const& interfaceName); @@ -339,7 +339,7 @@ public slots: /*! * Add the interface item to the layout. * - * @param [in] item The selected interface item. + * @param [in] item The selected interface item. */ void addInterfaceItemToLayout(SWInterfaceItem* item); @@ -351,12 +351,12 @@ public slots: /*! * Find or create an endpoint item for the interface. * - * @param [in] endpointInterface The selected end point interface. - * @param [in] type The type of the selected end point. - * @param [in] connectionName Name of the connection containing the end point. - * @param [in] containingDesign The containing design. + * @param [in] endpointInterface The selected end point interface. + * @param [in] type The type of the selected end point. + * @param [in] connectionName Name of the connection containing the end point. + * @param [in] containingDesign The containing design. * - * @return The endpoint item corresponding to the selected interface. + * @return The endpoint item corresponding to the selected interface. */ ConnectionEndpoint* findOrCreateEndpointItem(QSharedPointer endpointInterface, SWConnectionEndpoint::EndpointType type, QString const& connectionName, @@ -365,31 +365,31 @@ public slots: /*! * Get the SW interface item. * - * @param [in] interfaceName The name of the SW interface item. + * @param [in] interfaceName The name of the SW interface item. * - * @return The SW interface item matching the selected interface name. + * @return The SW interface item matching the selected interface name. */ SWInterfaceItem* getSWInterfaceItem(QString const& interfaceName) const; /*! * Create a dummy interface. * - * @param [in] itemType Type of the interface in string format. - * @param [in] interfaceReference The name of the interface. + * @param [in] itemType Type of the interface in string format. + * @param [in] interfaceReference The name of the interface. * - * @return The created dummy interface. + * @return The created dummy interface. */ ConnectionEndpoint* createDummyInterface(QString const& itemType, QString const& interfaceReference); /*! * Find or create a SW port item. * - * @param [in] containingItem The item containing the port item. - * @param [in] interfaceReference The name of the port. - * @param [in] type The type of the port. - * @param [in] containingDesign The design containing the port item. + * @param [in] containingItem The item containing the port item. + * @param [in] interfaceReference The name of the port. + * @param [in] type The type of the port. + * @param [in] containingDesign The design containing the port item. * - * @return The found SW port item. + * @return The found SW port item. */ ConnectionEndpoint* findOrCreateSWPortItem(SystemComponentItem* containingItem, QString const& interfaceReference, SWConnectionEndpoint::EndpointType type, @@ -403,9 +403,9 @@ public slots: /*! * Get the route used by the interconnection. * - * @param [in] interconnectionName Name of the selected interconnection. + * @param [in] interconnectionName Name of the selected interconnection. * - * @return The route used by the selected interconnection. + * @return The route used by the selected interconnection. */ QSharedPointer getInterconnectionRoute(QString const& interconnectionName) const; @@ -422,19 +422,19 @@ public slots: /*! * Returns the component with the given name (either HW or SW). * - * @param [in] instanceName The name of the instance to search for. + * @param [in] instanceName The name of the instance to search for. * - * @return The corresponding component, or null if not found. + * @return The corresponding component, or null if not found. */ SystemComponentItem* getComponent(QString const& instanceName); /*! * Creates a missing port to the given component item. * - * @param [in] portName The name of the port to create. - * @param [in] type The port endpoint type. - * @param [in] component The parent component. - * @param [in] design The design containing related information. + * @param [in] portName The name of the port to create. + * @param [in] type The port endpoint type. + * @param [in] component The parent component. + * @param [in] design The design containing related information. */ SWPortItem* createMissingPort(QString const& portName, ConnectionEndpoint::EndpointType type, SystemComponentItem* component, QSharedPointer design); @@ -442,67 +442,67 @@ public slots: /*! * Imports SW instances and related connections from the given design to the diagram. * - * @param [in] design The design to import. - * @param [in] stack The stack where to place the imported elements. - * @param [in] guidePos Position used as a guide where to place the imported instances. + * @param [in] design The design to import. + * @param [in] stack The stack where to place the imported elements. + * @param [in] guidePos Position used as a guide where to place the imported instances. */ void importDesign(QSharedPointer design, IGraphicsItemStack* stack, QPointF const& guidePos); /*! * Creates a connection between the given two endpoints. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending connection end point. - * @param [in] isOffPage Doesn't do anything in SystemDesignDiagram and is present because of inheritance + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending connection end point. + * @param [in] isOffPage Doesn't do anything in SystemDesignDiagram and is present because of inheritance * - * @return The created connection. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint, bool isOffPage = false); /*! * Create an interface for an end point. * - * @param [in] connectionPoint The selected connection end point. + * @param [in] connectionPoint The selected connection end point. * - * @return Interface created for the selected end point. + * @return Interface created for the selected end point. */ QSharedPointer createEndpointInterface(ConnectionEndpoint* connectionPoint); /*! * Creates a connection between the given endpoint and a coordinate point. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending coordinate point. + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending coordinate point. * - * @return The created connection. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, QPointF const& endPoint); /*! * Creates an add command for a given connection. * - * @param [in] connection The connection to create a command for. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. + * @param [in] connection The connection to create a command for. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. * - * @return The created add command. + * @return The created add command. */ virtual QUndoCommand* createAddCommandForConnection(GraphicsConnection* connection, QUndoCommand* parentCommand = nullptr); /*! * Adds a new top-level interface to the given diagram column. * - * @param [in] column The column where to add the interface. - * @param [in] pos The interface position. - * @param [in] isDraft Determines if Bus Interface is draft or not. + * @param [in] column The column where to add the interface. + * @param [in] pos The interface position. + * @param [in] isDraft Determines if Bus Interface is draft or not. */ virtual void addTopLevelInterface(GraphicsColumn* column, QPointF const& pos, bool isDraft = false); /*! * Create a unique name for the interface. * - * @param [in] baseName The name from which to create the unique name. + * @param [in] baseName The name from which to create the unique name. * - * @return A unique name for the interface. + * @return A unique name for the interface. */ QString createDraftInterfaceName(QString const& baseName) const; @@ -510,41 +510,41 @@ public slots: * Handler for draft tool clicks. Creates a draft component instance or a draft interface according to the * clicked position. * - * @param [in] clickedPosition The position to create the draft item to. + * @param [in] clickedPosition The position to create the draft item to. */ virtual void draftAt(QPointF const& clickedPosition); /*! * Performs the replacing of destination component with source component. * - * @param [in] destComp The component to replace. - * @param [in] sourceComp The replacing component. + * @param [in] destComp The component to replace. + * @param [in] sourceComp The replacing component. */ virtual void replace(ComponentItem* destComp, ComponentItem* sourceComp); /*! * Copies SW component instances in a format which can be saved to clipboard. * - * @param [in] items The component instance items to copy. - * @param [out] collection The resulted collection of component instance copy data. + * @param [in] items The component instance items to copy. + * @param [out] collection The resulted collection of component instance copy data. */ void copySWInstances(QList const& items, ComponentCollectionCopyData &collection); /*! * Copies interfaces in a format which can be saved to clipboard. * - * @param [in] items The interface items to copy. - * @param [out] collection The resulted collection of interface copy data. + * @param [in] items The interface items to copy. + * @param [out] collection The resulted collection of interface copy data. */ void copyInterfaces(QList const& items, PortCollectionCopyData& collection); /*! * Pastes component instances from a copy data collection. * - * @param [in] collection The collection of component instance copy data. - * @param [in] column The item stack where to place the instances. - * @param [in] cmd The parent undo command for the paste undo commands. - * @param [in] userCursorPos If true, the instances are placed close to the cursor position. + * @param [in] collection The collection of component instance copy data. + * @param [in] column The item stack where to place the instances. + * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] userCursorPos If true, the instances are placed close to the cursor position. * Otherwise the original positions are used. */ void pasteSWInstances(ComponentCollectionCopyData const collection, @@ -553,19 +553,19 @@ public slots: /*! * Pastes interfaces from a copy data collection. * - * @param [in] collection The collection of interface copy data. - * @param [in] targetComp The target component. If null, the interfaces are pasted to the top level component. - * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] collection The collection of interface copy data. + * @param [in] targetComp The target component. If null, the interfaces are pasted to the top level component. + * @param [in] cmd The parent undo command for the paste undo commands. */ void pasteInterfaces(PortCollectionCopyData const& collection, SWComponentItem* targetComp, QUndoCommand* cmd); /*! * Pastes interfaces from a copy data collection to a top-level item stack. * - * @param [in] collection The collection of interface copy data. - * @param [in] stack The target item tack. - * @param [in] cmd The parent undo command for the paste undo commands. - * @param [in] userCursorPos If true, the interfaces are placed close to the cursor position. + * @param [in] collection The collection of interface copy data. + * @param [in] stack The target item tack. + * @param [in] cmd The parent undo command for the paste undo commands. + * @param [in] userCursorPos If true, the interfaces are placed close to the cursor position. * Otherwise the original positions are used. */ void pasteInterfaces(PortCollectionCopyData const& collection, IGraphicsItemStack* stack, QUndoCommand* cmd, @@ -574,16 +574,16 @@ public slots: /*! * Pastes columns from a copy data collection. * - * @param [in] collection The collection of column copy data. + * @param [in] collection The collection of column copy data. */ void pasteColumns(ColumnCollectionCopyData const collection); /*! * Create a unique name for a column with the given base name. * - * @param [in] baseName The base name of the column. + * @param [in] baseName The base name of the column. * - * @return A unique column name. + * @return A unique column name. */ QString createColumnName(QString const& baseName); @@ -602,34 +602,34 @@ public slots: /*! * Get the names of the contained component instances. * - * @return A list of the contained component instance names. + * @return A list of the contained component instance names. */ virtual QStringList getUsedInstanceNames() const; /*! * Create auto connection dialog. * - * @param [in] firstItem The first item for the auto connector. + * @param [in] firstItem The first item for the auto connector. * - * @return The auto connector dialog. + * @return The auto connector dialog. */ virtual ComponentItemAutoConnector* createAutoConnector(ComponentItem* firstItem) const; /*! * Get the connection end point for the selected auto connector item. * - * @param [in] connectorItem The selected auto connector item. - * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. + * @param [in] connectorItem The selected auto connector item. + * @param [in] parentUndoCommand Optional undocommand to set as parent for created child commands. * - * @return The end point item for the selected auto connector item. + * @return The end point item for the selected auto connector item. */ virtual ConnectionEndpoint* getEndPointForItem(AutoConnectorItem* connectorItem, QUndoCommand* parentCommand = nullptr); /*! * Create connection between the selected end points. * - * @param [in] startPoint Start point for the connection. - * @param [in] endPoint End point for the connection. + * @param [in] startPoint Start point for the connection. + * @param [in] endPoint End point for the connection. */ virtual void createConnectionBetweenEndPoints(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint); diff --git a/editors/SystemDesign/SystemDesignWidget.h b/editors/SystemDesign/SystemDesignWidget.h index 5c184d4d6..b9c100bdd 100644 --- a/editors/SystemDesign/SystemDesignWidget.h +++ b/editors/SystemDesign/SystemDesignWidget.h @@ -37,7 +37,7 @@ class SystemDesignWidget : public DesignWidget /*! * Sets the system identified with the given VLNV as the currently edited one. * - * @return False if there were errors opening the system; otherwise true. + * @return False if there were errors opening the system; otherwise true. */ bool setDesign(VLNV const& vlnv, QString const& viewName); @@ -54,7 +54,7 @@ class SystemDesignWidget : public DesignWidget /*! * Get the vlnv that can be used to identify the document. * - * @return The VLNV that identifies the document. + * @return The VLNV that identifies the document. */ virtual VLNV getIdentifyingVLNV() const; @@ -82,57 +82,57 @@ public slots: /*! * Delete the selected system columns items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedSystemColumns(QList selectedItems); /*! * Delete the selected SW component items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedSWComponentItems(QList selectedItems); /*! * Delete the selected SW port items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedSWPortItems(QList selectedItems); /*! * Delete the selected SW interface items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedSWInterfaceItems(QList selectedItems); /*! * Delete the selected COM connection items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedComConnectionItems(QList selectedItems); /*! * Delete the selected API connection items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedApiConnectionItems(QList selectedItems); /*! * Delete the selected graphics connection items. * - * @param [in] selectedItems The selected graphics items. + * @param [in] selectedItems The selected graphics items. */ void deleteSelectedGraphicsConnectionItems(QList selectedItems); /*! * Delete the connected end point. * - * @param [in] endPoint The selected end point. - * @param [in] parentCommand The parent command. + * @param [in] endPoint The selected end point. + * @param [in] parentCommand The parent command. */ void deleteConnectedEndPoint(SWConnectionEndpoint* endPoint, QSharedPointer parentCommand); diff --git a/editors/SystemDesign/SystemDetailsEditor/ExportSWDialog.h b/editors/SystemDesign/SystemDetailsEditor/ExportSWDialog.h index 5ba090b44..5510ae69a 100644 --- a/editors/SystemDesign/SystemDetailsEditor/ExportSWDialog.h +++ b/editors/SystemDesign/SystemDetailsEditor/ExportSWDialog.h @@ -33,8 +33,8 @@ class ExportSWDialog : public QDialog /*! * Constructor. * - * @param [in] lh The library interface. - * @param [in] parent The parent widget. + * @param [in] lh The library interface. + * @param [in] parent The parent widget. */ ExportSWDialog(LibraryInterface* lh, QWidget* parent); diff --git a/editors/SystemDesign/SystemDetailsEditor/SwitchHWDialog.h b/editors/SystemDesign/SystemDetailsEditor/SwitchHWDialog.h index b798e244e..59eb27efa 100644 --- a/editors/SystemDesign/SystemDetailsEditor/SwitchHWDialog.h +++ b/editors/SystemDesign/SystemDetailsEditor/SwitchHWDialog.h @@ -37,10 +37,10 @@ class SwitchHWDialog : public QDialog /*! * Constructor. * - * @param [in] component The new HW component to which to switch. - * @param [in] viewName The initial name suggestion for the system view. - * @param [in] lh The library interface. - * @param [in] parent The parent widget. + * @param [in] component The new HW component to which to switch. + * @param [in] viewName The initial name suggestion for the system view. + * @param [in] lh The library interface. + * @param [in] parent The parent widget. */ SwitchHWDialog(QSharedPointer component, QString const& viewName, LibraryInterface* lh, QWidget* parent); @@ -53,7 +53,7 @@ class SwitchHWDialog : public QDialog /*! * Sets the system view name suggestions. * - * @param [in] suggestions The list of suggestions. + * @param [in] suggestions The list of suggestions. */ void setViewNameSuggestions(QStringList const& suggestions); @@ -96,7 +96,7 @@ private slots: /*! * Called when the action selection has changed. * - * @param [in] button The action button. + * @param [in] button The action button. */ void actionChanged(QAbstractButton* button); diff --git a/editors/SystemDesign/SystemDetailsEditor/SystemDetailsEditor.h b/editors/SystemDesign/SystemDetailsEditor/SystemDetailsEditor.h index 202683252..288609f43 100644 --- a/editors/SystemDesign/SystemDetailsEditor/SystemDetailsEditor.h +++ b/editors/SystemDesign/SystemDetailsEditor/SystemDetailsEditor.h @@ -36,8 +36,8 @@ class SystemDetailsEditor : public QWidget /*! * Constructor. * - * @param [in] handler The library interface. - * @param [in] parent The parent widget. + * @param [in] handler The library interface. + * @param [in] parent The parent widget. */ SystemDetailsEditor(LibraryInterface* handler, QWidget *parent); @@ -49,7 +49,7 @@ class SystemDetailsEditor : public QWidget /*! * Set the system to be displayed. * - * @param [in] designWidget The system design widget containing the opened system. + * @param [in] designWidget The system design widget containing the opened system. */ void setSystem(DesignWidget* designWidget); diff --git a/editors/SystemDesign/UndoCommands/ApiConnectionAddCommand.h b/editors/SystemDesign/UndoCommands/ApiConnectionAddCommand.h index 27c0ca4f4..e8625b8b8 100644 --- a/editors/SystemDesign/UndoCommands/ApiConnectionAddCommand.h +++ b/editors/SystemDesign/UndoCommands/ApiConnectionAddCommand.h @@ -32,10 +32,10 @@ class ApiConnectionAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] scene The scene. - * @param [in] conn The connection to add. - * @param [in] containingDesign The design containing the API interconnection. - * @param [in] parent The parent command. + * @param [in] scene The scene. + * @param [in] conn The connection to add. + * @param [in] containingDesign The design containing the API interconnection. + * @param [in] parent The parent command. */ ApiConnectionAddCommand(QGraphicsScene* scene, ApiGraphicsConnection* connection, QSharedPointer containingDesign, QUndoCommand* parent = 0); @@ -63,7 +63,7 @@ class ApiConnectionAddCommand : public QUndoCommand /*! * Change the port item status from COM interface to API interface. * - * @param [in] endPoint The selected port item. + * @param [in] endPoint The selected port item. */ void changePortItemFromComToApi(ConnectionEndpoint* endPoint); diff --git a/editors/SystemDesign/UndoCommands/ApiConnectionDeleteCommand.h b/editors/SystemDesign/UndoCommands/ApiConnectionDeleteCommand.h index 7173b9dd9..003ef19ab 100644 --- a/editors/SystemDesign/UndoCommands/ApiConnectionDeleteCommand.h +++ b/editors/SystemDesign/UndoCommands/ApiConnectionDeleteCommand.h @@ -30,9 +30,9 @@ class ApiConnectionDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] connection The connection to delete. - * @param [in] containingDesign The design containing the connection. - * @param [in] parent The parent undo command. + * @param [in] connection The connection to delete. + * @param [in] containingDesign The design containing the connection. + * @param [in] parent The parent undo command. */ ApiConnectionDeleteCommand(ApiGraphicsConnection* connection, QSharedPointer containingDesign, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/ApiConnectionExchangeCommand.h b/editors/SystemDesign/UndoCommands/ApiConnectionExchangeCommand.h index 42c62959f..336602c92 100644 --- a/editors/SystemDesign/UndoCommands/ApiConnectionExchangeCommand.h +++ b/editors/SystemDesign/UndoCommands/ApiConnectionExchangeCommand.h @@ -30,10 +30,10 @@ class ApiConnectionExchangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] connection The selected API graphics connection. - * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. - * @param [in] newEndpoint The new endpoint to which to connect the connection. - * @param [in] parent The parent command. + * @param [in] connection The selected API graphics connection. + * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. + * @param [in] newEndpoint The new endpoint to which to connect the connection. + * @param [in] parent The parent command. */ ApiConnectionExchangeCommand(ApiGraphicsConnection* connection, ConnectionEndpoint* oldEndpoint, ConnectionEndpoint* newEndpoint, QUndoCommand* parent = 0); @@ -67,9 +67,9 @@ class ApiConnectionExchangeCommand : public QUndoCommand /*! * Create an interface from the selected connection end point. * - * @param [in] endPoint The selected connection end point. + * @param [in] endPoint The selected connection end point. * - * @return The created interface. + * @return The created interface. */ QSharedPointer createConnectionInterface(ConnectionEndpoint* endPoint); diff --git a/editors/SystemDesign/UndoCommands/ComConnectionAddCommand.h b/editors/SystemDesign/UndoCommands/ComConnectionAddCommand.h index 5c11e3f4d..13337e738 100644 --- a/editors/SystemDesign/UndoCommands/ComConnectionAddCommand.h +++ b/editors/SystemDesign/UndoCommands/ComConnectionAddCommand.h @@ -32,10 +32,10 @@ class ComConnectionAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] scene The scene. - * @param [in] connection The connection to add. - * @param [in] containingDesign The design containing the connection. - * @param [in] parent The parent command. + * @param [in] scene The scene. + * @param [in] connection The connection to add. + * @param [in] containingDesign The design containing the connection. + * @param [in] parent The parent command. */ ComConnectionAddCommand(QGraphicsScene* scene, ComGraphicsConnection* connection, QSharedPointer containingDesign, QUndoCommand* parent = 0); @@ -63,7 +63,7 @@ class ComConnectionAddCommand : public QUndoCommand /*! * Change the port item status from API interface to COM interface. * - * @param [in] endPoint The selected port item. + * @param [in] endPoint The selected port item. */ void changePortItemFromApiToCom(ConnectionEndpoint* endPoint); diff --git a/editors/SystemDesign/UndoCommands/ComConnectionDeleteCommand.h b/editors/SystemDesign/UndoCommands/ComConnectionDeleteCommand.h index e0676b2ca..e624109ba 100644 --- a/editors/SystemDesign/UndoCommands/ComConnectionDeleteCommand.h +++ b/editors/SystemDesign/UndoCommands/ComConnectionDeleteCommand.h @@ -30,9 +30,9 @@ class ComConnectionDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] connection The connection to delete. - * @param [in] containingDesign The design containing the connection. - * @param [in] parent The parent undo command. + * @param [in] connection The connection to delete. + * @param [in] containingDesign The design containing the connection. + * @param [in] parent The parent undo command. */ ComConnectionDeleteCommand(ComGraphicsConnection* connection, QSharedPointer containingDesign, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/ComConnectionExchangeCommand.h b/editors/SystemDesign/UndoCommands/ComConnectionExchangeCommand.h index 653d158f8..e387ed650 100644 --- a/editors/SystemDesign/UndoCommands/ComConnectionExchangeCommand.h +++ b/editors/SystemDesign/UndoCommands/ComConnectionExchangeCommand.h @@ -30,10 +30,10 @@ class ComConnectionExchangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] connection The selected COM graphics connection. - * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. - * @param [in] newEndpoint The new endpoint to which to connect the connection. - * @param [in] parent The parent command. + * @param [in] connection The selected COM graphics connection. + * @param [in] oldEndpoint The old endpoint from which to disconnect the connection. + * @param [in] newEndpoint The new endpoint to which to connect the connection. + * @param [in] parent The parent command. */ ComConnectionExchangeCommand(ComGraphicsConnection* connection, ConnectionEndpoint* oldEndpoint, ConnectionEndpoint* newEndpoint, QUndoCommand* parent = 0); @@ -66,9 +66,9 @@ class ComConnectionExchangeCommand : public QUndoCommand /*! * Create an interface from the selected connection end point. * - * @param [in] endPoint The selected connection end point. + * @param [in] endPoint The selected connection end point. * - * @return The created interface. + * @return The created interface. */ QSharedPointer createConnectionInterface(ConnectionEndpoint* endPoint); diff --git a/editors/SystemDesign/UndoCommands/ReplaceSystemComponentCommand.h b/editors/SystemDesign/UndoCommands/ReplaceSystemComponentCommand.h index 062edfd02..f9f7fd8ea 100644 --- a/editors/SystemDesign/UndoCommands/ReplaceSystemComponentCommand.h +++ b/editors/SystemDesign/UndoCommands/ReplaceSystemComponentCommand.h @@ -37,13 +37,13 @@ class ReplaceSystemComponentCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] oldComp The old system component item. - * @param [in] newComp The new system component item. - * @param [in] existing Flag for existence checking. - * @param [in] keepOld Flag for keeping the old item. - * @param [in] containingDesign The design containing the system component. - * @param [in] diagram Diagram containing the scene of the component items. - * @param [in] parent Owner of the object. + * @param [in] oldComp The old system component item. + * @param [in] newComp The new system component item. + * @param [in] existing Flag for existence checking. + * @param [in] keepOld Flag for keeping the old item. + * @param [in] containingDesign The design containing the system component. + * @param [in] diagram Diagram containing the scene of the component items. + * @param [in] parent Owner of the object. */ ReplaceSystemComponentCommand(SystemComponentItem* oldComp, SystemComponentItem* newComp, bool existing, bool keepOld, QSharedPointer containingDesign, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -78,9 +78,9 @@ class ReplaceSystemComponentCommand : public QObject, public QUndoCommand /*! * Change the connections of the replaced component item. * - * @param [in] oldComponent The component item being changed. - * @param [in] newComponent The new component item. - * @param [in] design The design containing the connections. + * @param [in] oldComponent The component item being changed. + * @param [in] newComponent The new component item. + * @param [in] design The design containing the connections. */ void changeConnections(SystemComponentItem* oldComponent, SystemComponentItem* newComponent, QSharedPointer design); @@ -88,9 +88,9 @@ class ReplaceSystemComponentCommand : public QObject, public QUndoCommand /*! * Create exchange command for the replaced connection. * - * @param [in] connection The selected graphics connection. - * @param [in] oldEndpoint The old end point. - * @param [in] newEndpoint The new end point. + * @param [in] connection The selected graphics connection. + * @param [in] oldEndpoint The old end point. + * @param [in] newEndpoint The new end point. */ void createConnectionExchangeCommand(GraphicsConnection* connection, ConnectionEndpoint* oldEndpoint, ConnectionEndpoint* newEndpoint); @@ -98,8 +98,8 @@ class ReplaceSystemComponentCommand : public QObject, public QUndoCommand /*! * Create delete commands for a selected connection. * - * @param [in] connection The selected connection. - * @param [in] design Design containing the selected connection. + * @param [in] connection The selected connection. + * @param [in] design Design containing the selected connection. */ void createConnectionDeleteCommand(GraphicsConnection* connection, QSharedPointer design); diff --git a/editors/SystemDesign/UndoCommands/SWInterfaceAddCommand.h b/editors/SystemDesign/UndoCommands/SWInterfaceAddCommand.h index 8fcd73a08..419b9ed97 100644 --- a/editors/SystemDesign/UndoCommands/SWInterfaceAddCommand.h +++ b/editors/SystemDesign/UndoCommands/SWInterfaceAddCommand.h @@ -34,10 +34,10 @@ class SWInterfaceAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] stack The graphics item stack to which to paste the item. - * @param [in] item The SW interface item to paste. - * @param [in] containingDesign The design containing the interface. - * @param [in] parent The parent command. + * @param [in] stack The graphics item stack to which to paste the item. + * @param [in] item The SW interface item to paste. + * @param [in] containingDesign The design containing the interface. + * @param [in] parent The parent command. */ SWInterfaceAddCommand(IGraphicsItemStack* stack, SWInterfaceItem* item, QSharedPointer containingDesign, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SWInterfaceDeleteCommand.h b/editors/SystemDesign/UndoCommands/SWInterfaceDeleteCommand.h index 72a1128fd..824c98bb9 100644 --- a/editors/SystemDesign/UndoCommands/SWInterfaceDeleteCommand.h +++ b/editors/SystemDesign/UndoCommands/SWInterfaceDeleteCommand.h @@ -34,10 +34,10 @@ class SWInterfaceDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] interface The interface to delete. - * @param [in] containingDesign Design containing the SW interface. - * @param [in] component The component containing the design. - * @param [in] parent The owner of this command. + * @param [in] interface The interface to delete. + * @param [in] containingDesign Design containing the SW interface. + * @param [in] component The component containing the design. + * @param [in] parent The owner of this command. */ SWInterfaceDeleteCommand(SWInterfaceItem* interface, QSharedPointer containingDesign, QSharedPointer component, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SWInterfaceMoveCommand.h b/editors/SystemDesign/UndoCommands/SWInterfaceMoveCommand.h index c73cd74ee..40105dd88 100644 --- a/editors/SystemDesign/UndoCommands/SWInterfaceMoveCommand.h +++ b/editors/SystemDesign/UndoCommands/SWInterfaceMoveCommand.h @@ -31,11 +31,11 @@ class SWInterfaceMoveCommand : public ItemMoveCommand /*! * Constructor. * - * @param [in] item The item to move. - * @param [in] oldPos The item's old position. - * @param [in] oldStack The item's old stack. - * @param [in] diagram Diagram containing the scene of the interface. - * @param [in] parent The parent command. + * @param [in] item The item to move. + * @param [in] oldPos The item's old position. + * @param [in] oldStack The item's old stack. + * @param [in] diagram Diagram containing the scene of the interface. + * @param [in] parent The parent command. */ SWInterfaceMoveCommand(SWInterfaceItem* item, QPointF const& oldPos, IGraphicsItemStack* oldStack, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -43,13 +43,13 @@ class SWInterfaceMoveCommand : public ItemMoveCommand /*! * Constructor. * - * @param [in] item The item to move. - * @param [in] oldPos The item's old position. - * @param [in] oldStack The item's old stack. - * @param [in] oldPos The item's new position. - * @param [in] oldStack The item's new stack. - * @param [in] diagram Diagram containing the scene of the interface. - * @param [in] parent The parent command. + * @param [in] item The item to move. + * @param [in] oldPos The item's old position. + * @param [in] oldStack The item's old stack. + * @param [in] oldPos The item's new position. + * @param [in] oldStack The item's new stack. + * @param [in] diagram Diagram containing the scene of the interface. + * @param [in] parent The parent command. */ SWInterfaceMoveCommand(SWInterfaceItem* item, QPointF const& oldPos, IGraphicsItemStack* oldStack, QPointF const& newPos, IGraphicsItemStack* newStack, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SWPortDeleteCommand.h b/editors/SystemDesign/UndoCommands/SWPortDeleteCommand.h index 6692b510c..8892e90f5 100644 --- a/editors/SystemDesign/UndoCommands/SWPortDeleteCommand.h +++ b/editors/SystemDesign/UndoCommands/SWPortDeleteCommand.h @@ -30,9 +30,9 @@ class SWPortDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] port The port to delete. - * @param [in] containingDesign Design containing the SW port. - * @param [in] parent The owner of this command. + * @param [in] port The port to delete. + * @param [in] containingDesign Design containing the SW port. + * @param [in] parent The owner of this command. */ SWPortDeleteCommand(SWPortItem* port, QSharedPointer containingDesign, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SystemAddCommands.h b/editors/SystemDesign/UndoCommands/SystemAddCommands.h index 96cd15c47..c53d69d41 100644 --- a/editors/SystemDesign/UndoCommands/SystemAddCommands.h +++ b/editors/SystemDesign/UndoCommands/SystemAddCommands.h @@ -32,10 +32,10 @@ class SWPortAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component to which to add a port. - * @param [in] pos The position where to add the port. - * @param [in] diagram Diagram containing the scene of the component. - * @param [in] parent The parent command. + * @param [in] component The component to which to add a port. + * @param [in] pos The position where to add the port. + * @param [in] diagram Diagram containing the scene of the component. + * @param [in] parent The parent command. */ SWPortAddCommand(SystemComponentItem* component, QPointF const& pos, DesignDiagram* diagram, QUndoCommand* parent = 0); @@ -43,10 +43,10 @@ class SWPortAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component The component to which to add a port. - * @param [in] port The port to add. - * @param [in] diagram Diagram containing the scene of the component. - * @param [in] parent The parent command. + * @param [in] component The component to which to add a port. + * @param [in] port The port to add. + * @param [in] diagram Diagram containing the scene of the component. + * @param [in] parent The parent command. */ SWPortAddCommand(SystemComponentItem* component, SWPortItem* port, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SystemChangeCommands.h b/editors/SystemDesign/UndoCommands/SystemChangeCommands.h index 3c591acd6..c81989e47 100644 --- a/editors/SystemDesign/UndoCommands/SystemChangeCommands.h +++ b/editors/SystemDesign/UndoCommands/SystemChangeCommands.h @@ -33,9 +33,9 @@ class TypeDefinitionChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] endpoint The SW connection end point. - * @param [in] oldBusType The endpoint's old API/COM type. - * @param [in] parent The parent command. + * @param [in] endpoint The SW connection end point. + * @param [in] oldBusType The endpoint's old API/COM type. + * @param [in] parent The parent command. */ TypeDefinitionChangeCommand(SWConnectionEndpoint* endpoint, VLNV const& oldType, QUndoCommand* parent = 0); @@ -83,9 +83,9 @@ class PropertyValuesChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component Pointer to the component instance that is being edited. - * @param [in] newConfElements The new property values for the instance. - * @param [in] parent Pointer to the owner of this command. + * @param [in] component Pointer to the component instance that is being edited. + * @param [in] newConfElements The new property values for the instance. + * @param [in] parent Pointer to the owner of this command. */ PropertyValuesChangeCommand(SystemComponentItem* component, QMap const& newPropertyValues, QUndoCommand* parent = 0); @@ -134,9 +134,9 @@ class FileSetRefChangeCommand : public QUndoCommand /*! * Constructor. * - * @param [in] component Pointer to the component instance that is being edited. - * @param [in] newConfElements The new file set reference for the instance. - * @param [in] parent Pointer to the owner of this command. + * @param [in] component Pointer to the component instance that is being edited. + * @param [in] newConfElements The new file set reference for the instance. + * @param [in] parent Pointer to the owner of this command. */ FileSetRefChangeCommand(SWComponentItem* component, QString const& newFileSetRef, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SystemComponentAddCommand.h b/editors/SystemDesign/UndoCommands/SystemComponentAddCommand.h index 6c17b95ac..d6902a72b 100644 --- a/editors/SystemDesign/UndoCommands/SystemComponentAddCommand.h +++ b/editors/SystemDesign/UndoCommands/SystemComponentAddCommand.h @@ -34,10 +34,10 @@ class SystemComponentAddCommand: public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] stack The graphics item stack to which to add the item. - * @param [in] item The graphics item to add. - * @param [in] diagram Diagram containing the scene of the item. - * @param [in] parent The parent command. + * @param [in] stack The graphics item stack to which to add the item. + * @param [in] item The graphics item to add. + * @param [in] diagram Diagram containing the scene of the item. + * @param [in] parent The parent command. */ SystemComponentAddCommand(IGraphicsItemStack* stack, QGraphicsItem* item, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/SystemDesign/UndoCommands/SystemComponentDeleteCommand.h b/editors/SystemDesign/UndoCommands/SystemComponentDeleteCommand.h index ecfcef7db..4bfdfc6a6 100644 --- a/editors/SystemDesign/UndoCommands/SystemComponentDeleteCommand.h +++ b/editors/SystemDesign/UndoCommands/SystemComponentDeleteCommand.h @@ -34,9 +34,9 @@ class SystemComponentDeleteCommand : public QObject, public QUndoCommand /*! * The constructor. * - * @param [in] item The component item to delete. - * @param [in] containingDesign The design containing the system component item. - * @param [in] parent The owner of this command. + * @param [in] item The component item to delete. + * @param [in] containingDesign The design containing the system component item. + * @param [in] parent The owner of this command. */ SystemComponentDeleteCommand(ComponentItem* item, QSharedPointer containingDesign, QUndoCommand* parent = 0); @@ -71,7 +71,7 @@ class SystemComponentDeleteCommand : public QObject, public QUndoCommand /*! * Add delete command for the contained interconnection. * - * @param [in] connection The selected connection. + * @param [in] connection The selected connection. */ void addConnectionDeleteCommand(GraphicsConnection* connection); diff --git a/editors/SystemDesign/UndoCommands/SystemDeleteCommands.h b/editors/SystemDesign/UndoCommands/SystemDeleteCommands.h index a3c1748e6..8675d8268 100644 --- a/editors/SystemDesign/UndoCommands/SystemDeleteCommands.h +++ b/editors/SystemDesign/UndoCommands/SystemDeleteCommands.h @@ -33,9 +33,9 @@ class SystemColumnDeleteCommand : public QUndoCommand /*! * Constructor. * - * @param [in] diagram Diagram containing the scene of the column. - * @param [in] column The column to delete. - * @param [in] parent The owner of this command. + * @param [in] diagram Diagram containing the scene of the column. + * @param [in] column The column to delete. + * @param [in] parent The owner of this command. */ SystemColumnDeleteCommand(DesignDiagram* diagram, SystemColumn* column, QUndoCommand* parent = 0); @@ -62,14 +62,14 @@ class SystemColumnDeleteCommand : public QUndoCommand /*! * Add delete command for the connection. * - * @param [in] connection The selected connection. + * @param [in] connection The selected connection. */ void addConnectionDeleteCommand(GraphicsConnection* connection); /*! * Get the removed column. * - * @return The removed column. + * @return The removed column. */ QSharedPointer getDeletedColumn(); diff --git a/editors/SystemDesign/UndoCommands/SystemMoveCommands.h b/editors/SystemDesign/UndoCommands/SystemMoveCommands.h index 6e24cf664..a192363c6 100644 --- a/editors/SystemDesign/UndoCommands/SystemMoveCommands.h +++ b/editors/SystemDesign/UndoCommands/SystemMoveCommands.h @@ -29,9 +29,9 @@ class SWConnectionMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] conn The SW connection. - * @param [in] oldRoute The old route of the connection. - * @param [in] parent The parent command. + * @param [in] conn The SW connection. + * @param [in] oldRoute The old route of the connection. + * @param [in] parent The parent command. */ SWConnectionMoveCommand(GraphicsConnection* conn, QList const& oldRoute, QUndoCommand* parent = 0); @@ -78,21 +78,21 @@ class SWPortMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] port The port to move. - * @param [in] oldPos The port's old position. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] port The port to move. + * @param [in] oldPos The port's old position. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ SWPortMoveCommand(SWPortItem* port, QPointF const& oldPos, DesignDiagram* diagram, QUndoCommand* parent = 0); /*! * Constructor. * - * @param [in] port The port to move. - * @param [in] oldPos The port's old position. - * @param [in] newPos The port's new position. - * @param [in] diagram Diagram containing the scene of the port. - * @param [in] parent The parent command. + * @param [in] port The port to move. + * @param [in] oldPos The port's old position. + * @param [in] newPos The port's new position. + * @param [in] diagram Diagram containing the scene of the port. + * @param [in] parent The parent command. */ SWPortMoveCommand(SWPortItem* port, QPointF const& oldPos, QPointF const& newPos, DesignDiagram* diagram, QUndoCommand* parent = 0); diff --git a/editors/common/Association/Associable.h b/editors/common/Association/Associable.h index d7d4eda8d..c7d8bb87a 100644 --- a/editors/common/Association/Associable.h +++ b/editors/common/Association/Associable.h @@ -32,30 +32,30 @@ class Associable /*! * Adds a new association to the item. * - * @param [in] association The association to add. + * @param [in] association The association to add. */ virtual void addAssociation(Association* association); /*! * Removes an association from the item. * - * @param [in] association The association to remove. + * @param [in] association The association to remove. */ virtual void removeAssociation(Association* association); /*! * Gets the item associations. * - * @return The associations of the item. + * @return The associations of the item. */ QList getAssociations() const; /*! * Defines the connection point for associations in scene coordinates. * - * @param [in] otherEnd The position of the other end connection point. + * @param [in] otherEnd The position of the other end connection point. * - * @return The connection point of the item. + * @return The connection point of the item. */ virtual QPointF connectionPoint(QPointF const& otherEnd = QPointF()) const = 0; diff --git a/editors/common/Association/Association.h b/editors/common/Association/Association.h index b321c2a6f..e3f4e3259 100644 --- a/editors/common/Association/Association.h +++ b/editors/common/Association/Association.h @@ -38,9 +38,9 @@ class Association: public QGraphicsLineItem /*! * The constructor. * - * @param [in] startItem The item at the starting end of the association. - * @param [in] endItem The item at the end of the association. - * @param [in] parent The parent item. + * @param [in] startItem The item at the starting end of the association. + * @param [in] endItem The item at the end of the association. + * @param [in] parent The parent item. */ Association(Associable* startItem, Associable* endItem, QSharedPointer endpointExtension, QGraphicsItem* parent = 0); @@ -53,9 +53,9 @@ class Association: public QGraphicsLineItem /*! * Draws the item. * - * @param [in] painter The painter to use. - * @param [in] option Painting style options. - * @param [in] widget The widget to paint on. + * @param [in] painter The painter to use. + * @param [in] option Painting style options. + * @param [in] widget The widget to paint on. */ void paint(QPainter* painter, QStyleOptionGraphicsItem const* option, QWidget* widget); @@ -74,14 +74,14 @@ class Association: public QGraphicsLineItem /*! * Changes the item at the end of the association. * - * @param [in] endItem The item to set as the new end item. + * @param [in] endItem The item to set as the new end item. */ void setEndItem(Associable* endItem); /*! * Gets the vendor extension representing the endpoint position. * - * @return The endpoint vendor extension. + * @return The endpoint vendor extension. */ QSharedPointer getEndpointExtension() const; diff --git a/editors/common/Association/AssociationAddCommand.h b/editors/common/Association/AssociationAddCommand.h index 414cb94c5..e4b2a19de 100644 --- a/editors/common/Association/AssociationAddCommand.h +++ b/editors/common/Association/AssociationAddCommand.h @@ -27,9 +27,9 @@ class AssociationAddCommand : public QUndoCommand /*! * Constructor. * - * @param [in] association The association to add. - * @param [in] scene The scene to add the association to. - * @param [in] parent The parent command. + * @param [in] association The association to add. + * @param [in] scene The scene to add the association to. + * @param [in] parent The parent command. */ AssociationAddCommand(Association* association, QGraphicsScene* scene, QUndoCommand* parent = 0); diff --git a/editors/common/Association/AssociationChangeEndpointCommand.h b/editors/common/Association/AssociationChangeEndpointCommand.h index 74a41f7d2..631232bc7 100644 --- a/editors/common/Association/AssociationChangeEndpointCommand.h +++ b/editors/common/Association/AssociationChangeEndpointCommand.h @@ -28,10 +28,10 @@ class AssociationChangeEndpointCommand : public QUndoCommand /*! * Constructor. * - * @param [in] association The association whose end point to change. - * @param [in] oldEndpoint The previous end point item. - * @param [in] newEndpoint The end point item to set. - * @param [in] parent The parent command. + * @param [in] association The association whose end point to change. + * @param [in] oldEndpoint The previous end point item. + * @param [in] newEndpoint The end point item to set. + * @param [in] parent The parent command. */ AssociationChangeEndpointCommand(Association* association, Associable* oldEndpoint, Associable* newEndpoint, QUndoCommand* parent = 0); diff --git a/editors/common/Association/AssociationRemoveCommand.h b/editors/common/Association/AssociationRemoveCommand.h index 21700dab8..2f73c2e86 100644 --- a/editors/common/Association/AssociationRemoveCommand.h +++ b/editors/common/Association/AssociationRemoveCommand.h @@ -28,9 +28,9 @@ class AssociationRemoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] association The association to remove. - * @param [in] scene The scene from which to remove the association from. - * @param [in] parent The parent command. + * @param [in] association The association to remove. + * @param [in] scene The scene from which to remove the association from. + * @param [in] parent The parent command. */ AssociationRemoveCommand(Association* association, QGraphicsScene* scene, QUndoCommand* parent = 0); diff --git a/editors/common/ComponentDesignDiagram.h b/editors/common/ComponentDesignDiagram.h index d0932c7b7..7b51369e1 100644 --- a/editors/common/ComponentDesignDiagram.h +++ b/editors/common/ComponentDesignDiagram.h @@ -59,7 +59,7 @@ class ComponentDesignDiagram : public DesignDiagram /*! * Checks if a single item has been selected. * - * @return True, if only one item is selected, otherwise false. + * @return True, if only one item is selected, otherwise false. */ bool singleSelection() const; @@ -96,7 +96,7 @@ public slots: /*! * Called when open design is selected from the context menu. * - * @param [in] selectedAction The action used to select the opened design. + * @param [in] selectedAction The action used to select the opened design. */ virtual void onOpenDesignAction(QAction* selectedAction); @@ -110,8 +110,8 @@ public slots: /*! * Opens a design for a given component. * - * @param [in] component The component whose design to open. - * @param [in] viewName The name of the view to open. + * @param [in] component The component whose design to open. + * @param [in] viewName The name of the view to open. */ virtual void openDesignForComponent(ComponentItem* component, QString const& viewName) = 0; @@ -139,16 +139,16 @@ public slots: /*! * Creates the context menu for function contextMenuEvent(). * - * @param [in] pos Mouse position when the menu is requested. + * @param [in] pos Mouse position when the menu is requested. * - * @return The menu with allowed actions or 0 if no menu is allowed or nothing to show. + * @return The menu with allowed actions or 0 if no menu is allowed or nothing to show. */ virtual QMenu* createContextMenu(QPointF const& pos); /*! * Updates the open design sub-menu according to item views. * - * @param [in] compItem The component item whose views to display in the sub-menu. + * @param [in] compItem The component item whose views to display in the sub-menu. */ virtual void updateOpenDesignMenuFor(ComponentItem* compItem); @@ -158,164 +158,164 @@ public slots: /*! * Checks if add to library action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool addToLibraryActionEnabled() const; /*! * Checks if open component action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool openComponentActionEnabled() const = 0; /*! * Check if the delete action can be enabled. * - * @return True, if the delete action should be enabled, otherwise false. + * @return True, if the delete action should be enabled, otherwise false. */ virtual bool deleteActionEnabled() const; /*! * Check if the selected items are of the correct type for the design diagram. * - * @return True, if the selected items are used in the design, false otherwise. + * @return True, if the selected items are used in the design, false otherwise. */ virtual bool selectedItemIsCorrectType() const = 0; /*! * Checks if open design action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool openDesignEnabled() const; /*! * Checks if the auto connector action is enabled. * - * @return True, if the action is enabled, otherwise false. + * @return True, if the action is enabled, otherwise false. */ virtual bool autoConnectorEnabled() const; /*! * Checks if the given item is a hierarchical component. * - * @param [in] item The item to check. + * @param [in] item The item to check. * - * @return True, if item is a hierarchical component, otherwise false. + * @return True, if item is a hierarchical component, otherwise false. */ virtual bool isHierarchicalComponent(QGraphicsItem* item) const = 0; /*! * Checks if copy action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool copyActionEnabled() const = 0; /*! * Checks if paste action should be enabled. * - * @return True, if action should be enabled, otherwise false. + * @return True, if action should be enabled, otherwise false. */ virtual bool pasteActionEnabled() const = 0; /*! * Checks if current selection is a draft component. * - * @return Ture, if the current selection is a draft component, otherwise false. + * @return Ture, if the current selection is a draft component, otherwise false. */ bool draftSelected() const; /*! * Opens the given component in component editor or design according to the active view of the component. * - * @param [in] comp The component to open. + * @param [in] comp The component to open. */ void openComponentItem(ComponentItem* comp); /*! * Opens the given component in component editor. * - * @param [in] comp The component to open. + * @param [in] comp The component to open. */ void openInComponentEditor(ComponentItem* comp); /*! * Opens the given component according to the active view of the component. * - * @param [in] comp The component to open. + * @param [in] comp The component to open. */ virtual void openComponentByActiveView(ComponentItem* comp) = 0; /*! * Gets the names of hierarchical views of a component. * - * @param [in] component The component whose hierarchical views to get. + * @param [in] component The component whose hierarchical views to get. * - * @return The names of the hierarchical views. + * @return The names of the hierarchical views. */ virtual QStringList hierarchicalViewsOf(ComponentItem* component) const = 0; /*! * Gets the name of the active view for the given component item. * - * @param [in] compItem The item whose active view to get. + * @param [in] compItem The item whose active view to get. * - * @return The name of the active view. + * @return The name of the active view. */ QString getActiveViewOf(ComponentItem* compItem) const; /*! * Get the active view for the item containing the selected end point item. * - * @param [in] endPoint The selected end point item. + * @param [in] endPoint The selected end point item. * - * @return The active view for the item containing the selected end point item. + * @return The active view for the item containing the selected end point item. */ QString getActiveViewForEndPoint(ConnectionEndpoint* endPoint) const; /*! * Gets the position where context menu was activated. * - * @return The position of the context menu activation. + * @return The position of the context menu activation. */ QPoint contextMenuPosition() const; /*! * Gets the graphics item type of the components in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int componentType() const = 0; /*! * Gets the graphics item type of the off page connectors in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int offpageConnectorType() const = 0; /*! * Gets the graphics item type of the connections in the diagram. * - * @return The type of the components. + * @return The type of the components. */ virtual int connectionType() const = 0; /*! * Find the cursor position mapped to the current scene. * - * @return The cursor position mapped to the current scene. + * @return The cursor position mapped to the current scene. */ QPointF findCursorPositionMappedToScene() const; /*! * Get the visible name for the selected component item. * - * @param [in] item The selected component item. + * @param [in] item The selected component item. * - * @return Visible name of the selected component item. + * @return Visible name of the selected component item. */ QString getVisibleNameForComponentItem(ComponentItem* item) const; @@ -336,14 +336,14 @@ public slots: * Handler for connection tool clicks. Creates a connection to the given position by either * beginning a new connection or ending currently drawn connection to it. * - * @param [in] cursorPosition The position to connect. + * @param [in] cursorPosition The position to connect. */ void connectAt(QPointF const& cursorPosition); /*! * Checks if a connection is being drawn. * - * @return True, if a connection is being drawn, otherwise false. + * @return True, if a connection is being drawn, otherwise false. */ bool creatingConnection() const; @@ -351,21 +351,21 @@ public slots: * Sets the starting end point for a new connection. If offpage mode is on, the previous starting point * is used, otherwise the starting point is selected based on the clicked cursor position. * - * @param [in] cursorPosition The cursor position. + * @param [in] cursorPosition The cursor position. */ void setConnectionStartingPoint(QPointF const& cursorPosition); /*! * Checks if the starting point of current connection is set. * - * @return True, if the staring point has been set, otherwise false. + * @return True, if the staring point has been set, otherwise false. */ bool hasConnectionStartingPoint() const; /*! * Begins drawing a connection from the given point. * - * @param [in] startingPoint The point to start the connection from. + * @param [in] startingPoint The point to start the connection from. */ void beginCreateConnection(QPointF const& startingPoint); @@ -375,53 +375,53 @@ public slots: /*! * Checks if an endpoint can be used as the ending point for current connection. * - * @param [in] endpoint The endpoint to check. + * @param [in] endpoint The endpoint to check. * - * @return True, if endpoint can be connected to the current connection, otherwise false. + * @return True, if endpoint can be connected to the current connection, otherwise false. */ bool isPossibleEndpointForCurrentConnection(ConnectionEndpoint* endpoint) const; /*! * Creates the currently drawn connection by ending it to the given point. * - * @param [in] event The ending point. + * @param [in] event The ending point. */ void endConnectionTo(QPointF const& point); /*! * Creates a connection between the given two endpoints. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending connection end point. - * @param [in] isOffPage Determines if connection to be created is off-page or not. - * @return The created connection. + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending connection end point. + * @param [in] isOffPage Determines if connection to be created is off-page or not. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint, bool isOffPage = false) = 0; /*! * Creates a connection between the given endpoint and a coordinate point. * - * @param [in] startPoint The starting connection end point. - * @param [in] endPoint The ending coordinate point. + * @param [in] startPoint The starting connection end point. + * @param [in] endPoint The ending coordinate point. * - * @return The created connection. + * @return The created connection. */ virtual GraphicsConnection* createConnection(ConnectionEndpoint* startPoint, QPointF const& endPoint) = 0; /*! * Creates an add command for a given connection. * - * @param [in] connection The connection to create a command for. + * @param [in] connection The connection to create a command for. * - * @return The created add command. + * @return The created add command. */ virtual QUndoCommand* createAddCommandForConnection(GraphicsConnection* connection, QUndoCommand* parentCommand = nullptr) = 0; /*! * Get the connection between two given endpoints. * - * @param [in] startPoint The start endpoint. - * @param [in] endPoint The ending endpoint. + * @param [in] startPoint The start endpoint. + * @param [in] endPoint The ending endpoint. * * @return The connection between the endpoints, or nullptr if not found or if either endpoint doesn't exist. */ @@ -430,7 +430,7 @@ public slots: /*! * Checks if the ending point of current connection is set. * - * @return True, if the ending point has been set, otherwise false. + * @return True, if the ending point has been set, otherwise false. */ bool hasConnectionEndingPoint() const; @@ -449,16 +449,16 @@ public slots: /*! * Handler for interface tool clicks. * - * @param [in] position The interface position. + * @param [in] position The interface position. */ void addInterfaceAt(QPointF const& position); /*! * Adds a new top-level interface to the given diagram column. * - * @param [in] column The column where to add the interface. - * @param [in] pos The interface position. - * @param [in] isDraft Determines if Top level interface is draft or not. + * @param [in] column The column where to add the interface. + * @param [in] pos The interface position. + * @param [in] isDraft Determines if Top level interface is draft or not. */ virtual void addTopLevelInterface(GraphicsColumn* column, QPointF const& pos, bool isDraft) = 0; @@ -466,22 +466,22 @@ public slots: * Handler for draft tool clicks. Creates a draft component instance or a draft interface according to the * clicked position. * - * @param [in] clickedPosition The position to create the draft item to. + * @param [in] clickedPosition The position to create the draft item to. */ virtual void draftAt(QPointF const& clickedPosition) = 0; /*! * Handler for offpage tool clicks. Toggles the connection offpage mode for clicked interface or connection. * - * @param [in] position The point to toggle at. + * @param [in] position The point to toggle at. */ void toggleOffPageAt(QPointF const& position); /*! * Toggles the connection style of the given connection between normal and off-page style. * - * @param [in] conn The connection. - * @param [in] parentCmd The parent undo command. + * @param [in] conn The connection. + * @param [in] parentCmd The parent undo command. */ void toggleConnectionStyle(GraphicsConnection* conn, QUndoCommand* parentCmd); @@ -491,23 +491,23 @@ public slots: /*! * Begins replacing another component with a component at the given position. * - * @param [in] startpoint The position to start replacing from. + * @param [in] startpoint The position to start replacing from. */ void beginComponentReplaceDrag(QPointF const& startpoint); /*! * Updates the cursor according to design content at the given position while replacing. * - * @param [in] cursorPosition The cursor position. + * @param [in] cursorPosition The cursor position. */ void updateComponentReplaceDragCursor(QPointF const& cursorPosition); /*! * Check if a component item is allowed in the column located at the selected position. * - * @param [in] cursorPosition The selected position. + * @param [in] cursorPosition The selected position. * - * @return True, if the item is allowed in the column, false otherwise. + * @return True, if the item is allowed in the column, false otherwise. */ bool componentItemIsAllowedInColumnAtPosition (QPointF const& cursorPosition) const; @@ -515,43 +515,43 @@ public slots: * Ends the component replace at the given position. If another component is in the given position, * it is replaced with the component being dragged. * - * @param [in] endpoint The point to end the replacing. + * @param [in] endpoint The point to end the replacing. */ void endComponentReplaceDrag(QPointF const& endpoint); /*! * Performs the replacing of destination component with source component. * - * @param [in] destComp The component to replace. - * @param [in] sourceComp The replacing component. + * @param [in] destComp The component to replace. + * @param [in] sourceComp The replacing component. */ virtual void replace(ComponentItem* destComp, ComponentItem* sourceComp) = 0; /*! * Updates the currently drawn connection and its highlights. * - * @param [in] cursorPosition The position of the cursor. + * @param [in] cursorPosition The position of the cursor. */ virtual void updateConnectionDisplay(QPointF const& cursorPosition); /*! * Updates the drawing of current connection. * - * @param [in] cursorPosition The position of the cursor. Connection ends to it. + * @param [in] cursorPosition The position of the cursor. Connection ends to it. */ virtual void updateConnectionDraw(QPointF const& cursorPosition); /*! * Updates highlighting of possible endpoints for a new connection. * - * @param [in] cursorPosition The position of the cursor. Connection begins from it. + * @param [in] cursorPosition The position of the cursor. Connection begins from it. */ virtual void highlightEndpointUnderCursor(QPointF const& cursorPosition); /*! * Updates the highlighting of endpoint near the cursor for current connection. * - * @param [in] cursorPosition The position of the cursor. + * @param [in] cursorPosition The position of the cursor. */ void highlightPotentialEndpointUnderCursor(QPointF const& cursorPosition); @@ -563,24 +563,24 @@ public slots: /*! * Setup the text for the auto connector action. * - * @param [in] componentItem The target of the connection. + * @param [in] componentItem The target of the connection. */ void setupAutoconnectText(ComponentItem* componentItem); /*! * Get the connection end point for the selected auto connector item. * - * @param [in] connectorItem The selected auto connector item. + * @param [in] connectorItem The selected auto connector item. * - * @return The end point item for the selected auto connector item. + * @return The end point item for the selected auto connector item. */ virtual ConnectionEndpoint* getEndPointForItem(AutoConnectorItem* connectorItem, QUndoCommand* parentUndoCommand = nullptr) = 0; /*! * Create connection between the selected end points. * - * @param [in] startPoint Start point for the connection. - * @param [in] endPoint End point for the connection. + * @param [in] startPoint Start point for the connection. + * @param [in] endPoint End point for the connection. */ virtual void createConnectionBetweenEndPoints(ConnectionEndpoint* startPoint, ConnectionEndpoint* endPoint) = 0; @@ -588,58 +588,58 @@ public slots: /*! * Check if the auto connector should be added to the context menu. * - * @return True, if the auto connected should be added, false otherwise. + * @return True, if the auto connected should be added, false otherwise. */ virtual bool addAutoConnectorActionToContextMenu() const; /*! * Create auto connection dialog. * - * @param [in] firstItem The first item for the auto connector. + * @param [in] firstItem The first item for the auto connector. * - * @return The auto connector dialog. + * @return The auto connector dialog. */ virtual ComponentItemAutoConnector* createAutoConnector(ComponentItem* firstItem) const = 0; /*! * Ensure visibility of a moving item. * - * @param [in] mouseEvent The mouse event. + * @param [in] mouseEvent The mouse event. */ void ensureMovedItemVisibility(QGraphicsSceneMouseEvent* mouseEvent); /*! * Get the margin for keeping selection in view. * - * @param [in] scrollBar Scrollbar for margin calculations. - * @param [in] position Current position on the same axis as the scrollbar. - * @param [in] availableArea The maximum coordinates of the area. + * @param [in] scrollBar Scrollbar for margin calculations. + * @param [in] position Current position on the same axis as the scrollbar. + * @param [in] availableArea The maximum coordinates of the area. * - * @return Current margin for the current selection. + * @return Current margin for the current selection. */ qreal getMarginForVisibility(QScrollBar const* scrollBar, int const& position, qreal const& availableArea) const; /*! * Get the margin modifier for the current margin. * - * @param [in] scrollBar Scrollbar for margin calculations. - * @param [in] position Current position on the same axis as the scrollbar. - * @param [in] availableArea The maximum coordinates of the area. + * @param [in] scrollBar Scrollbar for margin calculations. + * @param [in] position Current position on the same axis as the scrollbar. + * @param [in] availableArea The maximum coordinates of the area. * - * @return Modifier for the margin, between 0 and 1. + * @return Modifier for the margin, between 0 and 1. */ qreal getMarginModifierForVisibility(QScrollBar const* scrollBar, int const& position, qreal const& availableArea) const; /*! * Get the clicked position modifier for visibility calculation. * - * @param [in] clickStartPosition Coordinates of the clicked position. - * @param [in] followWidth Width of the area to be visible. - * @param [in] availableWidth Available width of the area. - * @param [in] margin The margin for visibility check. - * @param [in] marginMultiplier Multiplier for margin. + * @param [in] clickStartPosition Coordinates of the clicked position. + * @param [in] followWidth Width of the area to be visible. + * @param [in] availableWidth Available width of the area. + * @param [in] margin The margin for visibility check. + * @param [in] marginMultiplier Multiplier for margin. * - * @return Modifier for visibility coordinates according to the position of the click. + * @return Modifier for visibility coordinates according to the position of the click. */ qreal getPositionModifierForVisibility(qreal const& clickStartPosition, int const& followWidth, int const& availableWidth, qreal const& margin, qreal const& marginMultiplier) const; @@ -651,9 +651,9 @@ public slots: /*! * Removes pre-existing connections from list returned by connection editor. * - * @param [in/out] originalConnections List containing the original connections. + * @param [in/out] originalConnections List containing the original connections. * Gets modified to contain only connections to be removed. - * @param [in/out] updatedConnections List containing the connections returned by connection editor. + * @param [in/out] updatedConnections List containing the connections returned by connection editor. * Gets modified to contain only new connections. */ void removeUnchangedConnectionEditorConnections(QList >& originalConnections, @@ -662,16 +662,16 @@ public slots: /*! * Creates add commands for given connections. * - * @param [in] connections Connections to create add commands for. - * @param [in] parentCommand The parent command for the created add commands. + * @param [in] connections Connections to create add commands for. + * @param [in] parentCommand The parent command for the created add commands. */ void createAddCommandsForGivenConnections(QList > const& connections, QUndoCommand* parentCommand); /*! * Creates remove commands for given connections. * - * @param [in] connections Connections to create remove commands for. - * @param [in] parentCommand The parent command for the created remove commands. + * @param [in] connections Connections to create remove commands for. + * @param [in] parentCommand The parent command for the created remove commands. */ void createRemoveCommandsForGivenConnections(QList > const& connections, QUndoCommand* parentCommand); diff --git a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsEditor.h b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsEditor.h index f1d3b942b..9de0ae8b1 100644 --- a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsEditor.h +++ b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsEditor.h @@ -36,11 +36,11 @@ class ComponentInstanceConfigurableElementsEditor : public QWidget /*! * The constructor. * - * @param [in] parameterExpressions The expressions for selecting parameter references. - * @param [in] moduleParameterExpressions The expressions for selecting module parameter references. - * @param [in] defaultExpressions The expressions for resolving default values. - * @param [in] completionModel The completion model for selecting parameter references. - * @param [in] parent The parent widget. + * @param [in] parameterExpressions The expressions for selecting parameter references. + * @param [in] moduleParameterExpressions The expressions for selecting module parameter references. + * @param [in] defaultExpressions The expressions for resolving default values. + * @param [in] completionModel The completion model for selecting parameter references. + * @param [in] parent The parent widget. */ ComponentInstanceConfigurableElementsEditor( ExpressionSet parameterExpressions, ExpressionSet moduleParameterExpressions, ExpressionSet defaultExpressions, @@ -58,10 +58,10 @@ class ComponentInstanceConfigurableElementsEditor : public QWidget /*! * Set the component instance to be edited. * - * @param [in] component Pointer to the component referenced by the component instance. - * @param [in] instance Pointer to the component instance to edit. - * @param [in] viewConfiguration Pointer to the view configuration of the component instance. - * @param [in] editProvider Pointer to the editing capabilities. + * @param [in] component Pointer to the component referenced by the component instance. + * @param [in] instance Pointer to the component instance to edit. + * @param [in] viewConfiguration Pointer to the view configuration of the component instance. + * @param [in] editProvider Pointer to the editing capabilities. */ void setComponent(QSharedPointer component, QSharedPointer instance, QSharedPointer viewConfiguration, QSharedPointer editProvider); @@ -79,14 +79,14 @@ class ComponentInstanceConfigurableElementsEditor : public QWidget /*! * Increase the amount of references to a parameter with the matching ID. * - * @param [in] id ID of the parameter, whose references are being increased. + * @param [in] id ID of the parameter, whose references are being increased. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter with a matching ID. * - * @param [in] id ID of the parameter, whose references are being decreased. + * @param [in] id ID of the parameter, whose references are being decreased. */ void decreaseReferences(QString const& id); diff --git a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsFilter.h b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsFilter.h index ef7197afe..d5b8d3d91 100644 --- a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsFilter.h +++ b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsFilter.h @@ -27,7 +27,7 @@ class ComponentInstanceConfigurableElementsFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] parent The owner of this filter. + * @param [in] parent The owner of this filter. */ ComponentInstanceConfigurableElementsFilter(QObject* parent); @@ -41,10 +41,10 @@ class ComponentInstanceConfigurableElementsFilter : public QSortFilterProxyModel /*! * Validate the given row on a parent and check if the item should be shown. * - * @param [in] source_row The row number of the child on the parent. - * @param [in] source_parent Model index that identifies the parent object. + * @param [in] source_row The row number of the child on the parent. + * @param [in] source_parent Model index that identifies the parent object. * - * @return True, if the object should be displayed, false otherwise. + * @return True, if the object should be displayed, false otherwise. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const; @@ -53,7 +53,7 @@ public slots: /*! * Set the immediate values to be shown or hidden. * - * @param [in] show Flag for displaying the immediate values. + * @param [in] show Flag for displaying the immediate values. */ void setShowImmediateValues(bool show); @@ -71,9 +71,9 @@ public slots: /*! * Check if the selected index contains editable children. * - * @param [in] index The selected model index. + * @param [in] index The selected model index. * - * @return True, if the selected index contains editable children, false otherwise. + * @return True, if the selected index contains editable children, false otherwise. */ bool indexContainsEditableChildren(QModelIndex const& index) const; diff --git a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsModel.h b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsModel.h index b92c83eaa..2696d18d2 100644 --- a/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsModel.h +++ b/editors/common/ComponentInstanceEditor/ComponentInstanceConfigurableElementsModel.h @@ -44,13 +44,13 @@ class ComponentInstanceConfigurableElementsModel : public ConfigurableElementsMo /*! * The constructor. * - * @param [in] parameterFinder The parameter finder. - * @param [in] elementFinder Configurable elements finder. - * @param [in] elementExpressionFormatter Expression formatter for configurable element values. - * @param [in] defaultValueFormatter Expression formatter for default values. - * @param [in] elementExpressionParser Parser for configurable element values. - * @param [in] defaultValueParser Parser for default values. - * @param [in] parent The parent object. + * @param [in] parameterFinder The parameter finder. + * @param [in] elementFinder Configurable elements finder. + * @param [in] elementExpressionFormatter Expression formatter for configurable element values. + * @param [in] defaultValueFormatter Expression formatter for default values. + * @param [in] elementExpressionParser Parser for configurable element values. + * @param [in] defaultValueParser Parser for default values. + * @param [in] parent The parent object. */ ComponentInstanceConfigurableElementsModel(QSharedPointer parameterFinder, QSharedPointer elementFinder, @@ -67,9 +67,9 @@ class ComponentInstanceConfigurableElementsModel : public ConfigurableElementsMo /*! * Set the parameters for configurable element values. * - * @param [in] component Pointer to the component referenced by the component instance. - * @param [in] instance Pointer to the component instance being edited. - * @param [in] viewConfiguration Pointer to the active view of the instanced component. + * @param [in] component Pointer to the component referenced by the component instance. + * @param [in] instance Pointer to the component instance being edited. + * @param [in] viewConfiguration Pointer to the active view of the instanced component. */ void setParameters(QSharedPointer component, QSharedPointer instance, QSharedPointer viewConfiguration); @@ -79,7 +79,7 @@ class ComponentInstanceConfigurableElementsModel : public ConfigurableElementsMo /*! * Signal for connecting the root item models to the flag for displaying immediate values. * - * @param [in] show Flag for displaying the immediate values. + * @param [in] show Flag for displaying the immediate values. */ void showImmediateValuesInModels(bool show); @@ -97,10 +97,10 @@ class ComponentInstanceConfigurableElementsModel : public ConfigurableElementsMo /*! * Get the list of contained module parameters. * - * @param [in] component The component containing the module parameters. - * @param [in] viewConfiguration View configuration assigned to the component instance. + * @param [in] component The component containing the module parameters. + * @param [in] viewConfiguration View configuration assigned to the component instance. * - * @return Module parameters contained within the selected view configuration. + * @return Module parameters contained within the selected view configuration. */ QSharedPointer > > getModuleParameters( QSharedPointer component, QSharedPointer viewConfiguration); diff --git a/editors/common/ComponentInstanceEditor/ConfigurableElementsFilter.h b/editors/common/ComponentInstanceEditor/ConfigurableElementsFilter.h index a2f9b1dca..be5fba4a2 100644 --- a/editors/common/ComponentInstanceEditor/ConfigurableElementsFilter.h +++ b/editors/common/ComponentInstanceEditor/ConfigurableElementsFilter.h @@ -27,7 +27,7 @@ class ConfigurableElementsFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] parent The owner of this filter. + * @param [in] parent The owner of this filter. */ ConfigurableElementsFilter(QObject* parent); @@ -45,7 +45,7 @@ class ConfigurableElementsFilter : public QSortFilterProxyModel /*! * Emitted when the user attempts to remove an item. * - * @param [in] index The index of the item to be removed. + * @param [in] index The index of the item to be removed. */ void removeItem(QModelIndex const& index); @@ -54,27 +54,27 @@ class ConfigurableElementsFilter : public QSortFilterProxyModel /*! * Validate the given row on a parent and check if the item should be shown. * - * @param [in] source_row The row number of the child on the parent. - * @param [in] source_parent Model index that identifies the parent object. + * @param [in] source_row The row number of the child on the parent. + * @param [in] source_parent Model index that identifies the parent object. * - * @return True, if the object should be displayed, false otherwise. + * @return True, if the object should be displayed, false otherwise. */ bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override; /*! * Check if the immediate values are visible. * - * @return True, if the immediate values are visible, false otherwise. + * @return True, if the immediate values are visible, false otherwise. */ bool immediateValuesAreVisible() const; /*! * Check if the item at the selected index is visible. * - * @param [in] sourceRow Row of the selected index. - * @param [in] sourceParent Parent index of the selected item. + * @param [in] sourceRow Row of the selected index. + * @param [in] sourceParent Parent index of the selected item. * - * @return True, if the indexed item is visible, false otherwise. + * @return True, if the indexed item is visible, false otherwise. */ bool itemAtIndexIsEditable(int sourceRow, QModelIndex const& sourceParent) const; @@ -83,14 +83,14 @@ public slots: /*! * Set the flag for displaying the immediate values. * - * @param [in] show Flag for displaying the immediate values. + * @param [in] show Flag for displaying the immediate values. */ void setShowImmediateValues(bool show); /*! * Removes an item of the given index from the model. * - * @param [in] filterIndex The index of the item to be removed. + * @param [in] filterIndex The index of the item to be removed. */ void onRemoveItem(QModelIndex const& filterIndex); diff --git a/editors/common/ComponentInstanceEditor/ConfigurableElementsModel.h b/editors/common/ComponentInstanceEditor/ConfigurableElementsModel.h index f59759162..51c8973c8 100644 --- a/editors/common/ComponentInstanceEditor/ConfigurableElementsModel.h +++ b/editors/common/ComponentInstanceEditor/ConfigurableElementsModel.h @@ -50,12 +50,12 @@ class ConfigurableElementsModel : public QAbstractItemModel, public Parameteriza /*! * The constructor. * - * @param [in] parameterFinder Finds parameters. - * @param [in] configurableElementExpressionFormatter Formatter for configurable elements. - * @param [in] defaultValueFormatter Formatter for default values. - * @param [in] configurableElementExpressionParser Parses expressions in configurable element values. - * @param [in] defaultValueParser Parses expressions in default values. - * @param [in] parent Pointer to the owner of this model. + * @param [in] parameterFinder Finds parameters. + * @param [in] configurableElementExpressionFormatter Formatter for configurable elements. + * @param [in] defaultValueFormatter Formatter for default values. + * @param [in] configurableElementExpressionParser Parses expressions in configurable element values. + * @param [in] defaultValueParser Parses expressions in default values. + * @param [in] parent Pointer to the owner of this model. */ ConfigurableElementsModel(QSharedPointer parameterFinder, QSharedPointer configurableElementExpressionFormatter, @@ -75,10 +75,10 @@ class ConfigurableElementsModel : public QAbstractItemModel, public Parameteriza /*! * Set the parameters for configurable element values. * - * @param [in] containingItemName Name of the item containing the configurable element values. - * @param [in] parameters The configurable parameters. - * @param [in] choices List of choices available to the configurable element values. - * @param [in] storedConfigurableElements List of previously set configurable element values. + * @param [in] containingItemName Name of the item containing the configurable element values. + * @param [in] parameters The configurable parameters. + * @param [in] choices List of choices available to the configurable element values. + * @param [in] storedConfigurableElements List of previously set configurable element values. */ void setParameters(QString const& containingItemName, QSharedPointer > > parameters, @@ -89,79 +89,79 @@ class ConfigurableElementsModel : public QAbstractItemModel, public Parameteriza /*! * Get the number of rows to be displayed. * - * @param [in] parent Identifies the parent, must always be invalid index. + * @param [in] parent Identifies the parent, must always be invalid index. * - * @return The number of rows to display. + * @return The number of rows to display. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns to display. * - * @param [in] parent Identifies the parent, must always be invalid index. + * @param [in] parent Identifies the parent, must always be invalid index. * - * @return The number of columns to display. + * @return The number of columns to display. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the data for specified index in given data role. * - * @param [in] index Identifies the object that's data is wanted. - * @param [in] role Identifies the type of data being requested. + * @param [in] index Identifies the object that's data is wanted. + * @param [in] role Identifies the type of data being requested. * - * @return QVariant that contains the requested data. + * @return QVariant that contains the requested data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Get the data for the given header in the given data role. * - * @param [in] section Identifies the header section. - * @param [in] orientation Only horizontal header is supported. - * @param [in] role Identifies the type of the data being requested. + * @param [in] section Identifies the header section. + * @param [in] orientation Only horizontal header is supported. + * @param [in] role Identifies the type of the data being requested. * - * @return QVariant that contains the requested data. + * @return QVariant that contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for the specified index. * - * @param [in] index Identifies the object which data is to be saved. - * @param [in] value Contains the data to be saved. - * @param [in] role Identifies the type of the data to be saved. + * @param [in] index Identifies the object which data is to be saved. + * @param [in] value Contains the data to be saved. + * @param [in] role Identifies the type of the data to be saved. * - * @return True if data was saved successfully. + * @return True if data was saved successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole ); /*! * Get info on what operations are possible for specified item. * - * @param [in] index Identifies the item that's operations are requested. + * @param [in] index Identifies the item that's operations are requested. * - * @return Flags containing info on which operations are available for given index. + * @return Flags containing info on which operations are available for given index. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const; /*! * Get the model index of the parent of the object. * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelindex that identifies the parent of the given object. + * @return QModelindex that identifies the parent of the given object. */ QModelIndex parent(const QModelIndex& child) const; @@ -176,41 +176,41 @@ public slots: /*! * Handles item removal. * - * @param [in] elementID ID of the referenced parameter. - * @param [in] elementRow Index row of the removed element. + * @param [in] elementID ID of the referenced parameter. + * @param [in] elementRow Index row of the removed element. */ void onRemoveItem(QString const& elementID, int elementRow); /*! * Handles the addition of new configurable elements. * - * @param [in] elementID ID of the referenced parameter. - * @param [in] elementValue The new configurable value. - * @param [in] elementRow Index row for the new item. + * @param [in] elementID ID of the referenced parameter. + * @param [in] elementValue The new configurable value. + * @param [in] elementRow Index row for the new item. */ void onAddItem(QString const& elementID, QString const& elementValue, int elementRow); /*! * Sends a data change signal for the selected configurable element. * - * @param [in] parameterID ID of the parameter referenced by the configurable element. - * @param [in] newValue The new value of the configurable element. + * @param [in] parameterID ID of the parameter referenced by the configurable element. + * @param [in] newValue The new value of the configurable element. */ void emitDataChangeForID(QString const& parameterID, QString const& newValue); /*! * Check if the given index is valid. * - * @param [in] index The index to be checked. + * @param [in] index The index to be checked. * - * @return True, if the given index is valid, false otherwise. + * @return True, if the given index is valid, false otherwise. */ bool isIndexValid(QModelIndex const& index) const; /*! * Get the configurable elements from the table. * - * @return The configurable elements from the table. + * @return The configurable elements from the table. */ QList > getConfigurableElements() const; @@ -226,36 +226,36 @@ public slots: /*! * Check if the column index is valid for containing expressions. * - * @param [in] index The index being evaluated. + * @param [in] index The index being evaluated. * - * @return True, if column can have expressions, false otherwise. + * @return True, if column can have expressions, false otherwise. */ virtual bool isValidExpressionColumn(QModelIndex const& index) const; /*! * Gets a formatted value for a given expression in default value column. * - * @param [in] expression The expression which is being formatted. + * @param [in] expression The expression which is being formatted. * - * @return The formatted value for the expression. + * @return The formatted value for the expression. */ virtual QString formattedValueFor(QString const& expression) const; /*! * Gets the expression for the given index, or plain value if there is no expression. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return Expression in the given index if there is one, or plain value. + * @return Expression in the given index if there is one, or plain value. */ virtual QVariant expressionOrValueForIndex(QModelIndex const& index) const; /*! * Validates the data in a parameter corresponding to a given column. * - * @param [in] index The index whose data to validate. + * @param [in] index The index whose data to validate. * - * @return True, if the data in the parameter is valid, otherwise false. + * @return True, if the data in the parameter is valid, otherwise false. */ virtual bool validateIndex(QModelIndex const& index) const; @@ -267,11 +267,11 @@ public slots: /*! * Evaluate the value for the given index. * - * @param [in] column The column of the required value. - * @param [in] choiceName The name of the choice used in the given value. - * @param [in] value The given value. + * @param [in] column The column of the required value. + * @param [in] choiceName The name of the choice used in the given value. + * @param [in] value The given value. * - * @return The true value for the given index, whether it is given using a choice or not. + * @return The true value for the given index, whether it is given using a choice or not. */ QString evaluateValue(int column, QString const& choiceName, QString const& value) const; @@ -295,18 +295,18 @@ public slots: /*! * Check if the configurable element is editable. * - * @param [in] parameterIndex The index of the element. + * @param [in] parameterIndex The index of the element. * - * @return True, if the element can be edited, false otherwise. + * @return True, if the element can be edited, false otherwise. */ bool isParameterEditable(QModelIndex const& index) const; /*! * Gets the value for the given index. * - * @param [in] index The index of target data. + * @param [in] index The index of target data. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; @@ -314,38 +314,38 @@ public slots: /*! * Finds the currently selected choice. * - * @param [in] choiceName The name of the choice to be searched for. + * @param [in] choiceName The name of the choice to be searched for. * - * @return The currently selected choice. + * @return The currently selected choice. */ QSharedPointer findChoice(QString const& choiceName) const; /*! * Finds the display values for the currently selected enumeration inside an array. * - * @param [in] choice The currently selected choice. - * @param [in] arrayValue The value that contains an array. + * @param [in] choice The currently selected choice. + * @param [in] arrayValue The value that contains an array. * - * @return The displayable array value of the enumeration. + * @return The displayable array value of the enumeration. */ QString matchArrayValuesToSelectedChoice(QSharedPointer choice, QString const& arrayValue) const; /*! * Finds the display value for the currently selected enumeration. * - * @param [in] choice The currently selected choice. - * @param [in] enumerationValue The current value to be changed into an enumeration. + * @param [in] choice The currently selected choice. + * @param [in] enumerationValue The current value to be changed into an enumeration. * - * @return The displayable value of the enumeration. + * @return The displayable value of the enumeration. */ QString findDisplayValueForEnumeration(QSharedPointer choice, QString const& enumerationValue) const; /*! * Gets the text for the tooltip related to the data in the given index. * - * @param [in] index The index of the target data. + * @param [in] index The index of the target data. * - * @return The corresponding text for a tool tip. + * @return The corresponding text for a tool tip. */ QString tooltipForIndex(QModelIndex const& index) const; @@ -353,43 +353,43 @@ public slots: /*! * Get the selected configurable element. * - * @param [in] elementID The id of the element to be searched for. + * @param [in] elementID The id of the element to be searched for. * - * @return The selected configurable element. + * @return The selected configurable element. */ QSharedPointer getStoredConfigurableElement(QString const& elementID); /*! * Create an unknown parameter. * - * @param [in] parameterID ID of the unknown parameter. + * @param [in] parameterID ID of the unknown parameter. * - * @return The created unknown parameter. + * @return The created unknown parameter. */ QSharedPointer createUnknownParameter(QString const& parameterID); /*! * Checks if it is possible to delete the element in the given index. * - * @param [in] index The given index of the element. + * @param [in] index The given index of the element. * - * @return True, if the element can be deleted, false otherwise. + * @return True, if the element can be deleted, false otherwise. */ bool isElementDeletable(QModelIndex const& index) const; /*! * Get the referenced parameter ID of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Parameter ID of the selected index. + * @return Parameter ID of the selected index. */ QString parameterIDForIndex(QModelIndex const& index) const; /*! * Get the configurable elements contained in the model. * - * @return The configurable elements contained within the model + * @return The configurable elements contained within the model */ QSharedPointer > > getItemConfigurableElementValues() const; diff --git a/editors/common/ComponentInstanceEditor/ConfigurableElementsView.h b/editors/common/ComponentInstanceEditor/ConfigurableElementsView.h index b953a64ed..de186bd32 100644 --- a/editors/common/ComponentInstanceEditor/ConfigurableElementsView.h +++ b/editors/common/ComponentInstanceEditor/ConfigurableElementsView.h @@ -30,7 +30,7 @@ class ConfigurableElementsView : public EditableTableView /*! * The constructor. * - * @param [in] parent The owner of this view. + * @param [in] parent The owner of this view. */ ConfigurableElementsView(QWidget* parent); @@ -44,10 +44,10 @@ class ConfigurableElementsView : public EditableTableView /*! * Emitted when a configurable element change command should be created. * - * @param [in] oldValue Old value of the indexed element. - * @param [in] newValue New value of the indexed element. - * @param [in] index The selected index. - * @param [in] cevModel Model containing the configurable elements. + * @param [in] oldValue Old value of the indexed element. + * @param [in] newValue New value of the indexed element. + * @param [in] index The selected index. + * @param [in] cevModel Model containing the configurable elements. */ void createElementChangeCommand(QString const& oldValue, QString const& newValue, QModelIndex const& index, QAbstractItemModel* cevModel) const; @@ -57,7 +57,7 @@ class ConfigurableElementsView : public EditableTableView /*! * Handler for context menu events. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event); diff --git a/editors/common/ComponentInstanceEditor/EditorConfigurableElement.h b/editors/common/ComponentInstanceEditor/EditorConfigurableElement.h index 74cab83c2..22da849b4 100644 --- a/editors/common/ComponentInstanceEditor/EditorConfigurableElement.h +++ b/editors/common/ComponentInstanceEditor/EditorConfigurableElement.h @@ -27,9 +27,9 @@ class EditorConfigurableElement /*! * The constructor. * - * @param [in] referenceParameter Parameter referenced by the configurable element. - * @param [in] evaluatedDefaultValue Evaluated default value of the referenced parameter. - * @param [in] configuratedValue The configurable value. + * @param [in] referenceParameter Parameter referenced by the configurable element. + * @param [in] evaluatedDefaultValue Evaluated default value of the referenced parameter. + * @param [in] configuratedValue The configurable value. */ EditorConfigurableElement(QSharedPointer referencedParameter, QString const& evaluatedDefaultValue, QString const& configuratedValue); @@ -46,42 +46,42 @@ class EditorConfigurableElement /*! * Get the referenced parameter. * - * @return The referenced parameter. + * @return The referenced parameter. */ QSharedPointer getReferencedParameter() const; /*! * Set a new parameter reference. * - * @param [in] parameter The new parameter. + * @param [in] parameter The new parameter. */ void setParameterReference(QSharedPointer parameter); /*! * Get the evaluated parameter default value. * - * @return The evaluated parameter default value. + * @return The evaluated parameter default value. */ QString const& getEvaluatedDefaultValue() const; /*! * Set a new evaluated default value. * - * @param [in] newEvaluatedDefaultValue The new evaluated default value. + * @param [in] newEvaluatedDefaultValue The new evaluated default value. */ void setEvaluatedDefaultValue(QString const& newEvaluatedDefaultValue); /*! * Get the configurable element value. * - * @return The configurable element value. + * @return The configurable element value. */ QString const& getConfiguratedValue() const; /*! * Set a new value for configurable value. * - * @param [in] newConfiguratedValue The new configurable element value. + * @param [in] newConfiguratedValue The new configurable element value. */ void setConfiguratedValue(QString const& newConfiguratedValue); diff --git a/editors/common/ComponentInstanceEditor/MissingConfigurableElementsFilter.h b/editors/common/ComponentInstanceEditor/MissingConfigurableElementsFilter.h index 98ec2bcba..1f686fed1 100644 --- a/editors/common/ComponentInstanceEditor/MissingConfigurableElementsFilter.h +++ b/editors/common/ComponentInstanceEditor/MissingConfigurableElementsFilter.h @@ -29,7 +29,7 @@ class MissingConfigurableElementsFilter : public ParameterConfigurableElementsFi /*! * The constructor. * - * @param [in] parent The owner of this filter. + * @param [in] parent The owner of this filter. */ MissingConfigurableElementsFilter(QObject* parent); @@ -43,10 +43,10 @@ class MissingConfigurableElementsFilter : public ParameterConfigurableElementsFi /*! * Validate the given row on a parent and check if the item should be shown. * - * @param [in] source_row The row number of the child on the parent. - * @param [in] source_parent Model index that identifies the parent object. + * @param [in] source_row The row number of the child on the parent. + * @param [in] source_parent Model index that identifies the parent object. * - * @return True, if the object should be displayed, false otherwise. + * @return True, if the object should be displayed, false otherwise. */ bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const final; diff --git a/editors/common/ComponentInstanceEditor/ParameterConfigurableElementsFilter.h b/editors/common/ComponentInstanceEditor/ParameterConfigurableElementsFilter.h index fc509d956..323e59d08 100644 --- a/editors/common/ComponentInstanceEditor/ParameterConfigurableElementsFilter.h +++ b/editors/common/ComponentInstanceEditor/ParameterConfigurableElementsFilter.h @@ -29,7 +29,7 @@ class ParameterConfigurableElementsFilter : public ConfigurableElementsFilter /*! * The constructor. * - * @param [in] parent The owner of this filter. + * @param [in] parent The owner of this filter. */ ParameterConfigurableElementsFilter(QObject* parent); @@ -47,19 +47,19 @@ class ParameterConfigurableElementsFilter : public ConfigurableElementsFilter /*! * Validate the given row on a parent and check if the item should be shown. * - * @param [in] source_row The row number of the child on the parent. - * @param [in] source_parent Model index that identifies the parent object. + * @param [in] source_row The row number of the child on the parent. + * @param [in] source_parent Model index that identifies the parent object. * - * @return True, if the object should be displayed, false otherwise. + * @return True, if the object should be displayed, false otherwise. */ bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override; /*! * Check if the default value of the indexed item is empty. * - * @param [in] sourceRow Row of the indexed item. + * @param [in] sourceRow Row of the indexed item. * - * @return True, if the default value of the indexed item is empty, false otherwise. + * @return True, if the default value of the indexed item is empty, false otherwise. */ bool isIndexedDefaultValueEmpty(int sourceRow) const; diff --git a/editors/common/ComponentInstanceEditor/PowerDomainLinkDelegate.h b/editors/common/ComponentInstanceEditor/PowerDomainLinkDelegate.h index 2380ff29d..45065bab1 100644 --- a/editors/common/ComponentInstanceEditor/PowerDomainLinkDelegate.h +++ b/editors/common/ComponentInstanceEditor/PowerDomainLinkDelegate.h @@ -29,8 +29,8 @@ class PowerDomainLinkDelegate : public EnumerationEditorConstructorDelegate /*! The constructor * - * @param [in] component The component being edited. - * @param [in] parent The owner of this delegate. + * @param [in] component The component being edited. + * @param [in] parent The owner of this delegate. */ explicit PowerDomainLinkDelegate(QObject *parent = nullptr); @@ -43,28 +43,28 @@ class PowerDomainLinkDelegate : public EnumerationEditorConstructorDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const final; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ void setEditorData(QWidget* editor, QModelIndex const& index) const final; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ void setModelData(QWidget* editor, QAbstractItemModel* model, @@ -78,34 +78,34 @@ class PowerDomainLinkDelegate : public EnumerationEditorConstructorDelegate /*! * Check if the column is used for enumerations. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is used for editing enumerations, false otherwise. + * @return True, if the column is used for editing enumerations, false otherwise. */ bool isEnumerationEditorColumn(QModelIndex const& index) const final; /*! * The list of currently selected enumerations in the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. * - * @return List of currently selected enumerations. + * @return List of currently selected enumerations. */ QStringList getCurrentSelection(QModelIndex const& index) const final; /*! * Get the list of the available enumerations. * - * @return List of the available enumerations. + * @return List of the available enumerations. */ QStringList getAvailableItems() const final; /*! * Set the selected enumerations to the selected item. * - * @param [in] index Model index identifying the item that's data is to be saved. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] selectedItems List of the selected enumerations. + * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] selectedItems List of the selected enumerations. */ void setEnumerationDataToModel(QModelIndex const& index, QAbstractItemModel* model, QStringList const& selectedItems) const final; diff --git a/editors/common/ComponentInstanceEditor/PowerDomainLinkEditor.h b/editors/common/ComponentInstanceEditor/PowerDomainLinkEditor.h index 9191b4529..b9013c2d4 100644 --- a/editors/common/ComponentInstanceEditor/PowerDomainLinkEditor.h +++ b/editors/common/ComponentInstanceEditor/PowerDomainLinkEditor.h @@ -37,7 +37,7 @@ class PowerDomainLinkEditor : public QGroupBox /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ explicit PowerDomainLinkEditor(QWidget* parent); diff --git a/editors/common/ComponentInstanceEditor/PowerDomainLinkModel.h b/editors/common/ComponentInstanceEditor/PowerDomainLinkModel.h index 4c2fbcb20..e0251d92b 100644 --- a/editors/common/ComponentInstanceEditor/PowerDomainLinkModel.h +++ b/editors/common/ComponentInstanceEditor/PowerDomainLinkModel.h @@ -35,7 +35,7 @@ class PowerDomainLinkModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ explicit PowerDomainLinkModel(QObject* parent = nullptr); @@ -52,51 +52,51 @@ class PowerDomainLinkModel : public QAbstractTableModel /*! * Returns the number of rows in this model. * - * @param [in] parent ModelIndex of the item that's rowCount is requested. + * @param [in] parent ModelIndex of the item that's rowCount is requested. */ int rowCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Returns the number of rows in this model. * - * @param [in] parent ModelIndex of the item that's rowCount is requested. + * @param [in] parent ModelIndex of the item that's rowCount is requested. */ int columnCount(QModelIndex const& parent = QModelIndex()) const final; /*! * Returns the data stored for the specified item. * - * @param [in] index ModelIndex of the wanted item. - * @param [in] role Specifies what kind of data is requested. + * @param [in] index ModelIndex of the wanted item. + * @param [in] role Specifies what kind of data is requested. */ QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const final; /*! * Returns the data for the header of the list. * - * @param [in] section Specifies the column for which the header is requested. - * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. - * @param [in] role Specifies what kind of header data is requested. + * @param [in] section Specifies the column for which the header is requested. + * @param [in] orientation The orientation of the header, only Qt::Horizontal is supported. + * @param [in] role Specifies what kind of header data is requested. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const final; /*! * Saves the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole) final; /*! * Returns the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(QModelIndex const& index) const final; @@ -108,14 +108,14 @@ public slots: /*! * A new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void addItem(QModelIndex const& index); /*! * Removes the specified item from the model. * - * @param [in] index The model index of the item to remove. + * @param [in] index The model index of the item to remove. */ void removeItem(QModelIndex const& index); diff --git a/editors/common/ComponentInstanceEditor/componentinstanceeditor.h b/editors/common/ComponentInstanceEditor/componentinstanceeditor.h index a84335624..c1b489749 100644 --- a/editors/common/ComponentInstanceEditor/componentinstanceeditor.h +++ b/editors/common/ComponentInstanceEditor/componentinstanceeditor.h @@ -52,7 +52,7 @@ class ComponentInstanceEditor : public QWidget /*! * The constructor * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ ComponentInstanceEditor(QWidget *parent); @@ -68,9 +68,9 @@ class ComponentInstanceEditor : public QWidget /*! * Set the component to be edited. * - * @param [in] component Pointer to the component instance being edited. - * @param [in] editProvider Interface for providing editing capabilities (undo & redo). - * @param [in] design Design containing the component instance. + * @param [in] component Pointer to the component instance being edited. + * @param [in] editProvider Interface for providing editing capabilities (undo & redo). + * @param [in] design Design containing the component instance. */ void setComponentInstance(ComponentItem* component, QSharedPointer editProvider, QSharedPointer design, QSharedPointer designConfiguration, QString const& activeViewName); @@ -78,15 +78,15 @@ class ComponentInstanceEditor : public QWidget /*! * Sets the top component for the instances. * - * @param [in] topComponent The top component. - * @param [in] editProvider The generic edit provider. + * @param [in] topComponent The top component. + * @param [in] editProvider The generic edit provider. */ void setContext(QSharedPointer topComponent, QSharedPointer editProvider); /*! * Sets the protection state for the instance editor. * - * @param [in] locked Locks/unlock the editor. + * @param [in] locked Locks/unlock the editor. */ void setProtection(bool locked); @@ -95,7 +95,7 @@ public slots: /*! * Sets the active view to use for the top component. * - * @param [in] activeView The name of the active view. + * @param [in] activeView The name of the active view. */ void setTopComponentActiveView(QSharedPointer activeView); @@ -114,14 +114,14 @@ public slots: /*! * Increase the amount of references to a parameter with the matching ID. * - * @param [in] id ID of the parameter, whose references are being increased. + * @param [in] id ID of the parameter, whose references are being increased. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter with a matching ID. * - * @param [in] id ID of the parameter, whose references are being decreased. + * @param [in] id ID of the parameter, whose references are being decreased. */ void decreaseReferences(QString const& id); diff --git a/editors/common/ComponentInstanceEditor/configurableelementdelegate.h b/editors/common/ComponentInstanceEditor/configurableelementdelegate.h index 4ae4907cd..890b338cd 100644 --- a/editors/common/ComponentInstanceEditor/configurableelementdelegate.h +++ b/editors/common/ComponentInstanceEditor/configurableelementdelegate.h @@ -40,10 +40,10 @@ class ConfigurableElementDelegate : public ChoiceCreatorDelegate /*! * The constructor. * - * @param [in] completionModel Model containing the completions used in expression editor. - * @param [in] parameterFinder Pointer to the parameter finder, used in expression editor. - * @param [in] expressionFormatter Expression formatter, used to change parameter ids to names. - * @param [in] parent Pointer to the owner of this delegate. + * @param [in] completionModel Model containing the completions used in expression editor. + * @param [in] parameterFinder Pointer to the parameter finder, used in expression editor. + * @param [in] expressionFormatter Expression formatter, used to change parameter ids to names. + * @param [in] parent Pointer to the owner of this delegate. */ ConfigurableElementDelegate(QAbstractItemModel* completionModel, QSharedPointer parameterFinder, QSharedPointer expressionFormatter, QObject *parent); @@ -56,18 +56,18 @@ class ConfigurableElementDelegate : public ChoiceCreatorDelegate /*! * Set a new edit provider. * - * @param [in] newEditProvider The new edit provider. + * @param [in] newEditProvider The new edit provider. */ void setEditProvider(QSharedPointer newEditProvider); /*! * Create a new editor for the given item. * - * @param [in] parent Owner of the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner of the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -75,33 +75,33 @@ class ConfigurableElementDelegate : public ChoiceCreatorDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Set the choices for this delegate. * - * @param [in] choices The choices of the current component. + * @param [in] choices The choices of the current component. */ void setChoices(QSharedPointer > > choices); /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -109,19 +109,19 @@ class ConfigurableElementDelegate : public ChoiceCreatorDelegate /*! * Paint the delegate. * - * @param [in] painter The painter used. - * @param [in] option The style option in use. - * @param [in] index The current index of the model. + * @param [in] painter The painter used. + * @param [in] option The style option in use. + * @param [in] index The current index of the model. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Returns the size needed by the delegate to display the item in index. * - * @param [in] option The style information. - * @param [in] index The index of the item. + * @param [in] option The style information. + * @param [in] index The index of the item. * - * @return The size needed by the delegate to display the item in index. + * @return The size needed by the delegate to display the item in index. */ virtual QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -132,7 +132,7 @@ public slots: /*! * Handles the creation of a configurable element remove command. * - * @param [in] indexes Indexes of the selected configurable elements. + * @param [in] indexes Indexes of the selected configurable elements. */ void onCreateRemoveElementCommands(QModelIndexList const& indexes); void onCreateRemoveElementCommands(QModelIndex const& index); @@ -140,17 +140,17 @@ public slots: /*! * Create remove commands for the sub items of the selected index. * - * @param [in] indexes Indexes of the selected configurable elements. + * @param [in] indexes Indexes of the selected configurable elements. */ void onCreateMultipleElementRemoveCommands(QModelIndexList const& indexes); /*! * Create an undo command for configurable element value change. * - * @param [in] oldValue Old value of the configurable element. - * @param [in] newValue New value of the configurable element. - * @param [in] index Index of the changed configurable element. - * @param [in] cevModel Model containing the configurable element. + * @param [in] oldValue Old value of the configurable element. + * @param [in] newValue New value of the configurable element. + * @param [in] index Index of the changed configurable element. + * @param [in] cevModel Model containing the configurable element. */ void createElementChangeCommand(QString const& oldValue, QString const& newValue, QModelIndex const& index, QAbstractItemModel* cevModel) const; @@ -160,17 +160,17 @@ public slots: /*! * Informs the model to emit a data change signal for the selected configurable element. * - * @param [in] parameterID ID of the parameter referenced by the selected configurable element. - * @param [in] newDataValue The new configurable element value. + * @param [in] parameterID ID of the parameter referenced by the selected configurable element. + * @param [in] newDataValue The new configurable element value. */ void dataChangedInID(QString const& parameterID, QString const& newDataValue); /*! * Informs the model that a new configurable element should be added. * - * @param [in] elementID ID of the parameter referenced by the new configurable element. - * @param [in] elementValue New value for the configurable element. - * @param [in] elementRow Index row of the new configurable element. + * @param [in] elementID ID of the parameter referenced by the new configurable element. + * @param [in] elementValue New value for the configurable element. + * @param [in] elementRow Index row of the new configurable element. */ void addConfigurableElement(QString const& elementID, QString const& elementValue, int elementRow); @@ -178,8 +178,8 @@ public slots: /*! * Informs the model that a configurable element should be removed. * - * @param [in] elementID ID of the parameter referenced by the removed configurable element. - * @param [in] elementRow Index row of the selected configurable element. + * @param [in] elementID ID of the parameter referenced by the removed configurable element. + * @param [in] elementRow Index row of the selected configurable element. */ void removeConfigurableElement(QString const& elementID, int elementRow); @@ -188,25 +188,25 @@ public slots: /*! * Checks if the given column supports expressions in the editor. * - * @param [in] column The column to check. + * @param [in] column The column to check. * - * @return True, if the cells in the column accept expressions, otherwise false. + * @return True, if the cells in the column accept expressions, otherwise false. */ bool columnAcceptsExpression(int column) const; /*! * Gets the name of the choice on the currently selected row. * - * @param [in] index The index of the currently selected row. + * @param [in] index The index of the currently selected row. * - * @return The name of the choice used in the row on the given index. + * @return The name of the choice used in the row on the given index. */ virtual QString choiceNameOnRow(QModelIndex const& index) const; /*! * Gets the column number of the value column. * - * @return The column number of the value column. + * @return The column number of the value column. */ virtual int valueColumn() const; @@ -218,14 +218,14 @@ private slots: /*! * Increase the amount of references to parameters made in the selected value. * - * @param [in] newValue The selected value. + * @param [in] newValue The selected value. */ void increaseReferencesInNewValue(QString const& newValue); /*! * Decrease the amount of references to parameters made in the selected value. * - * @param [in] oldValue The selected value. + * @param [in] oldValue The selected value. */ void decreaseReferencesInOldValue(QString const& oldValue); @@ -238,27 +238,27 @@ private slots: /*! * Check if the value at the given index is an array. * - * @param [in] index The index of the current value. + * @param [in] index The index of the current value. * - * @return True, if the value is an array, false otherwise. + * @return True, if the value is an array, false otherwise. */ bool valueIsArray(QModelIndex const& index) const; /*! * Create the editor for the array value. * - * @param [in] editor The editor to be changed to array editor. - * @param [in] index The index of the current value. + * @param [in] editor The editor to be changed to array editor. + * @param [in] index The index of the current value. */ void createArrayEditor(QWidget* editor, QModelIndex const& index) const; /*! * Get the size of the array. * - * @param [in] arrayLeft The left side of the array. - * @param [in] arrayRight The right side of the array. + * @param [in] arrayLeft The left side of the array. + * @param [in] arrayRight The right side of the array. * - * @return The size of the array. + * @return The size of the array. */ int getArraySize(int arrayLeft, int arrayRight) const; @@ -266,9 +266,9 @@ private slots: * Repositions the editor to better use the available space. The editor is then resized to best cover the * usable area. * - * @param [in] editor The editor to reposition. - * @param [in] option The style options for the editor. - * @param [in] index The current index. + * @param [in] editor The editor to reposition. + * @param [in] option The style options for the editor. + * @param [in] index The current index. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -277,10 +277,10 @@ private slots: /*! * Create an element remove command for the selected configurable element. * - * @param [in] index Index of the selected configurable element. - * @param [in] parentCommand The parent command. + * @param [in] index Index of the selected configurable element. + * @param [in] parentCommand The parent command. * - * @return Pointer to the created configurable element remove command. + * @return Pointer to the created configurable element remove command. */ ConfigurableElementRemoveCommand* createElementRemoveCommand(QModelIndex const& index, QSharedPointer parentCommand); @@ -288,27 +288,27 @@ private slots: /*! * Get the filtered index row of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return The filtered index row of the selected index. + * @return The filtered index row of the selected index. */ int getFilteredIndexRow(QModelIndex const& index) const; /*! * Get the name of the parent item of the selected configurable element. * - * @param [in] parentIndex Parent index of the selected configurable element. + * @param [in] parentIndex Parent index of the selected configurable element. * - * @return Name of the parent item of the selected configurable element. + * @return Name of the parent item of the selected configurable element. */ QString getIndexedParentName(QModelIndex const& parentIndex) const; /*! * Get a list of configurable element values contained within the item of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return A list of configurable element values. + * @return A list of configurable element values. */ QSharedPointer > > getIndexedConfigurableElements( QModelIndex const& index) const; @@ -316,23 +316,23 @@ private slots: /*! * Get the ID of the parameter referenced in the indexed item. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return ID of the referenced parameter. + * @return ID of the referenced parameter. */ QString getIndexedElementID(QModelIndex const& index) const; /*! * Connect the selected configurable element remove command. * - * @param [in] removeCommand The selected configurable element remove command. + * @param [in] removeCommand The selected configurable element remove command. */ void connectElementRemoveCommand(ConfigurableElementRemoveCommand* removeCommand); /*! * Add the selected command to the command stack and redo the command. * - * @param [in] newCommand The selected command. + * @param [in] newCommand The selected command. */ void addCommandToStackAndRedo(QSharedPointer newCommand) const; diff --git a/editors/common/ComponentInstanceEditor/configurableelementeditor.h b/editors/common/ComponentInstanceEditor/configurableelementeditor.h index 0166ec610..a5961d3ac 100644 --- a/editors/common/ComponentInstanceEditor/configurableelementeditor.h +++ b/editors/common/ComponentInstanceEditor/configurableelementeditor.h @@ -46,10 +46,10 @@ class ConfigurableElementEditor : public QGroupBox /*! * The constructor. * - * @param [in] parameterExpressions The expressions for selecting parameter references. - * @param [in] defaultExpressions The expressions for resolving default values. - * @param [in] completionModel The completion model for selecting parameter references. - * @param [in] parent The parent widget. + * @param [in] parameterExpressions The expressions for selecting parameter references. + * @param [in] defaultExpressions The expressions for resolving default values. + * @param [in] completionModel The completion model for selecting parameter references. + * @param [in] parent The parent widget. */ ConfigurableElementEditor( ExpressionSet parameterExpressions, ExpressionSet defaultExpressions, QAbstractItemModel* completionModel, QWidget *parent); @@ -84,14 +84,14 @@ class ConfigurableElementEditor : public QGroupBox /*! * Increase the amount of references to a parameter corresponding to the ID. * - * @param [in] id The ID of the parameter being searched for. + * @param [in] id The ID of the parameter being searched for. */ void increaseReferences(QString const& id); /*! * Decrease the amount of references to a parameter corresponding to the ID. * - * @param [in] id The ID of the parameter being searched for. + * @param [in] id The ID of the parameter being searched for. */ void decreaseReferences(QString const& id); diff --git a/editors/common/ComponentItemAutoConnector/AutoConnector.h b/editors/common/ComponentItemAutoConnector/AutoConnector.h index f0f436d43..d210f9877 100644 --- a/editors/common/ComponentItemAutoConnector/AutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/AutoConnector.h @@ -39,11 +39,11 @@ class AutoConnector : public QWidget /*! * The constructor. * - * @param [in] firstComponentContainer The first component container. - * @param [in] secondComponentContainer The second component container. - * @param [in] tableToolsContainer The table tools container. - * @param [in] itemName Name of the items being connected. - * @param [in] parent The parent of this widget. + * @param [in] firstComponentContainer The first component container. + * @param [in] secondComponentContainer The second component container. + * @param [in] tableToolsContainer The table tools container. + * @param [in] itemName Name of the items being connected. + * @param [in] parent The parent of this widget. */ AutoConnector(ComponentItemAutoConnector::AutoContainer const& firstComponentContainer, ComponentItemAutoConnector::AutoContainer const& secondComponentContainer, @@ -58,7 +58,7 @@ class AutoConnector : public QWidget /*! * Get the list of connected items. * - * @return A list of connected item pairs. + * @return A list of connected item pairs. */ QVector > getConnectedItems() const; @@ -80,7 +80,7 @@ class AutoConnector : public QWidget /*! * Fill the connection table with already connected items. * - * @param [in] design The containing design. + * @param [in] design The containing design. */ void connectAlreadyConnectedItems(QSharedPointer design); @@ -107,9 +107,9 @@ public slots: /*! * Setup the layout. * - * @param [in] firstComponentName Name of the first container. - * @param [in] secondComponentName Name of the second container. - * @param [in] itemName Name of the items being connected. + * @param [in] firstComponentName Name of the first container. + * @param [in] secondComponentName Name of the second container. + * @param [in] itemName Name of the items being connected. */ void setupLayout(QString const& firstComponentName, QString const& secondComponentName, QString const& itemName); diff --git a/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionDelegate.h b/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionDelegate.h index 5b5d06241..e8013a125 100644 --- a/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionDelegate.h +++ b/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionDelegate.h @@ -31,12 +31,12 @@ class AutoConnectorConnectionDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] firstItem The first component item to be connected. - * @param [in] secondItem The second component item to be connected. - * @param [in] firstList View of the first item list. - * @param [in] secondList View of the second item list. - * @param [in] itemMatcher Checks for possible matches between two items. - * @param [in] parent The parent of the object. + * @param [in] firstItem The first component item to be connected. + * @param [in] secondItem The second component item to be connected. + * @param [in] firstList View of the first item list. + * @param [in] secondList View of the second item list. + * @param [in] itemMatcher Checks for possible matches between two items. + * @param [in] parent The parent of the object. */ AutoConnectorConnectionDelegate(QSharedPointer firstComponent, QSharedPointer secondComponent, QListView* firstList, QListView* secondList, @@ -50,11 +50,11 @@ class AutoConnectorConnectionDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -62,17 +62,17 @@ class AutoConnectorConnectionDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -85,14 +85,14 @@ class AutoConnectorConnectionDelegate : public QStyledItemDelegate /*! * Create the selection widget for ports. * - * @param [in] selectionIndex Index of the item selector. - * @param [in] itemList List containing the items of the selected component. - * @param [in] comparisonItemColumn Column of the comparison item. - * @param [in] itemComponent Component containing the items of the selected index. - * @param [in] comparisonItemComponent Component containing the items of the comparison index. - * @param [in] parent Parent item of the editor. + * @param [in] selectionIndex Index of the item selector. + * @param [in] itemList List containing the items of the selected component. + * @param [in] comparisonItemColumn Column of the comparison item. + * @param [in] itemComponent Component containing the items of the selected index. + * @param [in] comparisonItemComponent Component containing the items of the comparison index. + * @param [in] parent Parent item of the editor. * - * @return Combobox for component ports. + * @return Combobox for component ports. */ QComboBox* createItemSelector(QModelIndex const& selectionIndex, QListView* itemList, int comparisonItemColumn, QSharedPointer itemComponent, QSharedPointer comparisonItemComponent, diff --git a/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionTable.h b/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionTable.h index 8cad8d8d9..a5b780c09 100644 --- a/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionTable.h +++ b/editors/common/ComponentItemAutoConnector/AutoConnectorConnectionTable.h @@ -31,14 +31,14 @@ class AutoConnectorConnectionTable : public QTableWidget /*! * The constructor. * - * @param [in] firstComponent The first component containing the items to be connected. - * @param [in] secondComponent The second component containing the items to be connected. - * @param [in] firstList View of the first item list to be connected. - * @param [in] secondList View of the second item list to be connected. - * @param [in] firstName Name of the first item. - * @param [in] secondName Name of the second item. - * @param [in] itemMatcher Checks for possible matches between two items. - * @param [in] parent The parent item. + * @param [in] firstComponent The first component containing the items to be connected. + * @param [in] secondComponent The second component containing the items to be connected. + * @param [in] firstList View of the first item list to be connected. + * @param [in] secondList View of the second item list to be connected. + * @param [in] firstName Name of the first item. + * @param [in] secondName Name of the second item. + * @param [in] itemMatcher Checks for possible matches between two items. + * @param [in] parent The parent item. */ AutoConnectorConnectionTable(QSharedPointer firstComponent, QSharedPointer secondComponent, QListView* firstList, QListView* secondList, @@ -53,7 +53,7 @@ class AutoConnectorConnectionTable : public QTableWidget /*! * Get the connected items. * - * @return A list of connected item pairs. + * @return A list of connected item pairs. */ QVector > getConnectedItems() const; @@ -78,31 +78,31 @@ class AutoConnectorConnectionTable : public QTableWidget /*! * Handles the context menu. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent *event); /*! * Handles the mime data drop. * - * @param [in] row Row to drop the mime data to. - * @param [in] column Column to drop the mime data to. - * @param [in] data The mime data. - * @param [in] action The drop action. + * @param [in] row Row to drop the mime data to. + * @param [in] column Column to drop the mime data to. + * @param [in] data The mime data. + * @param [in] action The drop action. */ virtual bool dropMimeData(int row, int column, const QMimeData *data, Qt::DropAction action); /*! * Handles the events for drag entering this table * - * @param [in] event The selected drag enter event. + * @param [in] event The selected drag enter event. */ virtual void dragEnterEvent(QDragEnterEvent *event); /*! * Handles the events for drag moving in this table * - * @param [in] event The selected drag move event. + * @param [in] event The selected drag move event. */ virtual void dragMoveEvent(QDragMoveEvent *event); diff --git a/editors/common/ComponentItemAutoConnector/AutoConnectorItem.h b/editors/common/ComponentItemAutoConnector/AutoConnectorItem.h index 982cbe753..773d2d3a9 100644 --- a/editors/common/ComponentItemAutoConnector/AutoConnectorItem.h +++ b/editors/common/ComponentItemAutoConnector/AutoConnectorItem.h @@ -41,10 +41,10 @@ class AutoConnectorItem /*! * The constructor. * - * @param [in] itemName Name of the connected item. - * @param [in] componentItemName Name of the containing component item. - * @param [in] itemType Type of the item. - * @param [in] containerType Type of the container. + * @param [in] itemName Name of the connected item. + * @param [in] componentItemName Name of the containing component item. + * @param [in] itemType Type of the item. + * @param [in] containerType Type of the container. */ AutoConnectorItem(QString const& itemName, QString const& componentItemName, AutoConnectorItem::ItemType itemType, @@ -70,56 +70,56 @@ class AutoConnectorItem /*! * Get the name. * - * @return Name of the item. + * @return Name of the item. */ QString getName() const; /*! * Set a new name. * - * @param [in] newName New name for the item. + * @param [in] newName New name for the item. */ void setName(QString const& newName); /*! * Get the name of the containing component item. * - * @return The name of the containing component item. + * @return The name of the containing component item. */ QString getContainingItem() const; /*! * Set the name of the containing component item. * - * @param [in] newComponentItem New name for the containing component item. + * @param [in] newComponentItem New name for the containing component item. */ void setContainingItem(QString const& newComponentItem); /*! * Get the type. * - * @return Type of the item. + * @return Type of the item. */ AutoConnectorItem::ItemType getItemType() const; /*! * Set the type for the item. * - * @param [in] newItemType New type for the item. + * @param [in] newItemType New type for the item. */ void setNewItemType(AutoConnectorItem::ItemType newItemType); /*! * Get the container type. * - * @return Type of the container. + * @return Type of the container. */ AutoConnectorItem::ContainerType getContainterType() const; /*! * Set the type for the container. * - * @param [in] newContainerType New type for the container. + * @param [in] newContainerType New type for the container. */ void setNewContainerType(AutoConnectorItem::ContainerType newContainerType); diff --git a/editors/common/ComponentItemAutoConnector/AutoConnectorListFilter.h b/editors/common/ComponentItemAutoConnector/AutoConnectorListFilter.h index 72f19527b..0866c59cf 100644 --- a/editors/common/ComponentItemAutoConnector/AutoConnectorListFilter.h +++ b/editors/common/ComponentItemAutoConnector/AutoConnectorListFilter.h @@ -28,9 +28,9 @@ class AutoConnectorListFilter : public QSortFilterProxyModel /*! * Constructor. * - * @param [in] itemTable Table containing the connected items. - * @param [in] tableColumn Column in the connection table. - * @param [in] parent The parent object. + * @param [in] itemTable Table containing the connected items. + * @param [in] tableColumn Column in the connection table. + * @param [in] parent The parent object. */ AutoConnectorListFilter(QTableWidget* itemTable, int const& tableColumn, QCheckBox* hideConnectedBox, QObject* parent = 0); @@ -49,10 +49,10 @@ class AutoConnectorListFilter : public QSortFilterProxyModel /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const override; @@ -61,9 +61,9 @@ class AutoConnectorListFilter : public QSortFilterProxyModel /*! * Check if the selected item exists in the connection table. * - * @param [in] itemName Name of the selected item. + * @param [in] itemName Name of the selected item. * - * @return True, if the item has been connected, false otherwise. + * @return True, if the item has been connected, false otherwise. */ bool itemIsConnected(QString const& itemName) const; diff --git a/editors/common/ComponentItemAutoConnector/BusInterfaceItemMatcher.h b/editors/common/ComponentItemAutoConnector/BusInterfaceItemMatcher.h index e8ab40bb6..15f94a1f2 100644 --- a/editors/common/ComponentItemAutoConnector/BusInterfaceItemMatcher.h +++ b/editors/common/ComponentItemAutoConnector/BusInterfaceItemMatcher.h @@ -31,7 +31,7 @@ class BusInterfaceItemMatcher : public TableItemMatcher /*! * The constructor. * - * @param [in] library Access to the document library. + * @param [in] library Access to the document library. */ BusInterfaceItemMatcher(LibraryInterface* library); @@ -49,12 +49,12 @@ class BusInterfaceItemMatcher : public TableItemMatcher /*! * Check if the selected items can be connected. * - * @param [in] firstItem The selected item from the first component. - * @param [in] firstComponent Component containing the first item. - * @param [in] secondItem The selected item from the second component. - * @param [in] secondComponent Component containing the second item. + * @param [in] firstItem The selected item from the first component. + * @param [in] firstComponent Component containing the first item. + * @param [in] secondItem The selected item from the second component. + * @param [in] secondComponent Component containing the second item. * - * @return True, if the items can be connected, false otherwise. + * @return True, if the items can be connected, false otherwise. */ virtual bool itemsCanBeConnected(QString const& firstItem, QSharedPointer firstComponent, QString const& secondItem, QSharedPointer secondComponent) const; @@ -62,9 +62,9 @@ class BusInterfaceItemMatcher : public TableItemMatcher /*! * Get connectible bus interface modes for the selected interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. * - * @return List of connectible interface modes. + * @return List of connectible interface modes. */ virtual QVector getCompatibleModes(General::InterfaceMode busMode) const; diff --git a/editors/common/ComponentItemAutoConnector/BusInterfaceListFiller.h b/editors/common/ComponentItemAutoConnector/BusInterfaceListFiller.h index 6f51d2dc7..173c584f4 100644 --- a/editors/common/ComponentItemAutoConnector/BusInterfaceListFiller.h +++ b/editors/common/ComponentItemAutoConnector/BusInterfaceListFiller.h @@ -38,8 +38,8 @@ class BusInterfaceListFiller : public ListFiller /*! * Populate the selected model with bus interfaces from the selected component. * - * @param [in] selectedList The selected item model. - * @param [in] containingComponent The selected component. + * @param [in] selectedList The selected item model. + * @param [in] containingComponent The selected component. */ virtual void initializeList(QStandardItemModel* selectedList, QSharedPointer containingComponent) const; diff --git a/editors/common/ComponentItemAutoConnector/BusInterfaceTableAutoConnector.h b/editors/common/ComponentItemAutoConnector/BusInterfaceTableAutoConnector.h index 59b8aca6f..fb7203e4c 100644 --- a/editors/common/ComponentItemAutoConnector/BusInterfaceTableAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/BusInterfaceTableAutoConnector.h @@ -51,10 +51,10 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Create a table item. * - * @param [in] itemName Name for the table item. - * @param [in] containingComponent Component containing the selected item. + * @param [in] itemName Name for the table item. + * @param [in] containingComponent Component containing the selected item. * - * @return The new table item. + * @return The new table item. */ virtual QTableWidgetItem* createTableWidgetItem(QString const& itemName, QSharedPointer containingComponent) const; @@ -64,10 +64,10 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Find the possible item connections from the selected components. * - * @param [in] firstComponent The first component. - * @param [in] secondComponent The second component. + * @param [in] firstComponent The first component. + * @param [in] secondComponent The second component. * - * @return List of item / possible connected items pairs. + * @return List of item / possible connected items pairs. */ virtual QVector > > findPossibleCombinations( QSharedPointer firstComponent, QSharedPointer secondComponent) const; @@ -75,9 +75,9 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Find items that are already connected to populate the connection table with. * - * @param [in] firstInstanceName The first component. - * @param [in] secondInstanceName The second component. - * @param [in] design The containing design. + * @param [in] firstInstanceName The first component. + * @param [in] secondInstanceName The second component. + * @param [in] design The containing design. * * @return List of item connected item pairs. */ @@ -88,10 +88,10 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Get the names of the connectible bus interfaces for the selected bus interface. * - * @param [in] currentBus The selected bus interface. - * @param [in] secondItemBusInterfaces List of the available bus interfaces. + * @param [in] currentBus The selected bus interface. + * @param [in] secondItemBusInterfaces List of the available bus interfaces. * - * @return A list of bus interface names connectible to the selected bus interface. + * @return A list of bus interface names connectible to the selected bus interface. */ QVector getConnectableBusInterfaceNames(QSharedPointer currentBus, QSharedPointer > > secondItemBusInterfaces) const; @@ -99,10 +99,10 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Check if the selected bus interface can be connected to the selected mode. * - * @param [in] comparisonBus The bus interface being compared to. - * @param [in] comparibleModes List of connectible bus interface modes. + * @param [in] comparisonBus The bus interface being compared to. + * @param [in] comparibleModes List of connectible bus interface modes. * - * @return True, if the selected bus interface can be connected to the selected mode, false otherwise. + * @return True, if the selected bus interface can be connected to the selected mode, false otherwise. */ bool interfacesAreCompatible(QSharedPointer comparisonBus, QVector compatibleModes) const; @@ -110,9 +110,9 @@ class BusInterfaceTableAutoConnector : public TableAutoConnector /*! * Get connectible bus interface modes for the selected interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. * - * @return List of connectible interface modes. + * @return List of connectible interface modes. */ virtual QVector getCompatibleInterfaceModes(General::InterfaceMode const& busMode) const; diff --git a/editors/common/ComponentItemAutoConnector/ComponentItemAutoConnector.h b/editors/common/ComponentItemAutoConnector/ComponentItemAutoConnector.h index c1f22db99..2596be757 100644 --- a/editors/common/ComponentItemAutoConnector/ComponentItemAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/ComponentItemAutoConnector.h @@ -65,13 +65,13 @@ class ComponentItemAutoConnector : public QDialog /*! * The constructor. * - * @param [in] firstContainer Data for the first container. - * @param [in] secondContainer Data for the second container. - * @param [in] busTableTools Auto connector tools for the bus interface item connector. - * @param [in] portTableTools Auto connector tools for the port item connector. - * @param [in] secondItemType Type of the second item container. - * @param [in] design The design containing the items to connect. - * @param [in] parent The parent of this widget. + * @param [in] firstContainer Data for the first container. + * @param [in] secondContainer Data for the second container. + * @param [in] busTableTools Auto connector tools for the bus interface item connector. + * @param [in] portTableTools Auto connector tools for the port item connector. + * @param [in] secondItemType Type of the second item container. + * @param [in] design The design containing the items to connect. + * @param [in] parent The parent of this widget. */ ComponentItemAutoConnector(AutoContainer const& firstContainer, AutoContainer const& secondContainer, TableTools const& busTableTools, TableTools const& portTableTools, @@ -85,7 +85,7 @@ class ComponentItemAutoConnector : public QDialog /*! * Get the list of connected items. * - * @return A list of item pairs. + * @return A list of item pairs. */ QVector > getConnectedItems() const; @@ -122,10 +122,10 @@ private slots: /*! * Create connected item pairs from the selected connector table. * - * @param [in] connector The selected connector table. - * @param [in] itemType Type for the items. + * @param [in] connector The selected connector table. + * @param [in] itemType Type for the items. * - * @return List of connected item pairs. + * @return List of connected item pairs. */ QVector > createItemPairs(AutoConnector* connector, AutoConnectorItem::ItemType itemType) const; @@ -133,10 +133,10 @@ private slots: /*! * Create the intro widget. * - * @param [in] introName Header for the intro. - * @param [in] introText Text body for the intro. + * @param [in] introName Header for the intro. + * @param [in] introText Text body for the intro. * - * @return The intro widget. + * @return The intro widget. */ QWidget* setupIntroWidget(QString const& introName, QString const& introText) const; diff --git a/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceItemMatcher.h b/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceItemMatcher.h index 3c88adfc3..a1592bfd4 100644 --- a/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceItemMatcher.h +++ b/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceItemMatcher.h @@ -28,7 +28,7 @@ class HierarchicalBusInterfaceItemMatcher : public BusInterfaceItemMatcher /*! * The constructor. * - * @param [in] library Access to the document library. + * @param [in] library Access to the document library. */ HierarchicalBusInterfaceItemMatcher(LibraryInterface* library); @@ -46,9 +46,9 @@ class HierarchicalBusInterfaceItemMatcher : public BusInterfaceItemMatcher /*! * Get connectible bus interface modes for the selected interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. * - * @return List of connectible interface modes. + * @return List of connectible interface modes. */ virtual QVector getCompatibleModes(General::InterfaceMode busMode) const; }; diff --git a/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceTableAutoConnector.h b/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceTableAutoConnector.h index c0db79f46..cd9953e9d 100644 --- a/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceTableAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/HierarchicalBusInterfaceTableAutoConnector.h @@ -26,7 +26,7 @@ class HierarchicalBusInterfaceTableAutoConnector : public BusInterfaceTableAutoC /*! * The constructor. * - * @param [in] library Access to the document library. + * @param [in] library Access to the document library. */ HierarchicalBusInterfaceTableAutoConnector(LibraryInterface* library); @@ -45,9 +45,9 @@ class HierarchicalBusInterfaceTableAutoConnector : public BusInterfaceTableAutoC /*! * Get connectible bus interface modes for the selected interface mode. * - * @param [in] busMode The selected bus interface mode. + * @param [in] busMode The selected bus interface mode. * - * @return List of connectible interface modes. + * @return List of connectible interface modes. */ virtual QVector getCompatibleInterfaceModes(General::InterfaceMode const& busMode) const; @@ -55,9 +55,9 @@ class HierarchicalBusInterfaceTableAutoConnector : public BusInterfaceTableAutoC /*! * Find items that are already connected to populate the connection table with. * - * @param [in] firstInstanceName The first component. - * @param [in] secondInstanceName The second component. - * @param [in] design The containing design. + * @param [in] firstInstanceName The first component. + * @param [in] secondInstanceName The second component. + * @param [in] design The containing design. * * @return List of item connected item pairs. */ diff --git a/editors/common/ComponentItemAutoConnector/HierarchicalPortItemMatcher.h b/editors/common/ComponentItemAutoConnector/HierarchicalPortItemMatcher.h index 9dc857704..36e8a274c 100644 --- a/editors/common/ComponentItemAutoConnector/HierarchicalPortItemMatcher.h +++ b/editors/common/ComponentItemAutoConnector/HierarchicalPortItemMatcher.h @@ -42,9 +42,9 @@ class HierarchicalPortItemMatcher : public PortItemMatcher /*! * Get connectible port directions for the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of connectible port directions. + * @return List of connectible port directions. */ virtual QVector getConnectableDirections(DirectionTypes::Direction portDirection) const; diff --git a/editors/common/ComponentItemAutoConnector/HierarchicalPortTableAutoConnector.h b/editors/common/ComponentItemAutoConnector/HierarchicalPortTableAutoConnector.h index 63673d3eb..70b0ead5e 100644 --- a/editors/common/ComponentItemAutoConnector/HierarchicalPortTableAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/HierarchicalPortTableAutoConnector.h @@ -44,9 +44,9 @@ class HierarchicalPortTableAutoConnector : public PortTableAutoConnector /*! * Get connectible port directions for the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of connectible port directions. + * @return List of connectible port directions. */ virtual QVector getConnectableDirections(DirectionTypes::Direction portDirection) const; @@ -54,9 +54,9 @@ class HierarchicalPortTableAutoConnector : public PortTableAutoConnector /*! * Find items that are already connected to populate the connection table with. * - * @param [in] firstInstanceName The first component. - * @param [in] secondInstanceName The second component. - * @param [in] design The containing design. + * @param [in] firstInstanceName The first component. + * @param [in] secondInstanceName The second component. + * @param [in] design The containing design. * * @return List of item connected item pairs. */ diff --git a/editors/common/ComponentItemAutoConnector/ListFiller.h b/editors/common/ComponentItemAutoConnector/ListFiller.h index 583ac72c9..0115ec3de 100644 --- a/editors/common/ComponentItemAutoConnector/ListFiller.h +++ b/editors/common/ComponentItemAutoConnector/ListFiller.h @@ -26,9 +26,9 @@ class ListFiller /*! * The constructor. * - * @param [in] firstItem The first component item to be connected. - * @param [in] secondItem The second component item to be connected. - * @param [in] parent The parent of this widget. + * @param [in] firstItem The first component item to be connected. + * @param [in] secondItem The second component item to be connected. + * @param [in] parent The parent of this widget. */ ListFiller() = default; @@ -40,8 +40,8 @@ class ListFiller /*! * Populate the selected model with items from the selected component. * - * @param [in] selectedList The selected item model. - * @param [in] containingComponent The selected component. + * @param [in] selectedList The selected item model. + * @param [in] containingComponent The selected component. */ virtual void initializeList(QStandardItemModel* selectedList, QSharedPointer containingComponent) const = 0; diff --git a/editors/common/ComponentItemAutoConnector/PortItemMatcher.h b/editors/common/ComponentItemAutoConnector/PortItemMatcher.h index 759ca838a..9da87c0f4 100644 --- a/editors/common/ComponentItemAutoConnector/PortItemMatcher.h +++ b/editors/common/ComponentItemAutoConnector/PortItemMatcher.h @@ -46,12 +46,12 @@ class PortItemMatcher : public TableItemMatcher /*! * Check if the selected items can be connected. * - * @param [in] firstItem The selected item from the first component. - * @param [in] firstComponent Component containing the first item. - * @param [in] secondItem The selected item from the second component. - * @param [in] secondComponent Component containing the second item. + * @param [in] firstItem The selected item from the first component. + * @param [in] firstComponent Component containing the first item. + * @param [in] secondItem The selected item from the second component. + * @param [in] secondComponent Component containing the second item. * - * @return True, if the items can be connected, false otherwise. + * @return True, if the items can be connected, false otherwise. */ virtual bool itemsCanBeConnected(QString const& firstItem, QSharedPointer firstComponent, QString const& secondItem, QSharedPointer secondComponent) const; @@ -59,9 +59,9 @@ class PortItemMatcher : public TableItemMatcher /*! * Get connectible port directions for the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of connectible port directions. + * @return List of connectible port directions. */ virtual QVector getConnectableDirections(DirectionTypes::Direction portDirection) const; diff --git a/editors/common/ComponentItemAutoConnector/PortListFiller.h b/editors/common/ComponentItemAutoConnector/PortListFiller.h index 4f5705f3c..6f9f72cb0 100644 --- a/editors/common/ComponentItemAutoConnector/PortListFiller.h +++ b/editors/common/ComponentItemAutoConnector/PortListFiller.h @@ -38,8 +38,8 @@ class PortListFiller : public ListFiller /*! * Populate the selected model with ports from the selected component. * - * @param [in] selectedList The selected item model. - * @param [in] containingComponent The selected component. + * @param [in] selectedList The selected item model. + * @param [in] containingComponent The selected component. */ virtual void initializeList(QStandardItemModel* selectedList, QSharedPointer containingComponent) const; diff --git a/editors/common/ComponentItemAutoConnector/PortTableAutoConnector.h b/editors/common/ComponentItemAutoConnector/PortTableAutoConnector.h index 596f02659..7389ef90e 100644 --- a/editors/common/ComponentItemAutoConnector/PortTableAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/PortTableAutoConnector.h @@ -45,10 +45,10 @@ class PortTableAutoConnector : public TableAutoConnector /*! * Create a table item. * - * @param [in] itemName Name for the table item. - * @param [in] containingComponent Component containing the selected item. + * @param [in] itemName Name for the table item. + * @param [in] containingComponent Component containing the selected item. * - * @return The new table item. + * @return The new table item. */ virtual QTableWidgetItem* createTableWidgetItem(QString const& itemName, QSharedPointer containingComponent) const; @@ -58,10 +58,10 @@ class PortTableAutoConnector : public TableAutoConnector /*! * Find the possible item connections from the selected components. * - * @param [in] firstComponent The first component. - * @param [in] secondComponent The second component. + * @param [in] firstComponent The first component. + * @param [in] secondComponent The second component. * - * @return List of item / possible connected items pairs. + * @return List of item / possible connected items pairs. */ virtual QVector > > findPossibleCombinations( QSharedPointer firstComponent, QSharedPointer secondComponent) const; @@ -69,10 +69,10 @@ class PortTableAutoConnector : public TableAutoConnector /*! * Find the names of the ports possible to be connected to the selected port. * - * @param [in] protDirection Direction of the selected port. - * @param [in] secondItemPorts List of the ports contained within the second component. + * @param [in] protDirection Direction of the selected port. + * @param [in] secondItemPorts List of the ports contained within the second component. * - * @return List of connectible port names. + * @return List of connectible port names. */ QVector getConnectablePortNames(DirectionTypes::Direction portDirection, QSharedPointer > > secondItemPorts) const; @@ -80,9 +80,9 @@ class PortTableAutoConnector : public TableAutoConnector /*! * Get connectible port directions for the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of connectible port directions. + * @return List of connectible port directions. */ virtual QVector getConnectableDirections(DirectionTypes::Direction portDirection) const; @@ -90,9 +90,9 @@ class PortTableAutoConnector : public TableAutoConnector /*! * Find items that are already connected to populate the connection table with. * - * @param [in] firstInstanceName The first component. - * @param [in] secondInstanceName The second component. - * @param [in] design The containing design. + * @param [in] firstInstanceName The first component. + * @param [in] secondInstanceName The second component. + * @param [in] design The containing design. * * @return List of item connected item pairs. */ diff --git a/editors/common/ComponentItemAutoConnector/TableAutoConnector.h b/editors/common/ComponentItemAutoConnector/TableAutoConnector.h index b9385f0e3..a612b54f6 100644 --- a/editors/common/ComponentItemAutoConnector/TableAutoConnector.h +++ b/editors/common/ComponentItemAutoConnector/TableAutoConnector.h @@ -39,9 +39,9 @@ class TableAutoConnector /*! * Connect the items from the selected components. * - * @param [in] selectedTable The selected connection table. - * @param [in] firstComponent First component. - * @param [in] secondComponent Second component. + * @param [in] selectedTable The selected connection table. + * @param [in] firstComponent First component. + * @param [in] secondComponent Second component. */ void autoConnectItems(QTableWidget* selectedTable, QSharedPointer firstComponent, QSharedPointer secondComponent) const; @@ -54,12 +54,12 @@ class TableAutoConnector /*! * Connect the current items from the selected item lists. * - * @param [in] firstComponent First component to connect. - * @param [in] secondComponent Second component to connect. - * @param [in] firstList View of the first item list. - * @param [in] secondList View of the second item list. - * @param [in] targetTable The connection table. - * @param [in] itemMatcher The table item matcher to use. Validates that a connection can be made. + * @param [in] firstComponent First component to connect. + * @param [in] secondComponent Second component to connect. + * @param [in] firstList View of the first item list. + * @param [in] secondList View of the second item list. + * @param [in] targetTable The connection table. + * @param [in] itemMatcher The table item matcher to use. Validates that a connection can be made. */ void connectSelectedFromLists(QSharedPointer firstComponent, QSharedPointer secondComponent, QListView* firstList, QListView* secondList, @@ -68,12 +68,12 @@ class TableAutoConnector /*! * Populate the connection table with already connected items. * - * @param [in] targetTable The target table. - * @param [in] firstInstanceName The name of the first component. - * @param [in] secondInstanceName The name of the second component. - * @param [in] firstComponent The first component to connect. - * @param [in] secondComponent The second component to connect. - * @param [in] design The containing desing. + * @param [in] targetTable The target table. + * @param [in] firstInstanceName The name of the first component. + * @param [in] secondInstanceName The name of the second component. + * @param [in] firstComponent The first component to connect. + * @param [in] secondComponent The second component to connect. + * @param [in] design The containing desing. */ void populateTableWithConnectedItems(QTableWidget* targetTable, QString const& firstInstanceName, QString const& secondInstanceName, QSharedPointer firstComponent, QSharedPointer secondComponent, QSharedPointer design); @@ -87,10 +87,10 @@ class TableAutoConnector /*! * Create a table item. * - * @param [in] itemName Name for the table item. - * @param [in] containingComponent Component containing the selected item. + * @param [in] itemName Name for the table item. + * @param [in] containingComponent Component containing the selected item. * - * @return The new table item. + * @return The new table item. */ virtual QTableWidgetItem* createTableWidgetItem(QString const& itemName, QSharedPointer containingComponent) const; @@ -100,10 +100,10 @@ class TableAutoConnector /*! * Get the item combinations for the selected items. * - * @param [in] firstComponent The first selected item. - * @param [in] secondComponent The second selected item. + * @param [in] firstComponent The first selected item. + * @param [in] secondComponent The second selected item. * - * @return List of item name pairs. + * @return List of item name pairs. */ QVector > getCombinations(QSharedPointer firstComponent, QSharedPointer secondComponent) const; @@ -111,10 +111,10 @@ class TableAutoConnector /*! * Find the possible item connections from the selected components. * - * @param [in] firstComponent The first component. - * @param [in] secondComponent The second component. + * @param [in] firstComponent The first component. + * @param [in] secondComponent The second component. * - * @return List of item / possible connected items pairs. + * @return List of item / possible connected items pairs. */ virtual QVector > > findPossibleCombinations( QSharedPointer firstComponent, QSharedPointer secondComponent) const = 0; @@ -122,9 +122,9 @@ class TableAutoConnector /*! * Find items that are already connected to populate the connection table with. * - * @param [in] firstInstanceName The first component. - * @param [in] secondInstanceName The second component. - * @param [in] design The containing design. + * @param [in] firstInstanceName The first component. + * @param [in] secondInstanceName The second component. + * @param [in] design The containing design. * * @return List of item connected item pairs. */ @@ -135,10 +135,10 @@ class TableAutoConnector /*! * Remove existing connections from the selected list of connections. * - * @param [in] combinations The selected list of item connections. - * @param [in] targetTable Connection table. + * @param [in] combinations The selected list of item connections. + * @param [in] targetTable Connection table. * - * @return List of new connections. + * @return List of new connections. */ QVector > removeExistingCombinations( QVector > const& combinations, QTableWidget* targetTable) const; @@ -146,22 +146,22 @@ class TableAutoConnector /*! * Get text from the selected table item. * - * @param [in] itemRow Row of the item. - * @param [in] itemColumn Column of the item. - * @param [in] targetTable Table containing the item. + * @param [in] itemRow Row of the item. + * @param [in] itemColumn Column of the item. + * @param [in] targetTable Table containing the item. * - * @return The selected item text. + * @return The selected item text. */ QString getTextFromTableItem(int const& itemRow, int const& itemColumn, QTableWidget* targetTable) const; /*! * Check if a connection exists in the connection table. * - * @param [in] combinationFirst First item of the connection. - * @param [in] combinationSecond Second item of the connection - * @param [in] existingCombinations List of existing combinations. + * @param [in] combinationFirst First item of the connection. + * @param [in] combinationSecond Second item of the connection + * @param [in] existingCombinations List of existing combinations. * - * @return True, if the connection exists in the connection table, false otherwise. + * @return True, if the connection exists in the connection table, false otherwise. */ bool combinationExistsInTable(QString const& combinationFirst, QString const& combinationSecond, QVector > const& existingCombinations) const; diff --git a/editors/common/ComponentItemAutoConnector/TableItemMatcher.h b/editors/common/ComponentItemAutoConnector/TableItemMatcher.h index 9eadb26fe..901168989 100644 --- a/editors/common/ComponentItemAutoConnector/TableItemMatcher.h +++ b/editors/common/ComponentItemAutoConnector/TableItemMatcher.h @@ -40,12 +40,12 @@ class TableItemMatcher /*! * Check if the item of the selected source index can be connected to the item of the target index. * - * @param [in] sourceIndex Index of the source item. - * @param [in] targetIndex Index of the target item. - * @param [in] sourceComponent Component containing the source item. - * @param [in] targetComponent Component containing the target item. + * @param [in] sourceIndex Index of the source item. + * @param [in] targetIndex Index of the target item. + * @param [in] sourceComponent Component containing the source item. + * @param [in] targetComponent Component containing the target item. * - * @return True, if the source item can be connected with the target item, false otherwise. + * @return True, if the source item can be connected with the target item, false otherwise. */ bool canDrop(QModelIndex const& sourceIndex, QModelIndex const& targetIndex, QSharedPointer sourceComponent, QSharedPointer targetComponent) const; @@ -57,12 +57,12 @@ class TableItemMatcher /*! * Check if the selected items can be connected. * - * @param [in] firstItem The selected item from the first component. - * @param [in] firstComponent Component containing the first item. - * @param [in] secondItem The selected item from the second component. - * @param [in] secondComponent Component containing the second item. + * @param [in] firstItem The selected item from the first component. + * @param [in] firstComponent Component containing the first item. + * @param [in] secondItem The selected item from the second component. + * @param [in] secondComponent Component containing the second item. * - * @return True, if the items can be connected, false otherwise. + * @return True, if the items can be connected, false otherwise. */ virtual bool itemsCanBeConnected(QString const& firstItem, QSharedPointer firstComponent, QString const& secondItem, QSharedPointer secondComponent) const = 0; diff --git a/editors/common/ConfigurationEditor/activevieweditor.h b/editors/common/ConfigurationEditor/activevieweditor.h index 855f2d192..b33e68b0d 100644 --- a/editors/common/ConfigurationEditor/activevieweditor.h +++ b/editors/common/ConfigurationEditor/activevieweditor.h @@ -32,7 +32,7 @@ class ActiveViewEditor : public QGroupBox /*! * The constructor * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ ActiveViewEditor(QWidget *parent); @@ -42,7 +42,7 @@ class ActiveViewEditor : public QGroupBox /*! * Set the configuration to be displayed. * - * @param [in] designWidget Pointer to the design widget used to edit the design. + * @param [in] designWidget Pointer to the design widget used to edit the design. */ void setDesign(DesignWidget* designWidget); @@ -54,7 +54,7 @@ class ActiveViewEditor : public QGroupBox /*! * Lock/unlock the editor so user can/can't edit the active views. * - * @param [in] locked If true then editor is set to locked. + * @param [in] locked If true then editor is set to locked. */ void setLocked(bool locked); diff --git a/editors/common/ConfigurationEditor/activeviewmodel.h b/editors/common/ConfigurationEditor/activeviewmodel.h index 473199f8d..47cc30466 100644 --- a/editors/common/ConfigurationEditor/activeviewmodel.h +++ b/editors/common/ConfigurationEditor/activeviewmodel.h @@ -38,7 +38,7 @@ class ActiveViewModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] parent Pointer to the owner of this widget. + * @param [in] parent Pointer to the owner of this widget. */ ActiveViewModel(QObject *parent); @@ -48,8 +48,8 @@ class ActiveViewModel : public QAbstractTableModel /*! * Set the design that's active views are edited. * - * @param [in] designWidget Pointer to the design widget that manages the design. - * @param [in] desConf Pointer to the configuration to edit. + * @param [in] designWidget Pointer to the design widget that manages the design. + * @param [in] desConf Pointer to the configuration to edit. */ void setDesign(DesignWidget* designWidget, QSharedPointer desConf); @@ -61,9 +61,9 @@ class ActiveViewModel : public QAbstractTableModel /*! * Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; @@ -72,55 +72,55 @@ class ActiveViewModel : public QAbstractTableModel * * *param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return QVariant Contains the data for the item. + * @return QVariant Contains the data for the item. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return QVariant Contains the requested data. + * @return QVariant Contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Qt::ItemFlags specify the possible operations for the item. + * @return Qt::ItemFlags specify the possible operations for the item. */ Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Checks if there is created configuration for this view. * - * @return bool True if configuration exists. + * @return bool True if configuration exists. */ bool hasConfiguration() const; @@ -129,15 +129,15 @@ public slots: /*! * Rename a component instance in the model. * - * @param [in] newName The new name of the instance. - * @param [in] oldName The old name of the instance. + * @param [in] newName The new name of the instance. + * @param [in] oldName The old name of the instance. */ void renameInstance(const QString& newName, const QString& oldName); /*! * Remove the instance from the model. * - * @param [in] diaComp Pointer to the diagram component being removed. + * @param [in] diaComp Pointer to the diagram component being removed. */ void removeInstance(ComponentItem* diaComp); @@ -146,15 +146,15 @@ public slots: * NOTE: Using this function to set the active view for instance does not generate commands to the undo/redo * stack. * - * @param [in] instanceName Identifies the component instance by name. - * @param [in] viewName The new view name to be set for instance. + * @param [in] instanceName Identifies the component instance by name. + * @param [in] viewName The new view name to be set for instance. */ void setActiveView(const QString& instanceName, const QString& viewName); /*! * Add a new component instance to the model. * - * @param [in] diaComp Pointer to the new component instance. + * @param [in] diaComp Pointer to the new component instance. */ void addInstance(ComponentItem* diaComp); @@ -178,33 +178,33 @@ public slots: /*! * The struct constructor * - * @param [in] instanceName The name for the component instance. - * @param [in] viewName The name of the active view. + * @param [in] instanceName The name for the component instance. + * @param [in] viewName The name of the active view. */ InstanceViewPair(const QString& instanceName, const QString& viewName); /*! * The struct constructor * - * @param [in] instanceName The name for the component instance. + * @param [in] instanceName The name for the component instance. */ InstanceViewPair(const QString& instanceName); /*! * Operator == * - * @param [in] other Reference to the InstanceViewPair to compare to. + * @param [in] other Reference to the InstanceViewPair to compare to. * - * @return bool True if the component instance names are the same. + * @return bool True if the component instance names are the same. */ bool operator==(const InstanceViewPair& other) const; /*! * Operator != * - * @param [in] other Reference to the InstanceViewPair to compare to. + * @param [in] other Reference to the InstanceViewPair to compare to. * - * @return bool True if the component instance names are different. + * @return bool True if the component instance names are different. */ bool operator!=(const InstanceViewPair& other); }; @@ -212,8 +212,8 @@ public slots: /*! * Change the active view from the selected view configuration. * - * @param [in] instanceName The name of the selected component instance. - * @param [in] newViewName The new active view. + * @param [in] instanceName The name of the selected component instance. + * @param [in] newViewName The new active view. */ void changeViewConfiguration(QString const& instanceName, QString const& newViewName); diff --git a/editors/common/ConfigurationEditor/configurationeditor.h b/editors/common/ConfigurationEditor/configurationeditor.h index ec3cc0c8c..7a40e7e9e 100644 --- a/editors/common/ConfigurationEditor/configurationeditor.h +++ b/editors/common/ConfigurationEditor/configurationeditor.h @@ -41,8 +41,8 @@ class ConfigurationEditor : public QWidget /*! * The constructor. * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this widget. */ ConfigurationEditor(LibraryInterface* handler, QWidget *parent); @@ -58,7 +58,7 @@ class ConfigurationEditor : public QWidget /*! * Set the configuration to be displayed. * - * @param [in] designWidget The design widget used to edit the design. + * @param [in] designWidget The design widget used to edit the design. */ void setConfiguration(DesignWidget* designWidget); @@ -92,7 +92,7 @@ private slots: /*! * Called when user changes the current configuration. * - * @param [in] newConfigName The name of the new configuration to display. + * @param [in] newConfigName The name of the new configuration to display. */ void onConfigurationChanged(QString const& newConfigName); @@ -101,23 +101,23 @@ private slots: /*! * Finds the view names possible for the current design. * - * @return The possible view names. + * @return The possible view names. */ QStringList findPossibleViews(); /*! * Creates a new design configuration and saves it in the library. * - * @param [in] dialog The dialog containing the configuration details. + * @param [in] dialog The dialog containing the configuration details. */ void createAndSaveConfiguration(CreateConfigurationDialog const& dialog); /*! * Creates a reference to the configuration in the top component. * - * @param [in] configurationVLNV The VLNV of the configuration. - * @param [in] viewName The name of the view referencing the configuration. - * @param [in] designImplementation The implementation type of the design. + * @param [in] configurationVLNV The VLNV of the configuration. + * @param [in] viewName The name of the view referencing the configuration. + * @param [in] designImplementation The implementation type of the design. */ void createTopLevelReferenceToConfiguration(VLNV const& configurationVLNV, QString const& viewName, const KactusAttribute::Implementation designImplementation); @@ -136,21 +136,21 @@ private slots: /*! * Remove design and design configuration instantiation references from the selected view. * - * @param [in] viewName The name of the selected view. + * @param [in] viewName The name of the selected view. */ void removeViewHierarchicalInstantiationRefs(QString const& viewName) const; /*! * Remove a view from component. * - * @param [in] viewName The name of the view being removed. + * @param [in] viewName The name of the view being removed. */ void removeViewFromComponent(QString const& viewName) const; /*! * Remove a system view from component. * - * @param [in] viewName The name of the system view being removed. + * @param [in] viewName The name of the system view being removed. */ void removeSystemViewFromComponent(QString const& viewName) const; diff --git a/editors/common/ConnectionEditor/AdHocBoundsModel.h b/editors/common/ConnectionEditor/AdHocBoundsModel.h index dcecb51ed..9f97ff3c4 100644 --- a/editors/common/ConnectionEditor/AdHocBoundsModel.h +++ b/editors/common/ConnectionEditor/AdHocBoundsModel.h @@ -32,8 +32,8 @@ class AdHocBoundsModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] editProvider The edit provider managing the undo/redo stack. - * @param [in] parent The owner of this model. + * @param [in] editProvider The edit provider managing the undo/redo stack. + * @param [in] parent The owner of this model. */ AdHocBoundsModel(QObject *parent); @@ -43,67 +43,67 @@ class AdHocBoundsModel : public QAbstractTableModel /*! * Sets the ad-hoc connection being edited. * - * @param [in] connection The connection. - * @param [in] editProvider The edit provider for undo/redo. + * @param [in] connection The connection. + * @param [in] editProvider The edit provider for undo/redo. */ void setConnection(QSharedPointer connection, QSharedPointer editProvider); /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. + * @param [in] parent Model index of the parent of the item. * - * @return Number of columns currently in the model. + * @return Number of columns currently in the model. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return The data in the requested index. + * @return The data in the requested index. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return The data to be displayed. + * @return The data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. * - * @return True if data was successfully set, otherwise false. + * @return True if data was successfully set, otherwise false. */ virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole); /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const; @@ -120,16 +120,16 @@ class AdHocBoundsModel : public QAbstractTableModel /*! * Finds the number of endpoint in the ad-hoc connection. * - * @return The number of endpoints defined in the connection. + * @return The number of endpoints defined in the connection. */ int getEndpointCount() const; /*! * Gets the port reference on the given row. * - * @param [in] row The row to find. + * @param [in] row The row to find. * - * @return The port reference on the given row. + * @return The port reference on the given row. */ QSharedPointer getEndpoint(int row) const; diff --git a/editors/common/ConnectionEditor/connectioneditor.h b/editors/common/ConnectionEditor/connectioneditor.h index 34ffd5f2e..10431a13e 100644 --- a/editors/common/ConnectionEditor/connectioneditor.h +++ b/editors/common/ConnectionEditor/connectioneditor.h @@ -50,8 +50,8 @@ class ConnectionEditor : public QWidget /*! The constructor * - * @param [in] library The instance that manages the library - * @param [in] parent The owner of this editor. + * @param [in] library The instance that manages the library + * @param [in] parent The owner of this editor. * */ ConnectionEditor(LibraryInterface* library, QWidget* parent); @@ -63,7 +63,7 @@ public slots: /*! Set the connection to be edited. * - * @param [in] connection The connection to edit. + * @param [in] connection The connection to edit. * */ void setConnection(GraphicsConnection* connection, DesignDiagram* diagram); @@ -93,10 +93,10 @@ private slots: /*! * Finds the VLNV for the bus abstraction. * - * @param [in] endPoint The selected bus interface end point. - * @param [in] busInterface The bus interface whose abstraction definition VLNV to find. + * @param [in] endPoint The selected bus interface end point. + * @param [in] busInterface The bus interface whose abstraction definition VLNV to find. * - * @return The VLNV for the given bus interface abstraction definition. + * @return The VLNV for the given bus interface abstraction definition. */ VLNV findAbstractionVLNV(ConnectionEndpoint* endPoint, QSharedPointer busInterface) const; @@ -109,22 +109,22 @@ private slots: /*! * Finds the names of all logical ports mapped in the given port maps. * - * @param [in] portMaps1 Port maps for first interface. - * @param [in] portMaps2 Port maps for second interface. + * @param [in] portMaps1 Port maps for first interface. + * @param [in] portMaps2 Port maps for second interface. * - * @return The names of all logical ports. + * @return The names of all logical ports. */ QStringList getAllLogicalPorts(QList > const& portMaps1, QList > const& portMaps2) const; /*! Add a mapping for physical ports to port widget for two given port maps. * - * @param [in/out] row The row to insert the physical map to. - * @param [in] invalid Defines if this map is already been declared as invalid. - * @param [in] portMap1 The first port map. - * @param [in] component1 The component that contains the port map1. - * @param [in] portMap2 The second port map. - * @param [in] component2 The component that contains the port map2. + * @param [in/out] row The row to insert the physical map to. + * @param [in] invalid Defines if this map is already been declared as invalid. + * @param [in] portMap1 The first port map. + * @param [in] component1 The component that contains the port map1. + * @param [in] portMap2 The second port map. + * @param [in] component2 The component that contains the port map2. * */ void addMap(QSharedPointer portMap1, QSharedPointer component1, @@ -134,23 +134,23 @@ private slots: /*! * Creates an item for the port connectivity table. * - * @param [in] portName The name of the port. - * @param [in] left The left bound of the port. - * @param [in] right The right bound of the port. - * @param [in] isValid Is the port connectivity valid or not. + * @param [in] portName The name of the port. + * @param [in] left The left bound of the port. + * @param [in] right The right bound of the port. + * @param [in] isValid Is the port connectivity valid or not. * - * @return Item for the port connectivity table representing the given port. + * @return Item for the port connectivity table representing the given port. */ QTableWidgetItem* createPortItem(QString const& portName, int left, int right, bool isValid); /*! * Calculate mapped physical port bounds. * - * @param [in] parser The used expression parser. - * @param [in] containingPortMap The port map containing the mapped physical port. - * @param [in] containingComponent The component containing the physical port. + * @param [in] parser The used expression parser. + * @param [in] containingPortMap The port map containing the mapped physical port. + * @param [in] containingComponent The component containing the physical port. * - * @return Integer pair, where the first is the left bound, and the second is the right bound. + * @return Integer pair, where the first is the left bound, and the second is the right bound. */ QPair calculateMappedPhysicalPortBounds(QSharedPointer parser, QSharedPointer containingPortMap, QSharedPointer containingComponent); @@ -158,11 +158,11 @@ private slots: /*! * Check if the mapped physical port is not valid. * - * @param [in] invalid The current validity of the connection. - * @param [in] containingPortMap Port map containing the physical port. - * @param [in] containingComponent Component containing the referenced physical port. + * @param [in] invalid The current validity of the connection. + * @param [in] containingPortMap Port map containing the physical port. + * @param [in] containingComponent Component containing the referenced physical port. * - * @return True, if the physical port is not valid, otherwise false. + * @return True, if the physical port is not valid, otherwise false. */ bool isValidPhysicalPort (QSharedPointer containingPortMap, QSharedPointer containingComponent); @@ -170,10 +170,10 @@ private slots: /*! * Calculate the mapped logical port bounds. * - * @param [in] parser The used expression parser. - * @param [in] containingPortMap The port map containing the logical port. + * @param [in] parser The used expression parser. + * @param [in] containingPortMap The port map containing the logical port. * - * @return Integer pair, where the first value is the higher bound and the second value is the lower bound. + * @return Integer pair, where the first value is the higher bound and the second value is the lower bound. */ QPair calculateMappedLogicalPortBounds(QSharedPointer parser, QSharedPointer containingPortMap); @@ -186,10 +186,10 @@ private slots: /*! * Get the port maps for the selected bus interface end point. * - * @param [in] endPoint The selected end point. - * @param [in] busInterface The bus interface contained within the selected end point. + * @param [in] endPoint The selected end point. + * @param [in] busInterface The bus interface contained within the selected end point. * - * @return A list of port maps contained within the selected end point + * @return A list of port maps contained within the selected end point */ QList > getPortMapsForEndPoint(ConnectionEndpoint* endPoint, QSharedPointer busInterface) const; @@ -197,9 +197,9 @@ private slots: /*! * Get the active view for the item containing the selected end point item. * - * @param [in] endPoint The selected end point. + * @param [in] endPoint The selected end point. * - * @return The name of the active view containing the selected end point item. + * @return The name of the active view containing the selected end point item. */ QString getActiveViewForEndPoint(ConnectionEndpoint* endPoint) const; diff --git a/editors/common/DesignCompletionModel.h b/editors/common/DesignCompletionModel.h index 341dacfb7..e4c366950 100644 --- a/editors/common/DesignCompletionModel.h +++ b/editors/common/DesignCompletionModel.h @@ -29,9 +29,9 @@ class DesignCompletionModel : public ComponentParameterModel /*! * The constructor. * - * @param [in] topComponentFinder Finder for top component parameters. - * @param [in] parameterFinder Finder for all available parameters. - * @param [in] parent The parent object. + * @param [in] topComponentFinder Finder for top component parameters. + * @param [in] parameterFinder Finder for all available parameters. + * @param [in] parent The parent object. */ DesignCompletionModel(QSharedPointer topComponentFinder, QSharedPointer parameterFinder, QObject *parent); @@ -42,10 +42,10 @@ class DesignCompletionModel : public ComponentParameterModel /*! * Finds the data in the model for the given index. * - * @param [in] index The index whose data to find. - * @param [in] role The role describing which aspect of the data to find. + * @param [in] index The index whose data to find. + * @param [in] role The role describing which aspect of the data to find. * - * @return The data in the given index. + * @return The data in the given index. */ virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; diff --git a/editors/common/DesignDiagram.h b/editors/common/DesignDiagram.h index f97948cd3..f4b9a4e8c 100644 --- a/editors/common/DesignDiagram.h +++ b/editors/common/DesignDiagram.h @@ -56,9 +56,9 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Constructor. * - * @param [in] lh The library interface. - * @param [in] editProvider The edit provider. - * @param [in] parent The parent widget. + * @param [in] lh The library interface. + * @param [in] editProvider The edit provider. + * @param [in] parent The parent widget. */ DesignDiagram(LibraryInterface* lh, QSharedPointer editProvider, DesignWidget* parent = 0); @@ -75,10 +75,10 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Opens a design for editing. * - * @param [in] component The component whose design to edit. - * @param [in] selectedView The selected view of the top component. - * @param [in] design The design to edit. - * @param [in] designConf The design configuration if one exists. + * @param [in] component The component whose design to edit. + * @param [in] selectedView The selected view of the top component. + * @param [in] design The design to edit. + * @param [in] designConf The design configuration if one exists. */ bool setDesign(QSharedPointer component, QString const& selectedView, QSharedPointer design, QSharedPointer designConf = QSharedPointer()); @@ -109,7 +109,7 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Adds an instance name to the list of used instance names. * - * @param [in] name The name of the instance. + * @param [in] name The name of the instance. * * @remarks This function should be called when a component instance is added to the diagram. */ @@ -118,7 +118,7 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Removes the instance name from the list so the name can be used again in the design. * - * @param name The name of the removed instance. + * @param name The name of the removed instance. * * @remarks This function should be called when user removes component instance. */ @@ -127,37 +127,37 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Updates the list of instance names. * - * @param oldName The old name of the component instance. - * @param newName The new name of the component instance. + * @param oldName The old name of the component instance. + * @param newName The new name of the component instance. */ void updateInstanceName(const QString& oldName, const QString& newName); /*! * Changes the state of a visibility control. * - * @param [in] name The name of the visibility control. - * @param [in] state The new state for the visibility control. + * @param [in] name The name of the visibility control. + * @param [in] state The new state for the visibility control. */ virtual void setVisibilityControlState(QString const& name, bool state); /*! * Sets the draw mode of the diagram. * - * @param [in] mode The draw mode. + * @param [in] mode The draw mode. */ virtual void setMode(DrawMode mode); /*! * Sets the block diagram locked/unlocked. * - * @param [in] locked If true, the diagram is locked. Otherwise it is unlocked. + * @param [in] locked If true, the diagram is locked. Otherwise it is unlocked. */ void setProtection(bool locked); /*! * Adds a column to the diagram's layout. * - * @param [in] desc The column description. + * @param [in] desc The column description. */ virtual void addColumn(QSharedPointer desc) = 0; @@ -214,14 +214,14 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Ensures that all items in a given list have the same type. Items with different type are unselected. * - * @param [in] items The list to check. + * @param [in] items The list to check. */ void ensureOneTypeSelected(QList const& items); /*! * Returns the type of the given items if they all are of the same type. * - * @return The common type, or -1 if the items are of different type. + * @return The common type, or -1 if the items are of different type. */ static int getCommonItemType(QList const& items); @@ -233,21 +233,21 @@ class DesignDiagram : public QGraphicsScene, public AdHocEnabled /*! * Gets the graphics column layout of the design. * - * @return The column layout of the design. + * @return The column layout of the design. */ QSharedPointer getLayout() const; /*! * Creates a unique instance name with the given base name. * - * @param [in] baseName The base name for the instance. + * @param [in] baseName The base name for the instance. */ QString createInstanceName(QString const& baseName); /*! * Get the currently active top component view. * - * @return The currently active top component view. + * @return The currently active top component view. */ QString getTopView() const; @@ -278,14 +278,14 @@ public slots: /*! * Called when an association creation is requested. * - * @param [in] startingPoint The item requesting the new association. + * @param [in] startingPoint The item requesting the new association. */ void onBeginAssociation(Associable* startingPoint); /*! * Called when an item has been modified. * - * @param [in] undoCommand The undo command to undo/redo the modification. + * @param [in] undoCommand The undo command to undo/redo the modification. */ void onItemModified(QUndoCommand* undoCommand); @@ -350,9 +350,9 @@ public slots: /*! * Picks the top-most component at the given position. * - * @param [in] pos The picking positions. + * @param [in] pos The picking positions. * - * @return The top-most component at the given positions, or 0 if there is no component. + * @return The top-most component at the given positions, or 0 if there is no component. */ ComponentItem* getTopmostComponent(QPointF const& pos); @@ -362,39 +362,39 @@ public slots: * This fixes the problem when the user click above a text label or a pixmap but * actually wants to select the parent item (such as the actual component, not its label). * - * @param [in] item The item whose base item to find. + * @param [in] item The item whose base item to find. * - * @return The bottom-most item. + * @return The bottom-most item. */ QGraphicsItem* getBaseItemOf(QGraphicsItem* item) const; /*! * Adds a new note to the design. * - * @param [in] position The initial position of the note. + * @param [in] position The initial position of the note. */ virtual void createNoteAt(QPointF const& position); /*! * Called when an item has been selected in the diagram. * - * @param [in] newSelection The selected item. + * @param [in] newSelection The selected item. */ virtual void onSelected(QGraphicsItem* newSelection) = 0; /*! * Creates the context menu for function contextMenuEvent(). * - * @param [in] pos Mouse position when the menu is requested. + * @param [in] pos Mouse position when the menu is requested. * - * @return The menu with allowed actions or 0 if no menu is allowed. + * @return The menu with allowed actions or 0 if no menu is allowed. */ virtual QMenu* createContextMenu(QPointF const& pos); /*! * Event handler for receiving context menu events (e.g. right mouse click). * - * @param [in] event The triggering event. + * @param [in] event The triggering event. */ virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent* event); @@ -403,14 +403,14 @@ public slots: /*! * Updates the association line. * - * @param [in] cursorPosition The current cursor position which becomes the ending point for the line. + * @param [in] cursorPosition The current cursor position which becomes the ending point for the line. */ void updateAssociationLineDraw(QPointF const& cursorPosition); /*! * Ends the creation of a new association. * - * @param [in] endpoint The ending point of the association. + * @param [in] endpoint The ending point of the association. */ void endAssociation(QPointF const& endpoint); @@ -420,20 +420,20 @@ public slots: /*! * Checks if two items can be associated with each other. * - * @param [in] startItem The first item. - * @param [in] endItem The second item. + * @param [in] startItem The first item. + * @param [in] endItem The second item. * - * @return True, if the items can be associated, otherwise false. + * @return True, if the items can be associated, otherwise false. */ bool canAssociateItems(Associable* startItem, Associable* endItem); /*! * Creates a command for adding an association to the diagram. * - * @param [in] startItem The item at the starting end of the association. - * @param [in] endPointExtension The vendor extension describing the ending point position. + * @param [in] startItem The item at the starting end of the association. + * @param [in] endPointExtension The vendor extension describing the ending point position. * - * @return A command for creating an association. + * @return A command for creating an association. */ QSharedPointer createAssociationAddCommand(Associable* startItem, QSharedPointer endPointExtension); @@ -441,35 +441,35 @@ public slots: /*! * Checks if the user is currently creating a new association. * - * @return True, if an association is being created, otherwise false. + * @return True, if an association is being created, otherwise false. */ bool inAssociationMode() const; /*! * Checks if the association can end. * - * @return True, if an association can end, otherwise false. + * @return True, if an association can end, otherwise false. */ bool canEndAssociation() const; /*! * Checks if context menu can be displayed. * - * @return True, if context menu can be displayed, otherwise false. + * @return True, if context menu can be displayed, otherwise false. */ bool contextMenuEnabled() const; /*! * Checks if the user is currently replacing a component. * - * @return True, if a replace is in progress, otherwise false. + * @return True, if a replace is in progress, otherwise false. */ bool inReplaceMode() const; /*! * Checks if the user is currently creating connections in off page mode. * - * @return True, if off page mode is set, otherwise false. + * @return True, if off page mode is set, otherwise false. */ bool inOffPageMode() const; @@ -484,7 +484,7 @@ public slots: /*! * Sets the interaction mode. * - * @param [in] mode The mode to set. + * @param [in] mode The mode to set. * */ void setInteractionMode(interactionMode mode); @@ -500,7 +500,7 @@ public slots: /*! * Opens the given design for editing. * - * @param [in] design The design to open. + * @param [in] design The design to open. */ virtual void loadDesign(QSharedPointer design) = 0; @@ -516,16 +516,16 @@ public slots: /*! * Creates a command for adding a sticky note to the diagram. * - * @param [in] note The note for which to create the command for. + * @param [in] note The note for which to create the command for. * - * @return The command for adding the note to diagram. + * @return The command for adding the note to diagram. */ QSharedPointer createNoteAddCommand(StickyNote* note); /*! * Loads the associations from a sticky not from a vendor extension. * - * @param [in] note The note for whose associations to load. + * @param [in] note The note for whose associations to load. */ void loadNoteAssociations(StickyNote* note); @@ -535,7 +535,7 @@ public slots: /*! * Get the names of the contained component instances. * - * @return A list of instance names of the contained component instances. + * @return A list of instance names of the contained component instances. */ virtual QStringList getUsedInstanceNames() const; diff --git a/editors/common/DesignDiagramResolver.h b/editors/common/DesignDiagramResolver.h index 7e3f1e3b6..130c11228 100644 --- a/editors/common/DesignDiagramResolver.h +++ b/editors/common/DesignDiagramResolver.h @@ -35,7 +35,7 @@ class DesignDiagramResolver /*! * The constructor. * - * @param [in] designParameterFinder Locates the design parameters. + * @param [in] designParameterFinder Locates the design parameters. */ DesignDiagramResolver(QSharedPointer designParameterFinder); @@ -53,8 +53,8 @@ class DesignDiagramResolver /*! * Resolve and draw a symbol for tie off in an ad hoc port item. * - * @param [in] tieOff The tie off of the selected port. - * @param [in] tieOffPort The selected port item. + * @param [in] tieOff The tie off of the selected port. + * @param [in] tieOffPort The selected port item. */ void resolveAdhocTieOff(QString const& tieOff, AdHocItem* tieOffPort); @@ -64,11 +64,11 @@ class DesignDiagramResolver /*! * Get the parsed value from a tie off value. * - * @param [in] tieOffValue The unparsed tie off value. - * @param [in] portName The ad hoc port name. - * @param [in] ownerComponent The encompassing component of the ad hoc port containing the tie off value. + * @param [in] tieOffValue The unparsed tie off value. + * @param [in] portName The ad hoc port name. + * @param [in] ownerComponent The encompassing component of the ad hoc port containing the tie off value. * - * @return Parsed tie off value. + * @return Parsed tie off value. */ QString getParsedTieOffValue(QString const& tieOffValue, QString const& portName, QSharedPointer ownerComponent) const; diff --git a/editors/common/DesignParameterReferenceTree/DesignParameterReferenceCounter.h b/editors/common/DesignParameterReferenceTree/DesignParameterReferenceCounter.h index dff5e9fa6..165957386 100644 --- a/editors/common/DesignParameterReferenceTree/DesignParameterReferenceCounter.h +++ b/editors/common/DesignParameterReferenceTree/DesignParameterReferenceCounter.h @@ -35,7 +35,7 @@ class DesignParameterReferenceCounter : public ParameterReferenceCounter /*! * The constructor. * - * @param [in] parameterFinder Locates the parameters for increasing and decreasing references. + * @param [in] parameterFinder Locates the parameters for increasing and decreasing references. */ DesignParameterReferenceCounter(QSharedPointer parameterFinder); @@ -47,26 +47,26 @@ class DesignParameterReferenceCounter : public ParameterReferenceCounter /*! * Set a new design for the reference counter. * - * @param [in] newDesign The selected design. + * @param [in] newDesign The selected design. */ void setDesign(QSharedPointer newDesign); /*! * Count the number of references made to the selected parameter in the contained component instances. * - * @param [in] parameterID ID of the selected parameter. + * @param [in] parameterID ID of the selected parameter. * - * @return The number of references made to the selected parameter in the contained component instances. + * @return The number of references made to the selected parameter in the contained component instances. */ int countReferencesInComponentInstances(QString const& parameterID) const; /*! * Count the number of references made to the selected parameter in a single component instance. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] instance The selected component instance. + * @param [in] parameterID ID of the selected parameter. + * @param [in] instance The selected component instance. * - * @return The number of references made to the selected parameter in the selected component instance. + * @return The number of references made to the selected parameter in the selected component instance. */ int countReferencesInSingleComponentInstance(QString const& parameterID, QSharedPointer instance) const; @@ -74,10 +74,10 @@ class DesignParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the number of references made to the selected parameter in the ad hoc connections. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] connections The selected ad hoc connections. + * @param [in] parameterID ID of the selected parameter. + * @param [in] connections The selected ad hoc connections. * - * @return The number of references made to the selected parameter in the ad hoc connections. + * @return The number of references made to the selected parameter in the ad hoc connections. */ int countReferencesInAdHocConnections(QString const& parameterID, QSharedPointer > > connections) const; @@ -85,10 +85,10 @@ class DesignParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the number of references made to the selected parameter in a single ad hoc connection. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] connection The selected ad hoc connection. + * @param [in] parameterID ID of the selected parameter. + * @param [in] connection The selected ad hoc connection. * - * @return The number of references made to the selected parameter in the selected ad hoc connection. + * @return The number of references made to the selected parameter in the selected ad hoc connection. */ int countReferencesInSingleAdHocConnection(QString const& parameterID, QSharedPointer connection) const; @@ -96,10 +96,10 @@ class DesignParameterReferenceCounter : public ParameterReferenceCounter /*! * Count the number of references made to the selected parameter in a single part select. * - * @param [in] parameterID ID of the selected parameter. - * @param [in] partSelect The selected part select. + * @param [in] parameterID ID of the selected parameter. + * @param [in] partSelect The selected part select. * - * @return The number of references made to the selected parameter in the selected part select. + * @return The number of references made to the selected parameter in the selected part select. */ int countReferencesInPartSelect(QString const& parameterID, QSharedPointer partSelect) const; @@ -108,8 +108,8 @@ public slots: /*! * Recalculate references made to the selected parameters. * - * @param [in] parameterList The selected parameters. - * @param [in] parameterInterface Interface for accessing parameters. + * @param [in] parameterList The selected parameters. + * @param [in] parameterInterface Interface for accessing parameters. */ virtual void recalculateReferencesToParameters(QVector const& parameterList, AbstractParameterInterface* parameterInterface); diff --git a/editors/common/DesignParameterReferenceTree/DesignParameterReferenceTree.h b/editors/common/DesignParameterReferenceTree/DesignParameterReferenceTree.h index 663882e25..06035d57d 100644 --- a/editors/common/DesignParameterReferenceTree/DesignParameterReferenceTree.h +++ b/editors/common/DesignParameterReferenceTree/DesignParameterReferenceTree.h @@ -34,9 +34,9 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * The constructor. * - * @param [in] formatter Formatter for expressions. - * @param [in] referenceCounter Calculates parameter references. - * @param [in] parent The parent widget. + * @param [in] formatter Formatter for expressions. + * @param [in] referenceCounter Calculates parameter references. + * @param [in] parent The parent widget. */ DesignParameterReferenceTree(QSharedPointer formatter, QSharedPointer referenceCounter, QWidget* parent = 0); @@ -49,7 +49,7 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Set a new design containing the referable parameters. * - * @param [in] newDesign The selected design. + * @param [in] newDesign The selected design. */ void setDesign(QSharedPointer newDesign); @@ -67,7 +67,7 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Get the used parameter reference counter. * - * @return The design parameter reference calculator. + * @return The design parameter reference calculator. */ QSharedPointer getReferenceCounter() const; @@ -79,8 +79,8 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Create reference items for a single component instance. * - * @param [in] instance The selected component instance. - * @param [in] instancesItem The parent item for the component instance item. + * @param [in] instance The selected component instance. + * @param [in] instancesItem The parent item for the component instance item. */ void createReferencesForSingleComponentInstance(QSharedPointer instance, QTreeWidgetItem* instancesItem); @@ -93,9 +93,9 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Get the ad hoc connections in order of their referenced components. * - * @param [in] topComponentName Identifier for the top component. + * @param [in] topComponentName Identifier for the top component. * - * @return Map containing the name of the referenced component and ad hoc connections. + * @return Map containing the name of the referenced component and ad hoc connections. */ QMultiMap > getAdHocConnectionsInComponentOrder( QString const& topComponentName) const; @@ -103,10 +103,10 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Create ad hoc connection reference items for a single component instance. * - * @param [in] componentName Name of the selected component instance - * @param [in] connections List of all the ad hoc connections with ports referencing the selected + * @param [in] componentName Name of the selected component instance + * @param [in] connections List of all the ad hoc connections with ports referencing the selected * component. - * @param [in] connectionsItem The parent item for the component item. + * @param [in] connectionsItem The parent item for the component item. */ void createAdHocItemsForComponent(QString const& componentName, QSharedPointer > > connections, QTreeWidgetItem* connectionsItem); @@ -114,8 +114,8 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Create reference items for a single ad hoc connection. * - * @param [in] connection The selected ad hoc connection. - * @param [in] componentItem The parent item for the ad hoc connection item. + * @param [in] connection The selected ad hoc connection. + * @param [in] componentItem The parent item for the ad hoc connection item. */ void createReferencesForSingleAdHocConnection(QSharedPointer connection, QTreeWidgetItem* componentItem); @@ -123,9 +123,9 @@ class DesignParameterReferenceTree : public ParameterReferenceTree /*! * Get the port for the tied value bounds. * - * @param [in] connection Ad hoc connection containing the tied value. + * @param [in] connection Ad hoc connection containing the tied value. * - * @return The ad hoc port containing the tied value bounds. + * @return The ad hoc port containing the tied value bounds. */ QSharedPointer getTiedValuePort(QSharedPointer connection) const; diff --git a/editors/common/DesignWidget.h b/editors/common/DesignWidget.h index f6767bb61..e959424a0 100644 --- a/editors/common/DesignWidget.h +++ b/editors/common/DesignWidget.h @@ -64,18 +64,18 @@ class DesignWidget : public TabDocument /*! * Sets a design to be displayed in the design diagram. * - * @param [in] vlnv The VLNV of the top-level component. - * @param [in] viewName The name of the view to open. + * @param [in] vlnv The VLNV of the top-level component. + * @param [in] viewName The name of the view to open. * - * @return False if there were errors opening the design; otherwise true. + * @return False if there were errors opening the design; otherwise true. */ virtual bool setDesign(VLNV const& vlnv, QString const& viewName) = 0; /*! * Changes the state of a visibility control. * - * @param [in] name The name of the visibility control. - * @param [in] state The new state for the visibility control. + * @param [in] name The name of the visibility control. + * @param [in] state The new state for the visibility control. */ virtual void setVisibilityControlState(QString const& name, bool state); @@ -97,7 +97,7 @@ class DesignWidget : public TabDocument /*! * Sets the zoom level of the design. * - * @param [in] level The zoom level in percents. + * @param [in] level The zoom level in percents. */ virtual void setZoomLevel(int level); @@ -109,21 +109,21 @@ class DesignWidget : public TabDocument /*! * Sets the draw mode of the design. * - * @param [in] mode The draw mode. + * @param [in] mode The draw mode. */ virtual void setMode(DrawMode mode); /*! * Sets the protection state of the document. * - * @param [in] locked True for locked state; false for unlocked. + * @param [in] locked True for locked state; false for unlocked. */ virtual void setProtection(bool locked); /*! * Sets the edited component. * - * @param [in] component The component to set as the edited one. + * @param [in] component The component to set as the edited one. */ void setEditedComponent(QSharedPointer component); @@ -155,7 +155,7 @@ class DesignWidget : public TabDocument /*! * Returns the edit provider. * - * @return Base class implementation returns null. + * @return Base class implementation returns null. * * @remarks Edit support should be queried with getFlags(). */ @@ -174,7 +174,7 @@ class DesignWidget : public TabDocument /*! * Centers the current view to a point. * - * @param [in] centerPoint The point to center to. + * @param [in] centerPoint The point to center to. */ void centerViewTo(QPointF const& centerPoint); diff --git a/editors/common/DesignWidgetFactoryImplementation.h b/editors/common/DesignWidgetFactoryImplementation.h index fc73f094d..0ae9ea6ea 100644 --- a/editors/common/DesignWidgetFactoryImplementation.h +++ b/editors/common/DesignWidgetFactoryImplementation.h @@ -31,9 +31,9 @@ class DesignWidgetFactoryImplementation : public DesignWidgetFactory /*! * Constructor. * - * @param [in] libInterface Enables access to the library. - * @param [in] designAndInstanceParameterFinder Parameter finder for design parameter reference tree. - * @param [in] designParameterFinder Locates the design parameters. + * @param [in] libInterface Enables access to the library. + * @param [in] designAndInstanceParameterFinder Parameter finder for design parameter reference tree. + * @param [in] designParameterFinder Locates the design parameters. */ DesignWidgetFactoryImplementation(LibraryInterface* libInterface, QSharedPointer designAndInstanceParameterFinder, diff --git a/editors/common/DiagramUtil.h b/editors/common/DiagramUtil.h index 641578dfe..88fbcf848 100644 --- a/editors/common/DiagramUtil.h +++ b/editors/common/DiagramUtil.h @@ -23,21 +23,21 @@ namespace DiagramUtil /*! * Calculates the squared distance from a point to a bounding rectangle. * - * @param [in] pt The point. - * @param [in] rect The bounding rectangle. + * @param [in] pt The point. + * @param [in] rect The bounding rectangle. * - * @return The squared distance. + * @return The squared distance. */ inline qreal getSqDistance(QPointF const& pt, QRectF const& rect); /*! * Snaps the given position to a scene item if it is close enough the position. * - * @param [in] pos The position against which to snap. - * @param [in] scene The scene whose items are investigated. - * @param [in] snapDistance The snap distance. + * @param [in] pos The position against which to snap. + * @param [in] scene The scene whose items are investigated. + * @param [in] snapDistance The snap distance. * - * @return The snapped item. If null, there was no item close enough + * @return The snapped item. If null, there was no item close enough * to the given position. */ template @@ -46,8 +46,8 @@ namespace DiagramUtil /*! * Clamps the given value to the closest ceil of the given resolution. * - * @param [in] value The value to be clamped. - * @param [in] resolution The clamping resolution. + * @param [in] value The value to be clamped. + * @param [in] resolution The clamping resolution. */ inline int clampCeil(int value, int resolution); } diff --git a/editors/common/DocumentNameGroupEditor.h b/editors/common/DocumentNameGroupEditor.h index 57bc7d0cd..b4dc5e997 100644 --- a/editors/common/DocumentNameGroupEditor.h +++ b/editors/common/DocumentNameGroupEditor.h @@ -35,8 +35,8 @@ class DocumentNameGroupEditor : public QGroupBox /*! * The constructor. * - * @param [in] library Interface to the library. - * @param [in] parent The owner of this widget. + * @param [in] library Interface to the library. + * @param [in] parent The owner of this widget. */ DocumentNameGroupEditor(QWidget *parent = nullptr); @@ -52,15 +52,15 @@ class DocumentNameGroupEditor : public QGroupBox /*! * Sets the document name group information of a document. * - * @param [in] document The document whose information is set. - * @param [in] documentPath The path to the document. + * @param [in] document The document whose information is set. + * @param [in] documentPath The path to the document. */ void setDocumentNameGroup(QSharedPointer document, QString const& documentPath); /*! * Set a placeholder text for description editor. * - * @param [in] placeholder The placeholder text to set. + * @param [in] placeholder The placeholder text to set. */ void setPlaceholderDescription(QString const& placeholder); diff --git a/editors/common/GraphicsItemLabel.h b/editors/common/GraphicsItemLabel.h index 605e9365d..60e5ec54d 100644 --- a/editors/common/GraphicsItemLabel.h +++ b/editors/common/GraphicsItemLabel.h @@ -25,8 +25,8 @@ class GraphicsItemLabel : public QGraphicsProxyWidget /*! * Constructor. * - * @param [in] text Text for the label. - * @param [in] parent Parent item of the label. + * @param [in] text Text for the label. + * @param [in] parent Parent item of the label. */ GraphicsItemLabel(QString const& text, QGraphicsItem* parent = 0); @@ -38,14 +38,14 @@ class GraphicsItemLabel : public QGraphicsProxyWidget /*! * Set a new text string for the label. * - * @param [in] newText The selected text string. + * @param [in] newText The selected text string. */ void setText(QString const& newText); /*! * Get the current text string of the label. * - * @return The current text string of the label. + * @return The current text string of the label. */ QString getText() const; @@ -59,7 +59,7 @@ class GraphicsItemLabel : public QGraphicsProxyWidget /*! * Handle hover move event. * - * @param [in] event the event being processed. + * @param [in] event the event being processed. * * @remarks The function is reimplemented in order to fix the bug. * The bug was lock on certain type of cursor after hovering diff --git a/editors/common/ImageExporter.h b/editors/common/ImageExporter.h index 4981eb4d5..b0e8bc294 100644 --- a/editors/common/ImageExporter.h +++ b/editors/common/ImageExporter.h @@ -25,10 +25,10 @@ namespace ImageExporter /*! * Export an image of the selected document. * - * @param [in] libraryPath Library path of the selected document. - * @param [in] identifyingVLNV VLNV of the component containing the selected document. - * @param [in] scene Graphics scene of the selected document. - * @param [in] parent Parent item for determining the export path. + * @param [in] libraryPath Library path of the selected document. + * @param [in] identifyingVLNV VLNV of the component containing the selected document. + * @param [in] scene Graphics scene of the selected document. + * @param [in] parent Parent item for determining the export path. */ bool exportImage(QString const& libraryPath, VLNV const& identifyingVLNV, QGraphicsScene* scene, QWidget* parent); diff --git a/editors/common/InterfaceEditor/InterfacePortMapDelegate.h b/editors/common/InterfaceEditor/InterfacePortMapDelegate.h index 2456f5f5d..5f3c1718a 100644 --- a/editors/common/InterfaceEditor/InterfacePortMapDelegate.h +++ b/editors/common/InterfaceEditor/InterfacePortMapDelegate.h @@ -26,7 +26,7 @@ class InterfacePortMapDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] parent Pointer to the owner of this delegate. + * @param [in] parent Pointer to the owner of this delegate. */ InterfacePortMapDelegate(QObject *parent = 0); @@ -40,19 +40,19 @@ class InterfacePortMapDelegate : public QStyledItemDelegate /*! * Paint the editor. * - * @param [in] painter The used painter. - * @param [in] option The style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option The style options. + * @param [in] index The current index. */ void paint(QPainter *painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! * The editor events. * - * @param [in] event The event itself. - * @param [in] model The used item model. - * @param [in] option The style options. - * @param [in] index The current model index. + * @param [in] event The event itself. + * @param [in] model The used item model. + * @param [in] option The style options. + * @param [in] index The current model index. */ bool editorEvent(QEvent* event, QAbstractItemModel* model, QStyleOptionViewItem const& option, QModelIndex const& index); diff --git a/editors/common/InterfaceEditor/InterfacePortMapModel.h b/editors/common/InterfaceEditor/InterfacePortMapModel.h index 48e28aaea..a3638e111 100644 --- a/editors/common/InterfaceEditor/InterfacePortMapModel.h +++ b/editors/common/InterfaceEditor/InterfacePortMapModel.h @@ -38,8 +38,8 @@ class InterfacePortMapModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] handler The library handler. - * @param [in] parent Pointer to the owner of this model. + * @param [in] handler The library handler. + * @param [in] parent Pointer to the owner of this model. */ InterfacePortMapModel(LibraryInterface* library, QObject *parent); @@ -53,9 +53,9 @@ class InterfacePortMapModel : public QAbstractTableModel /*! * Sets the interface data source being edited. * - * @param [in] busItem The data source. - * @param [in] activeView The active view of the item containing the selected bus item.. - * @param [in] activeInterfaces A list of active interfaces containing a reference to the selected item. + * @param [in] busItem The data source. + * @param [in] activeView The active view of the item containing the selected bus item.. + * @param [in] activeInterfaces A list of active interfaces containing a reference to the selected item. */ void setInterfaceData(ConnectionEndpoint* busItem, QString const& activeView, QList > activeInterfaces); @@ -63,62 +63,62 @@ class InterfacePortMapModel : public QAbstractTableModel /*! * Returns the number of rows in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a * hierarchical model. * - * @return Number of rows currently in the model. + * @return Number of rows currently in the model. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the number of columns in the model. * - * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a + * @param [in] parent Model index of the parent of the item. Must be invalid because this is not a * hierarchical model. * - * @return Always returns 3. + * @return Always returns 3. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const; /*! * Returns the data for the specified item for specified role. * - * @param [in] index Identifies the item that's data is wanted. - * @param [in] role Specifies what kind of data is wanted + * @param [in] index Identifies the item that's data is wanted. + * @param [in] role Specifies what kind of data is wanted * - * @return QVariant containing the data. + * @return QVariant containing the data. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const; /*! * Returns the data for the headers. * - * @param [in] section The column that's header is wanted - * @param [in] orientation Only Qt::Horizontal is supported - * @param [in] role Specified the type of data that is wanted. + * @param [in] section The column that's header is wanted + * @param [in] orientation Only Qt::Horizontal is supported + * @param [in] role Specified the type of data that is wanted. * - * @return QVariant containing the data to be displayed. + * @return QVariant containing the data to be displayed. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Set the data for specified item. * - * @param [in] index Specifies the item that's data is modified - * @param [in] value The value to be set. - * @param [in] role The role that is trying to modify the data. Only Qt::EditRole + * @param [in] index Specifies the item that's data is modified + * @param [in] value The value to be set. + * @param [in] role The role that is trying to modify the data. Only Qt::EditRole * is supported. * - * @return True if data was successfully set. + * @return True if data was successfully set. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole); /*! * Returns information on how specified item can be handled. * - * @param [in] index Specifies the item that's flags are wanted. + * @param [in] index Specifies the item that's flags are wanted. * - * @return Qt::ItemFlags that define how object can be handled. + * @return Qt::ItemFlags that define how object can be handled. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; @@ -137,9 +137,9 @@ class InterfacePortMapModel : public QAbstractTableModel /*! * Check if a given port is excluded. * - * @param [in] portName Name of the selected port. + * @param [in] portName Name of the selected port. * - * @return True, if the selected port is excluded, otherwise false. + * @return True, if the selected port is excluded, otherwise false. */ bool portIsExcluded(QString const& portName) const; diff --git a/editors/common/InterfaceEditor/interfaceeditor.h b/editors/common/InterfaceEditor/interfaceeditor.h index 8b89997c1..5de710a19 100644 --- a/editors/common/InterfaceEditor/interfaceeditor.h +++ b/editors/common/InterfaceEditor/interfaceeditor.h @@ -47,8 +47,8 @@ class InterfaceEditor : public QStackedWidget /*! * The constructor. * - * @param [in] parent The owner of this widget. - * @param [in] handler The library handler. + * @param [in] parent The owner of this widget. + * @param [in] handler The library handler. */ InterfaceEditor(QWidget *parent, LibraryInterface* handler); @@ -58,10 +58,10 @@ class InterfaceEditor : public QStackedWidget /*! * Set the interface for the editor. * - * @param [in] interface The interface to edit. - * @param [in] containingDesign The design containing the end point. - * @param [in] configuration Design configuration of the design. - * @param [in] activeTopView The currently active top component view. + * @param [in] interface The interface to edit. + * @param [in] containingDesign The design containing the end point. + * @param [in] configuration Design configuration of the design. + * @param [in] activeTopView The currently active top component view. */ void setInterface(ConnectionEndpoint* interface, QSharedPointer containingDesign, QSharedPointer configuration, QString const& activeTopView, @@ -85,14 +85,14 @@ private slots: /*! * Handler for change in interface name. * - * @param [in] newName The new name of the interface. + * @param [in] newName The new name of the interface. */ void onInterfaceNameChanged(QString const& newName); /*! * Handler for change in interface mode. * - * @param [in] newMode The new mode of the interface. + * @param [in] newMode The new mode of the interface. */ void onInterfaceModeChanged(QString const& newMode); @@ -126,25 +126,25 @@ private slots: /*! * Sets the name and description of the interface to the given editors. * - * @param [in] nameEditor The name editor to use. - * @param [in] descriptionEditor The description editor to use. + * @param [in] nameEditor The name editor to use. + * @param [in] descriptionEditor The description editor to use. */ void setNameAndDescription(QLineEdit* nameEditor, QPlainTextEdit* descriptionEditor); /*! * Get a list of active interfaces referencing the selected interface. * - * @return A list of active interfaces referencing the selected interface. + * @return A list of active interfaces referencing the selected interface. */ QList > getActiveInterfaces() const; /*! * Check if the selected active interface contains a reference to the selected end point. * - * @param [in] currentInterface The selected active interface. - * @param [in] endPoint The selected end point. + * @param [in] currentInterface The selected active interface. + * @param [in] endPoint The selected end point. * - * @return True, if the active interface contains a reference to the end point, otherwise false. + * @return True, if the active interface contains a reference to the end point, otherwise false. */ bool activeInterfaceReferencesBusInterface(QSharedPointer currentInterface) const; diff --git a/editors/common/NamelabelWidth.h b/editors/common/NamelabelWidth.h index c33048916..5883917a0 100644 --- a/editors/common/NamelabelWidth.h +++ b/editors/common/NamelabelWidth.h @@ -33,17 +33,17 @@ class NamelabelWidth /*! * Return the length of the given text. - * @param [in] text The text used. - * @param [in] font The font used in the text. + * @param [in] text The text used. + * @param [in] font The font used in the text. */ static qreal getTextLength (QString text, QFont font ); /*! * Shortens the given label name according to the given width. * - * @param [in] labelName The text in the label. - * @param [in] font The font used in the label. - * @param [in] width The width to which the label will be shortened. + * @param [in] labelName The text in the label. + * @param [in] font The font used in the label. + * @param [in] width The width to which the label will be shortened. */ static QString setNameLabel (QString labelName, QFont font, qreal width); diff --git a/editors/common/PortUtilities.h b/editors/common/PortUtilities.h index 10a5ec35a..3866d0dcb 100644 --- a/editors/common/PortUtilities.h +++ b/editors/common/PortUtilities.h @@ -24,18 +24,18 @@ namespace PortUtilities /*! * Get the list of port directions connectible to the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of connectible port directions. + * @return List of connectible port directions. */ QVector getConnectableDirections(DirectionTypes::Direction portDirection); /*! * Get the list of hierarchical port directions connectible to the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return List of hierarchical connectible port directions. + * @return List of hierarchical connectible port directions. */ QVector getConnectableHierarchicalDirections( DirectionTypes::Direction portDirection); @@ -43,9 +43,9 @@ namespace PortUtilities /*! * Get the path for the icon matching the selected port direction. * - * @param [in] portDirection The selected port direction. + * @param [in] portDirection The selected port direction. * - * @return Path containing the icon for the selected port direction. + * @return Path containing the icon for the selected port direction. */ QString getDirectionIconPath(DirectionTypes::Direction portDirection); } diff --git a/editors/common/StickyNote/ColorFillTextItem.h b/editors/common/StickyNote/ColorFillTextItem.h index d9217d39c..a31ef4611 100644 --- a/editors/common/StickyNote/ColorFillTextItem.h +++ b/editors/common/StickyNote/ColorFillTextItem.h @@ -28,7 +28,7 @@ class ColorFillTextItem : public QGraphicsTextItem /*! * The constructor. * - * @param [in] parent The parent item. + * @param [in] parent The parent item. */ explicit ColorFillTextItem(QGraphicsItem* parent = 0); @@ -38,9 +38,9 @@ class ColorFillTextItem : public QGraphicsTextItem /*! * Sets the background fill color. * - * @param [in] color The background color to set. + * @param [in] color The background color to set. * - * @return + * @return */ void setFill(QColor const& color); diff --git a/editors/common/StickyNote/StickyNote.h b/editors/common/StickyNote/StickyNote.h index 28bde924e..f31a39230 100644 --- a/editors/common/StickyNote/StickyNote.h +++ b/editors/common/StickyNote/StickyNote.h @@ -46,7 +46,7 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable /*! * The constructor. * - * @param [in] parent The parent item. + * @param [in] parent The parent item. */ explicit StickyNote(QGraphicsItem* parent = 0); @@ -67,7 +67,7 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable /*! * Gets the vendor extension visualized by the note. * - * @return The vendor extension visualized by the note. + * @return The vendor extension visualized by the note. */ QSharedPointer getVendorExtension() const; @@ -77,23 +77,23 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable /*! * Adds a new association to the item. * - * @param [in] association The association to add. + * @param [in] association The association to add. */ virtual void addAssociation(Association* association); /*! * Removes an association from the item. * - * @param [in] association The association to remove. + * @param [in] association The association to remove. */ virtual void removeAssociation(Association* association); /*! * Defines the connection point for associations in scene coordinates. * - * @param [in] otherEnd The position of the other end connection point. + * @param [in] otherEnd The position of the other end connection point. * - * @return The connection point of the item. + * @return The connection point of the item. */ virtual QPointF connectionPoint(QPointF const& otherEnd = QPointF()) const; @@ -104,21 +104,21 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable * Set the vendor extension for the sticky note to use for storing the data. * Existing values for position, content, associations and timestamp will be read to the note . * - * @param [in] extension The vendor extension to set. + * @param [in] extension The vendor extension to set. */ void setVendorExtension(QSharedPointer extension); /*! * Sets the note text. * - * @param [in] text The text to set. + * @param [in] text The text to set. */ void setText(QString const& text); /*! * Sets the note timestamp. * - * @param [in] timestamp The timestamp to set. + * @param [in] timestamp The timestamp to set. */ void setTimestamp(QString const& timestamp); @@ -131,7 +131,7 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable /*! * Emitted when the note has been modified. * - * @param [in] undoCommand The undo command to undo/redo the modification. + * @param [in] undoCommand The undo command to undo/redo the modification. */ void modified(QUndoCommand* undoCommand); @@ -146,17 +146,17 @@ class StickyNote : public QObject, public QGraphicsItemGroup, public Associable /*! * Checks if the item's position has changed as a result of a mouse drag. * - * @return True, if the position has changed, otherwise false. + * @return True, if the position has changed, otherwise false. */ bool positionChanged(); /*! * Handler for item state changes. * - * @param [in] change The parameter of the item changing. - * @param [in] value The new value of the parameter. + * @param [in] change The parameter of the item changing. + * @param [in] value The new value of the parameter. * - * @return The set new value. + * @return The set new value. */ virtual QVariant itemChange(GraphicsItemChange change, const QVariant& value); @@ -182,16 +182,16 @@ private slots: /*! * Checks if clicking a given position hits the association button. * - * @param [in] clickPosition The position of the click. + * @param [in] clickPosition The position of the click. * - * @return True, if the click hits the association button, otherwise false. + * @return True, if the click hits the association button, otherwise false. */ bool hitsAssociationButton(QPointF const& clickPosition) const; /*! * Gets the timestamp for current time and date as formatted string. * - * @return Current time and date. + * @return Current time and date. */ QString getFormattedTimestamp(); diff --git a/editors/common/StickyNote/StickyNoteAddCommand.h b/editors/common/StickyNote/StickyNoteAddCommand.h index 2e4097dc7..707ebc405 100644 --- a/editors/common/StickyNote/StickyNoteAddCommand.h +++ b/editors/common/StickyNote/StickyNoteAddCommand.h @@ -35,10 +35,10 @@ class StickyNoteAddCommand : public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] item The item to add. - * @param [in] scene The scene to which to add the item. - * @param [in] position The initial position of the item. - * @param [in] parent The parent command. + * @param [in] item The item to add. + * @param [in] scene The scene to which to add the item. + * @param [in] position The initial position of the item. + * @param [in] parent The parent command. */ StickyNoteAddCommand(StickyNote* noteItem, QGraphicsScene* scene, QPointF position, QUndoCommand* parent = 0); diff --git a/editors/common/StickyNote/StickyNoteEditCommand.h b/editors/common/StickyNote/StickyNoteEditCommand.h index 0ce0d09f0..be85dab1c 100644 --- a/editors/common/StickyNote/StickyNoteEditCommand.h +++ b/editors/common/StickyNote/StickyNoteEditCommand.h @@ -29,12 +29,12 @@ class StickyNoteEditCommand : public QUndoCommand /*! * . * - * @param [in] noteItem The updated note. - * @param [in] newText The new text on the note. - * @param [in] oldText The previous text on the note. - * @param [in] newTimestamp The edit timestamp. - * @param [in] oldTimestamp The previous edit timestamp. - * @param [in] parent The parent command. + * @param [in] noteItem The updated note. + * @param [in] newText The new text on the note. + * @param [in] oldText The previous text on the note. + * @param [in] newTimestamp The edit timestamp. + * @param [in] oldTimestamp The previous edit timestamp. + * @param [in] parent The parent command. */ StickyNoteEditCommand(StickyNote* noteItem, QString const& newText, QString const& oldText, QString const& newTimestamp, QString const& oldTimestamp, QUndoCommand* parent = 0); diff --git a/editors/common/StickyNote/StickyNoteMoveCommand.h b/editors/common/StickyNote/StickyNoteMoveCommand.h index 2f3945c13..4e53d986f 100644 --- a/editors/common/StickyNote/StickyNoteMoveCommand.h +++ b/editors/common/StickyNote/StickyNoteMoveCommand.h @@ -27,9 +27,9 @@ class StickyNoteMoveCommand : public QUndoCommand /*! * Constructor. * - * @param [in] item The item to move. - * @param [in] oldPos The item's old position. - * @param [in] parent The parent command. + * @param [in] item The item to move. + * @param [in] oldPos The item's old position. + * @param [in] parent The parent command. */ StickyNoteMoveCommand(QGraphicsItem* item, QPointF const& oldPos, QUndoCommand* parent = 0); diff --git a/editors/common/StickyNote/StickyNoteRemoveCommand.h b/editors/common/StickyNote/StickyNoteRemoveCommand.h index 19ee0df80..ab5c2c21f 100644 --- a/editors/common/StickyNote/StickyNoteRemoveCommand.h +++ b/editors/common/StickyNote/StickyNoteRemoveCommand.h @@ -33,8 +33,8 @@ class StickyNoteRemoveCommand : public QObject, public QUndoCommand /*! * Constructor. * - * @param [in] item The item to remove. - * @param [in] parent The parent command. + * @param [in] item The item to remove. + * @param [in] parent The parent command. */ StickyNoteRemoveCommand(StickyNote* noteItem, QGraphicsScene* diagram, QUndoCommand* parent = 0); diff --git a/editors/common/TopComponentParameterFinder.h b/editors/common/TopComponentParameterFinder.h index a6ae46d79..47cf4e4f2 100644 --- a/editors/common/TopComponentParameterFinder.h +++ b/editors/common/TopComponentParameterFinder.h @@ -27,7 +27,7 @@ class TopComponentParameterFinder : public ParameterFinder /*! * Constructor. * - * @param [in] component The component which parameters are being searched for. + * @param [in] component The component which parameters are being searched for. */ explicit TopComponentParameterFinder(QSharedPointer component); @@ -45,69 +45,69 @@ class TopComponentParameterFinder : public ParameterFinder /*! * Get the parameter with the given id. * - * @param [in] parameterId The id of the parameter being searched for. + * @param [in] parameterId The id of the parameter being searched for. */ QSharedPointer getParameterWithID(QStringView parameterId) const final; /*! * Checks if a parameter with the given id exists. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return True, if the parameter with the given id exists, otherwise false. + * @return True, if the parameter with the given id exists, otherwise false. */ bool hasId(QStringView id) const final; /*! * Finds the name of the parameter with the given id. * - * @param [in] id The id to search for. + * @param [in] id The id to search for. * - * @return The name of the parameter. + * @return The name of the parameter. */ QString nameForId(QStringView id) const final; /*! * Finds the value of the parameter with the given id. * - * @param [in] id The id of the parameter to search for. + * @param [in] id The id of the parameter to search for. * - * @return The value of the parameter. + * @return The value of the parameter. */ QString valueForId(QStringView id) const final; /*! * Gets all of the ids of components parameters. * - * @return A list containing all of the ids. + * @return A list containing all of the ids. */ QStringList getAllParameterIds() const final; /*! * Gets the number of parameters in the component. * - * @return The number of parameters in the component. + * @return The number of parameters in the component. */ int getNumberOfParameters() const final; /*! * Set a new component for the parameter finder. * - * @param [in] component The new component. + * @param [in] component The new component. */ void setComponent(QSharedPointer component); /*! * Sets the active view to use for the component. * - * @param [in] view The name of the active view. + * @param [in] view The name of the active view. */ void setActiveView(QSharedPointer view); /*! * Registers a parameter model that can modify parameters for the finder. * - * @param [in] model The model to register. + * @param [in] model The model to register. */ void registerParameterModel(QAbstractItemModel const* model) final; @@ -117,7 +117,7 @@ class TopComponentParameterFinder : public ParameterFinder /*! * Finds all the parameters in the active view. * - * @return The parameters in active view. + * @return The parameters in active view. */ QList > activeViewParameters() const; diff --git a/editors/common/VendorExtensionEditor/VendorExtensionAttributesEditor/VendorExtensionAttributesModel.h b/editors/common/VendorExtensionEditor/VendorExtensionAttributesEditor/VendorExtensionAttributesModel.h index 935aeeabd..eaf4b6e7d 100644 --- a/editors/common/VendorExtensionEditor/VendorExtensionAttributesEditor/VendorExtensionAttributesModel.h +++ b/editors/common/VendorExtensionEditor/VendorExtensionAttributesEditor/VendorExtensionAttributesModel.h @@ -28,8 +28,8 @@ class VendorExtensionAttributesModel : public QAbstractTableModel /*! * The constructor. * - * @param [in] genericExtension Generic extension containing the edited attributes. - * @param [in] parent The parent of this model. + * @param [in] genericExtension Generic extension containing the edited attributes. + * @param [in] parent The parent of this model. */ VendorExtensionAttributesModel(GenericVendorExtension* genericExtension, QObject* parent = 0); @@ -41,66 +41,66 @@ class VendorExtensionAttributesModel : public QAbstractTableModel /*! * Returns the amount of columns in the model. * - * @param [in] parent If given, the column count of the children of the given parent is returned. + * @param [in] parent If given, the column count of the children of the given parent is returned. * - * @return The amount of columns. + * @return The amount of columns. */ int columnCount(const QModelIndex &parent = QModelIndex()) const; /*! * Returns the amount of rows in the model. * - * @param [in] parent If given, the row count of the children of the given parent is returned. + * @param [in] parent If given, the row count of the children of the given parent is returned. * - * @return The amount of rows. + * @return The amount of rows. */ int rowCount(const QModelIndex &parent = QModelIndex()) const; /*! * Retrieves the header data for the given column (row headers are not supported in this model). * - * @param [in] section The column from which the index is retrieved. - * @param [in] orientation Whether the header is horizontal or vertical. - * @param [in] role The role for which the header is retrieved. + * @param [in] section The column from which the index is retrieved. + * @param [in] orientation Whether the header is horizontal or vertical. + * @param [in] role The role for which the header is retrieved. * - * @return The header data. + * @return The header data. */ QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const; /*! * Retrieves the data for the appropriate role at the given index. * - * @param [in] index The index of data to be returned. - * @param [in] role The role for which data is returned. + * @param [in] index The index of data to be returned. + * @param [in] role The role for which data is returned. * - * @return The requested data. + * @return The requested data. */ QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; /*! * Sets the data at the given index. * - * @param [in] index The index at which the data is set. - * @param [in] value The new value to being set. - * @param [in] role The role for which the data is set. + * @param [in] index The index at which the data is set. + * @param [in] value The new value to being set. + * @param [in] role The role for which the data is set. * - * @return True, if data was set successfully, otherwise false. + * @return True, if data was set successfully, otherwise false. */ bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole); /*! * Returns the flags for an object at the given index. * - * @param [in] index The index of the object queried. + * @param [in] index The index of the object queried. * - * @return The relevant flags. + * @return The relevant flags. */ Qt::ItemFlags flags(QModelIndex const& index) const; /*! * Get the edited attributes. * - * @return The edited attributes. + * @return The edited attributes. */ QVector > getAttributes() const; @@ -117,14 +117,14 @@ public slots: /*! * Called when a new enumeration should be added to the model. * - * @param [in] index The index to add the enumeration to. + * @param [in] index The index to add the enumeration to. */ void onAddItem(QModelIndex const& index); /*! * Called when an enumeration should be removed from the model. * - * @param [in] index The index to remove the enumeration from. + * @param [in] index The index to remove the enumeration from. */ void onRemoveItem(QModelIndex const& index); @@ -134,34 +134,34 @@ public slots: /*! * Check if the index is valid. * - * @param [in] index The index being checked. + * @param [in] index The index being checked. * - * @return True if the index is not valid, otherwise false. + * @return True if the index is not valid, otherwise false. */ bool indexIsNotValid(QModelIndex const& index) const; /*! * Gets the value of the array in the given index. * - * @param [in] index The index of the value. + * @param [in] index The index of the value. * - * @return The data in the given index. + * @return The data in the given index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Get a unique type name for a new attribute. * - * @return A unique type name. + * @return A unique type name. */ QString getUniqueNameForNewAttribute() const; /*! * Check if the selected type name exists in the current attributes. * - * @param [in] attributeName The selected type name. + * @param [in] attributeName The selected type name. * - * @return True, if the name exists in the selected attributes, false otherwise. + * @return True, if the name exists in the selected attributes, false otherwise. */ bool nameExistsInAttributes(QString const& attributeName) const; diff --git a/editors/common/VendorExtensionEditor/VendorExtensionsDelegate.h b/editors/common/VendorExtensionEditor/VendorExtensionsDelegate.h index 732ab1722..69ee99f81 100644 --- a/editors/common/VendorExtensionEditor/VendorExtensionsDelegate.h +++ b/editors/common/VendorExtensionEditor/VendorExtensionsDelegate.h @@ -27,7 +27,7 @@ class VendorExtensionsDelegate : public QStyledItemDelegate /*! * The constructor * - * @param [in] parent The owner of the delegate. + * @param [in] parent The owner of the delegate. */ VendorExtensionsDelegate(QObject *parent); @@ -39,11 +39,11 @@ class VendorExtensionsDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -51,35 +51,35 @@ class VendorExtensionsDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; /*! * Paint the vendor extension rows. * - * @param [in] painter The used painter. - * @param [in] option Available style options. - * @param [in] index The current index. + * @param [in] painter The used painter. + * @param [in] option Available style options. + * @param [in] index The current index. */ virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Updates the editor geometry. * - * @param [in] editor The editor being updated. - * @param [in] option The options used to update the editor. - * @param [in] index The model index being edited. + * @param [in] editor The editor being updated. + * @param [in] option The options used to update the editor. + * @param [in] index The model index being edited. */ virtual void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const; @@ -101,9 +101,9 @@ class VendorExtensionsDelegate : public QStyledItemDelegate * Repositions the editor if there is not enough space under the default position. The editor is then resized * to use the available space. * - * @param [in] editor The editor to reposition. - * @param [in] option The style options for the editor. - * @param [in] index The current index. + * @param [in] editor The editor to reposition. + * @param [in] option The style options for the editor. + * @param [in] index The current index. */ void repositionAndResizeEditor(QWidget* editor, QStyleOptionViewItem const& option) const; }; diff --git a/editors/common/VendorExtensionEditor/VendorExtensionsEditor.h b/editors/common/VendorExtensionEditor/VendorExtensionsEditor.h index 8dc3bc8c2..b112a7ba9 100644 --- a/editors/common/VendorExtensionEditor/VendorExtensionsEditor.h +++ b/editors/common/VendorExtensionEditor/VendorExtensionsEditor.h @@ -35,7 +35,7 @@ class VendorExtensionsEditor : public QWidget /*! * The constructor. * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ VendorExtensionsEditor(QWidget *parent); @@ -51,14 +51,14 @@ class VendorExtensionsEditor : public QWidget /*! * Locks/Unlocks the editor. * - * @param [in] locked The lock state to set. + * @param [in] locked The lock state to set. */ void setLocked(bool locked); /*! * Set the context for the editor. * - * @param [in] doc The document widget whose vendor extensions are being edited. + * @param [in] doc The document widget whose vendor extensions are being edited. */ void setContext(TabDocument* doc); @@ -75,8 +75,8 @@ public slots: /*! * Change the vendor extensions of the vendor extensions editor. * - * @param [in] containingID ID for the vendor extensions editor. - * @param [in] extensionItem The item containing the selected vendor extensions. + * @param [in] containingID ID for the vendor extensions editor. + * @param [in] extensionItem The item containing the selected vendor extensions. */ void changeVendorExtensions(QString const& containingID, QSharedPointer extensionItem); diff --git a/editors/common/VendorExtensionEditor/VendorExtensionsFilter.h b/editors/common/VendorExtensionEditor/VendorExtensionsFilter.h index 1c033c3e8..7bc105bc0 100644 --- a/editors/common/VendorExtensionEditor/VendorExtensionsFilter.h +++ b/editors/common/VendorExtensionEditor/VendorExtensionsFilter.h @@ -28,7 +28,7 @@ class VendorExtensionsFilter : public EditableTreeSortFilter /*! * Constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ VendorExtensionsFilter(QObject* parent = 0); @@ -46,10 +46,10 @@ class VendorExtensionsFilter : public EditableTreeSortFilter /*! * Implementation of the row filtering. * - * @param [in] source_row The row to check for filtering. - * @param [in] source_parent The parent index of the row. + * @param [in] source_row The row to check for filtering. + * @param [in] source_parent The parent index of the row. * - * @return True, if the row passes the filters, otherwise false. + * @return True, if the row passes the filters, otherwise false. */ virtual bool filterAcceptsRow(int source_row, const QModelIndex & source_parent) const override; }; diff --git a/editors/common/VendorExtensionEditor/VendorExtensionsModel.h b/editors/common/VendorExtensionEditor/VendorExtensionsModel.h index 3dde18b33..413987a95 100644 --- a/editors/common/VendorExtensionEditor/VendorExtensionsModel.h +++ b/editors/common/VendorExtensionEditor/VendorExtensionsModel.h @@ -33,7 +33,7 @@ class VendorExtensionsModel : public QAbstractItemModel /*! * The constructor. * - * @param [in] parent The owner of this model. + * @param [in] parent The owner of this model. */ VendorExtensionsModel(QObject *parent); @@ -51,86 +51,86 @@ class VendorExtensionsModel : public QAbstractItemModel /*! * Set the vendor extensions to edit. * - * @param [in] extensions The vendor extensions to view/edit. + * @param [in] extensions The vendor extensions to view/edit. */ void setVendorExtensions(QSharedPointer > > extensions); /*! * Get the number of rows to be displayed. * - * @param [in] parent Identifies the parent, must always be invalid index. + * @param [in] parent Identifies the parent, must always be invalid index. * - * @return The number of rows to display. + * @return The number of rows to display. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the number of columns to display. * - * @param [in] parent Identifies the parent, must always be invalid index. + * @param [in] parent Identifies the parent, must always be invalid index. * - * @return The number of columns to display. + * @return The number of columns to display. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; /*! * Get the data for specified index in given data role. * - * @param [in] index Identifies the object that's data is wanted. - * @param [in] role Identifies the type of data being requested. + * @param [in] index Identifies the object that's data is wanted. + * @param [in] role Identifies the type of data being requested. * - * @return QVariant that contains the requested data. + * @return QVariant that contains the requested data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Get the data for the given header in the given data role. * - * @param [in] section Identifies the header section. - * @param [in] orientation Only horizontal header is supported. - * @param [in] role Identifies the type of the data being requested. + * @param [in] section Identifies the header section. + * @param [in] orientation Only horizontal header is supported. + * @param [in] role Identifies the type of the data being requested. * - * @return QVariant that contains the requested data. + * @return QVariant that contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Set the data for the specified index. * - * @param [in] index Identifies the object which data is to be saved. - * @param [in] value Contains the data to be saved. - * @param [in] role Identifies the type of the data to be saved. + * @param [in] index Identifies the object which data is to be saved. + * @param [in] value Contains the data to be saved. + * @param [in] role Identifies the type of the data to be saved. * - * @return True if data was saved successfully. + * @return True if data was saved successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole ); /*! * Get info on what operations are possible for specified item. * - * @param [in] index Identifies the item that's operations are requested. + * @param [in] index Identifies the item that's operations are requested. * - * @return Flags containing info on which operations are available for given index. + * @return Flags containing info on which operations are available for given index. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; /*! * Get the model index of the specified object. * - * @param [in] row Row number of the object. - * @param [in] column Column number of the object. - * @param [in] parent Model index of the parent of the object. + * @param [in] row Row number of the object. + * @param [in] column Column number of the object. + * @param [in] parent Model index of the parent of the object. * - * @return QModelIndex that identifies the object. + * @return QModelIndex that identifies the object. */ QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const; /*! * Get the model index of the parent of the object. * - * @param [in] child Model index that identifies the child of the object. + * @param [in] child Model index that identifies the child of the object. * - * @return QModelindex that identifies the parent of the given object. + * @return QModelindex that identifies the parent of the given object. */ QModelIndex parent(const QModelIndex& child) const; @@ -144,28 +144,28 @@ public slots: /*! * Handles the addition of a new item. * - * @param [in] index The index to add the new item. + * @param [in] index The index to add the new item. */ void onAddItem(QModelIndex const& index); /*! * Handles item removal. * - * @param [in] index The index to remove the item from. + * @param [in] index The index to remove the item from. */ void onRemoveItem(QModelIndex const& index); /*! * Handles the addition of a new sub item. * - * @param [in] index The parent index for the new sub item. + * @param [in] index The parent index for the new sub item. */ void onAddSubItem(QModelIndex const& index); /*! * Remove all the sub items from the selected item. * - * @param [in] index Index of the selected item. + * @param [in] index Index of the selected item. */ void onRemoveAllSubItems(QModelIndex const& index); @@ -181,72 +181,72 @@ public slots: /*! * Check if the given index is valid. * - * @param [in] index The index to be checked. + * @param [in] index The index to be checked. * - * @return True, if the given index is valid, false otherwise. + * @return True, if the given index is valid, false otherwise. */ bool isIndexValid(QModelIndex const& index) const; /*! * Check if the index content can be edited by the user. * - * @param [in] index The index to check. + * @param [in] index The index to check. * - * @return True, if the index content is editable, otherwise false. + * @return True, if the index content is editable, otherwise false. */ bool indexIsEditable(QModelIndex const& index) const; /*! * Get the value for item in the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Value of the selected index. + * @return Value of the selected index. */ QVariant valueForIndex(QModelIndex const& index) const; /*! * Get the generic extension of the selected index. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return Generic vendor extension of the selected index. + * @return Generic vendor extension of the selected index. */ GenericVendorExtension* getExtensionForIndex(QModelIndex const& index) const; /*! * Create a parent index for the selected child index. * - * @param [in] childIndex The selected child index. + * @param [in] childIndex The selected child index. * - * @return The created parent index. + * @return The created parent index. */ QModelIndex createParentIndexForChildExtension(QModelIndex const& childIndex) const; /*! * Get the row of the selected extension item. * - * @param [in] extensionItem The selected extension item. + * @param [in] extensionItem The selected extension item. * - * @return Row of the selected extension item. + * @return Row of the selected extension item. */ int getRowForItem(GenericVendorExtension* extensionItem) const; /*! * Get the row of the selected root extension item. * - * @param [in] parentItem The selected root extension item. + * @param [in] parentItem The selected root extension item. * - * @return Row of the selected rot extension item. + * @return Row of the selected rot extension item. */ int getRowForRootItem(GenericVendorExtension* parentItem) const; /*! * Check if the column of the selected index is mandatory. * - * @param [in] index The selected index. + * @param [in] index The selected index. * - * @return True, if the column is mandatory, false otherwise. + * @return True, if the column is mandatory, false otherwise. */ bool mandatoryColumn(QModelIndex const& index) const; diff --git a/kactusGenerators/DocumentGenerator/DocumentationWriter.h b/kactusGenerators/DocumentGenerator/DocumentationWriter.h index 79d93bc9c..86235cf5f 100644 --- a/kactusGenerators/DocumentGenerator/DocumentationWriter.h +++ b/kactusGenerators/DocumentGenerator/DocumentationWriter.h @@ -67,69 +67,69 @@ class DocumentationWriter /*! * Write the document header. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ virtual void writeHeader(QTextStream& stream) = 0; /*! * Write a header for the component. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ virtual void writeComponentHeader(QTextStream& stream) = 0; /*! * Write the component info. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ virtual void writeComponentInfo(QTextStream& stream) = 0; /*! * Write component kactus2 attributes. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writeKactusAttributes(QTextStream& stream, int subHeaderNumber) = 0; /*! * Write the table of contents header. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ virtual void writeTableOfContentsHeader(QTextStream& stream) = 0; /*! * Write the table of contents of the current component. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ virtual void writeTableOfContents(QTextStream& stream) = 0; /*! * Write the parameters of the component. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writeParameters(QTextStream& stream, int subHeaderNumber) = 0; /*! * Write the memory maps of the component. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writeMemoryMaps(QTextStream& stream, int subHeaderNumber) = 0; /*! * Write the given address blocks. * - * @param [in] stream The text stream to write into. - * @param [in] addressBlocks The address blocks to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. + * @param [in] stream The text stream to write into. + * @param [in] addressBlocks The address blocks to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. */ virtual void writeAddressBlocks(QTextStream& stream, QList > addressBlocks, int subHeaderNumber, int memoryMapNumber) = 0; @@ -137,10 +137,10 @@ class DocumentationWriter /*! * Write the given register files * - * @param [in] stream The text stream to write into. - * @param [in] registerFiles The registers to be written. - * @param [in] subHeaderNumbers The current subheader number. - * @param [out] registerDataNumber The current address block number. + * @param [in] stream The text stream to write into. + * @param [in] registerFiles The registers to be written. + * @param [in] subHeaderNumbers The current subheader number. + * @param [out] registerDataNumber The current address block number. */ virtual void writeRegisterFiles(QTextStream& stream, QList > registerFiles, @@ -149,11 +149,11 @@ class DocumentationWriter /*! * Write the given registers. * - * @param [in] stream The text stream to write into. - * @param [in] registers The registers to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. - * @param [in] addressBlockNumber The current address block number. + * @param [in] stream The text stream to write into. + * @param [in] registers The registers to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. + * @param [in] addressBlockNumber The current address block number. */ virtual void writeRegisters(QTextStream& stream, QList > registers, int subHeaderNumber, int memoryMapNumber, int addressBlockNumber, int& registerDataNumber) = 0; @@ -161,8 +161,8 @@ class DocumentationWriter /*! * Write the given register fields. * - * @param [in] stream The text stream to write into. - * @param [in] register The register whose fields are to be written. + * @param [in] stream The text stream to write into. + * @param [in] register The register whose fields are to be written. */ virtual void writeFields(QTextStream& stream, QSharedPointer currentRegister, QList registerSubHeaderNumbers) = 0; @@ -170,41 +170,41 @@ class DocumentationWriter /*! * Write the ports of the component. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writePorts(QTextStream& stream, int subHeaderNumber) = 0; /*! * Write the bus interfaces of the component. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writeInterfaces(QTextStream& stream, int& subHeaderNumber) = 0; /*! * Write the file sets of the component. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ virtual void writeFileSets(QTextStream& stream, int& subHeaderNumber) = 0; /*! * Set the number of the component in the hierarchy. * - * @param [in] componentNumber The new component number. + * @param [in] componentNumber The new component number. */ virtual void setComponentNumber(int componentNumber) = 0; /*! * Write a referenced component subheader. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] headerText The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] headerText The displayed header text. + * @param [in] headerId The id for referencing within the document. */ virtual void writeSubHeader(QTextStream& stream, int subHeaderNumber, QString const& headerText, QString const& headerId) const = 0; @@ -212,10 +212,10 @@ class DocumentationWriter /*! * Write a non-referenced component subheader with specified header level. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumbers The subheader numbers. - * @param [in] title The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumbers The subheader numbers. + * @param [in] title The displayed header text. + * @param [in] headerId The id for referencing within the document. */ virtual void writeSubHeader(QTextStream& stream, QList const& subHeaderNumbers, QString const& title, int level) const = 0; @@ -223,25 +223,25 @@ class DocumentationWriter /*! * Write a description text. * - * @param [in] stream The text stream to write into. - * @param [in] description The description to write. + * @param [in] stream The text stream to write into. + * @param [in] description The description to write. */ virtual void writeDescription(QTextStream& stream, QString const& description) = 0; /*! * Write an error text to the document. * - * @param [in] stream The text stream to write into.. - * @param [in] message The description to write. + * @param [in] stream The text stream to write into.. + * @param [in] message The description to write. */ virtual void writeErrorMessage(QTextStream& stream, QString const& message) = 0; /*! * Write the document contained within the selected VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] documentType Type of the document. - * @param [in] vlnvReference VLNV of the selected document. + * @param [in] stream Text stream to write the document. + * @param [in] documentType Type of the document. + * @param [in] vlnvReference VLNV of the selected document. */ virtual void writeDocumentReference(QTextStream& stream, QString const& documentType, QSharedPointer vlnvReference) = 0; @@ -249,10 +249,10 @@ class DocumentationWriter /*! * Write the design diagram. * - * @param [in] stream Text stream to write the diagram to. - * @param [in] title Diagram title. - * @param [in] link Diagram picture link or path. - * @param [in] altText Diagram alt text. + * @param [in] stream Text stream to write the diagram to. + * @param [in] title Diagram title. + * @param [in] link Diagram picture link or path. + * @param [in] altText Diagram alt text. */ virtual void writeDiagram(QTextStream& stream, QString const& title, QString const& link, QString const& altText) = 0; @@ -260,9 +260,9 @@ class DocumentationWriter /*! * Write the component instances contained within the selected design. * - * @param [in] stream Text stream to write the component instances. - * @param [in] design The selected design. - * @param [in] configuration The selected design configuration. + * @param [in] stream Text stream to write the component instances. + * @param [in] design The selected design. + * @param [in] configuration The selected design configuration. */ virtual void writeDesignInstances(QTextStream& stream, QSharedPointer design, QSharedPointer configuration) = 0; @@ -270,18 +270,18 @@ class DocumentationWriter /*! * Write the end of the document, if the format requires it. * - * @param [in] stream The text stream to write the documentation into. + * @param [in] stream The text stream to write the documentation into. */ virtual void writeEndOfDocument(QTextStream& stream) = 0; /*! * Write the referenced component instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] instantiation The component instantiation. - * @param [in] instantiationFormatter The component instantiation formatter. - * @param [in] moduleParameters The instantiation module parameters. - * @param [in] parameters The instantiation parameters. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] instantiation The component instantiation. + * @param [in] instantiationFormatter The component instantiation formatter. + * @param [in] moduleParameters The instantiation module parameters. + * @param [in] parameters The instantiation parameters. */ void writeReferencedComponentInstantiation( QTextStream& stream, @@ -293,9 +293,9 @@ class DocumentationWriter /*! * Write the referenced design configuration instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] configurationFinder The parameter finder for the instantiation. - * @param [in] instantiationFormatter The instantiation formatter. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] configurationFinder The parameter finder for the instantiation. + * @param [in] instantiationFormatter The instantiation formatter. */ void writeReferencedDesignConfigurationInstantiation(QTextStream& stream, QSharedPointer configurationFinder, @@ -306,11 +306,11 @@ class DocumentationWriter /*! * Write the referenced design instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] designVLNV The VLNV of the design instantiation. - * @param [in] instantiatedDesign The instantiated design. - * @param [in] designFormatter Expression formatter for the design. - * @param [in] instantiationFormatter Expression formatter for the instantiation. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] designVLNV The VLNV of the design instantiation. + * @param [in] instantiatedDesign The instantiated design. + * @param [in] designFormatter Expression formatter for the design. + * @param [in] instantiationFormatter Expression formatter for the instantiation. */ void writeReferencedDesignInstantiation(QTextStream& stream, QSharedPointer designVLNV, @@ -321,28 +321,28 @@ class DocumentationWriter /*! * Sets the target path for the document. * - * @param [in] path The new target path. + * @param [in] path The new target path. */ void setTargetPath(QString const& path); /*! * Get the target path of the document. * - * @returns The target path. + * @returns The target path. */ QString getTargetPath() const; /*! * Sets the images path. * - * @param [in] path The new images path. + * @param [in] path The new images path. */ void setImagesPath(QString const& path); /*! * Get the path of the images folder. * - * @returns The image folder path. + * @returns The image folder path. */ QString getImagesPath() const; @@ -351,8 +351,8 @@ class DocumentationWriter /*! * Writes the implementation details of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ virtual void writeImplementationDetails(QTextStream& stream, QSharedPointer instantiation) = 0; @@ -360,8 +360,8 @@ class DocumentationWriter /*! * Writes the file set references contained within a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ virtual void writeFileSetReferences(QTextStream& stream, QSharedPointer instantiation) = 0; @@ -369,9 +369,9 @@ class DocumentationWriter /*! * Writes the file build commands of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. - * @param [in] formatter The expression formatter for the component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. + * @param [in] formatter The expression formatter for the component instantiation. */ virtual void writeFileBuildCommands(QTextStream& stream, QSharedPointer instantiation, QSharedPointer formatter) = 0; @@ -379,10 +379,10 @@ class DocumentationWriter /*! * Writes given parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table. - * @param [in] parameters The parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table. + * @param [in] parameters The parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ virtual void writeParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > parameters, @@ -391,10 +391,10 @@ class DocumentationWriter /*! * Writes given module parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table. - * @param [in] moduleParameters The module parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table. + * @param [in] moduleParameters The module parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ virtual void writeModuleParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > moduleParameters, @@ -403,10 +403,10 @@ class DocumentationWriter /*! * Writes the configurable element values of a VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] vlnvReference Configurable VLNV containing the selected configurable element + * @param [in] stream Text stream to write the document. + * @param [in] vlnvReference Configurable VLNV containing the selected configurable element * values. - * @param [in] instantiationFormatter Expression formatter for the configurable element values. + * @param [in] instantiationFormatter Expression formatter for the configurable element values. */ virtual void writeConfigurableElementValues(QTextStream& stream, QSharedPointer vlnvReference, @@ -415,35 +415,35 @@ class DocumentationWriter /*! * Write a paragraph in which specific information is listed. * - * @param [in] stream The text stream to write into. - * @param [in] names The info item names. - * @param [in] values The info item values. + * @param [in] stream The text stream to write into. + * @param [in] names The info item names. + * @param [in] values The info item values. */ virtual void writeInfoParagraph(QTextStream& stream, QStringList const& names, QStringList const& values) = 0; /*! * Writes the enumerations of a field. * - * @param [in] stream The text stream to write into. - * @param [in] field The field which enumerations are written. + * @param [in] stream The text stream to write into. + * @param [in] field The field which enumerations are written. */ virtual void writeFieldEnumerations(QTextStream& stream, QSharedPointer field) = 0; /*! * Finds the address blocks of a memory map. * - * @param [in] memoryMap The memory map. + * @param [in] memoryMap The memory map. * - * @returns The memory map address blocks. + * @returns The memory map address blocks. */ QList > getMemoryMapAddressBlocks(QSharedPointer memoryMap) const; /*! * Finds the registers from some register data. * - * @param [in] registerData The register data. + * @param [in] registerData The register data. * - * @returns The registers of the register data. + * @returns The registers of the register data. */ QList > getRegisters( QSharedPointer > > registerData) const; @@ -451,9 +451,9 @@ class DocumentationWriter /*! * Finds the register files from some register data. * - * @param [in] registerData The register data. + * @param [in] registerData The register data. * - * @returns The register files of the register data. + * @returns The register files of the register data. */ QList > getRegisterFiles( QSharedPointer > > registerData) const; @@ -461,19 +461,19 @@ class DocumentationWriter /*! * Finds the field reset info of a register field. * - * @param [in] field The register field. + * @param [in] field The register field. * - * @returns The field reset info of the field. + * @returns The field reset info of the field. */ QString getFieldResetInfo(QSharedPointer field, QString const& separator = "
") const; /*! * Creates an expression formatter for a component contained within a design. * - * @param [in] design The design. - * @param [in] component The component. + * @param [in] design The design. + * @param [in] component The component. * - * @returns An expression formatter for . + * @returns An expression formatter for . */ QSharedPointer createDesignInstanceFormatter(QSharedPointer design, QSharedPointer component); @@ -481,18 +481,18 @@ class DocumentationWriter /*! * Writes info about an address block. * - * @param [in] stream The text stream to write into. - * @param [in] addressBlock The address block to write about. + * @param [in] stream The text stream to write into. + * @param [in] addressBlock The address block to write about. */ void writeAddressBlockInfo(QTextStream& stream, QSharedPointer addressBlock); /*! * Writes info about a single register. * - * @param [in] stream The text stream to write into. - * @param [in] reg The register to be written. - * @param [in] subHeaderNumbers The subheader numbers to write in the subheader. - * @param [in] registerDataNumber The current address block register data number. + * @param [in] stream The text stream to write into. + * @param [in] reg The register to be written. + * @param [in] subHeaderNumbers The subheader numbers to write in the subheader. + * @param [in] registerDataNumber The current address block register data number. */ void writeSingleRegister(QTextStream& stream, QSharedPointer reg, QList subHeaderNumbers, int& registerDataNumber); @@ -500,25 +500,25 @@ class DocumentationWriter /*! * Writes info about a register file. * - * @param [in] stream The text stream to write into. - * @param [in] registerFile The register file to be written. + * @param [in] stream The text stream to write into. + * @param [in] registerFile The register file to be written. */ void writeRegisterFileInfo(QTextStream& stream, QSharedPointer registerFile); /*! * Writes a single field. * - * @param [in] stream The text stream to write into. - * @param [in] field The field to be written. + * @param [in] stream The text stream to write into. + * @param [in] field The field to be written. */ void writeSingleField(QTextStream& stream, QSharedPointer field); /*! * Writes information about a bus interface. * - * @param [in] stream The text stream to write into. - * @param [in] interface The interface to be written. - * @param [in] hasPorts Flag that indicates if interface has ports. + * @param [in] stream The text stream to write into. + * @param [in] interface The interface to be written. + * @param [in] hasPorts Flag that indicates if interface has ports. */ void writeInterfaceInfo(QTextStream& stream, QSharedPointer interface, bool hasPorts); diff --git a/kactusGenerators/DocumentGenerator/HtmlWriter.h b/kactusGenerators/DocumentGenerator/HtmlWriter.h index c2bdee6f0..e10f26bd9 100644 --- a/kactusGenerators/DocumentGenerator/HtmlWriter.h +++ b/kactusGenerators/DocumentGenerator/HtmlWriter.h @@ -41,69 +41,69 @@ class HtmlWriter : public DocumentationWriter /*! * Write the document header. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ void writeHeader(QTextStream& stream) override; /*! * Write a header for the component. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ void writeComponentHeader(QTextStream& stream) override; /*! * Write the component info. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeComponentInfo(QTextStream& stream) override; /*! * Write component kactus2 attributes. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeKactusAttributes(QTextStream& stream, int subHeaderNumber) override; /*! * Write the table of contents header. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeTableOfContentsHeader(QTextStream& stream) override; /*! * Write the table of contents of the current component. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeTableOfContents(QTextStream& stream) override; /*! * Write the parameters of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeParameters(QTextStream& stream, int subHeaderNumber) override; /*! * Write the memory maps of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeMemoryMaps(QTextStream& stream, int subHeaderNumber) override; /*! * Write the given address blocks * - * @param [in] stream The text stream to write into. - * @param [in] addressBlocks The address blocks to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. + * @param [in] stream The text stream to write into. + * @param [in] addressBlocks The address blocks to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. */ void writeAddressBlocks(QTextStream& stream, QList > addressBlocks, int subHeaderNumber, int memoryMapNumber) override; @@ -111,11 +111,11 @@ class HtmlWriter : public DocumentationWriter /*! * Write the given registers * - * @param [in] stream The text stream to write into. - * @param [in] registers The registers to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. - * @param [in] addressBlockNumber The current address block number. + * @param [in] stream The text stream to write into. + * @param [in] registers The registers to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. + * @param [in] addressBlockNumber The current address block number. */ void writeRegisters(QTextStream& stream, QList > registers, int subHeaderNumber, int memoryMapNumber, int addressBlockNumber, int& registerDataNumber) override; @@ -127,8 +127,8 @@ class HtmlWriter : public DocumentationWriter /*! * Write the given register fields * - * @param [in] stream The text stream to write into. - * @param [in] register The register whose fields are to be written. + * @param [in] stream The text stream to write into. + * @param [in] register The register whose fields are to be written. */ void writeFields(QTextStream& stream, QSharedPointer currentRegister, QList registerSubHeaderNumbers) override; @@ -136,41 +136,41 @@ class HtmlWriter : public DocumentationWriter /*! * Write the ports of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writePorts(QTextStream& stream, int subHeaderNumber) override; /*! * Write the bus interfaces of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeInterfaces(QTextStream& stream, int& subHeaderNumber) override; /*! * Write the file sets of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeFileSets(QTextStream& stream, int& subHeaderNumber) override; /*! * Set the number of the component in the hierarchy * - * @param [in] componentNumber The new component number. + * @param [in] componentNumber The new component number. */ void setComponentNumber(int componentNumber) override; /*! * Write a referenced component subheader * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] headerText The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] headerText The displayed header text. + * @param [in] headerId The id for referencing within the document. */ void writeSubHeader(QTextStream& stream, int subHeaderNumber, QString const& headerText, QString const& headerId) const override; @@ -178,10 +178,10 @@ class HtmlWriter : public DocumentationWriter /*! * Write a non-referenced component subheader with specified header level * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumbers The subheader numbers. - * @param [in] title The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumbers The subheader numbers. + * @param [in] title The displayed header text. + * @param [in] headerId The id for referencing within the document. */ void writeSubHeader(QTextStream& stream, QList const& subHeaderNumbers, QString const& title, int level) const override; @@ -189,34 +189,34 @@ class HtmlWriter : public DocumentationWriter /*! * Write a description text * - * @param [in] stream The text stream to write into. - * @param [in] description The description to write. + * @param [in] stream The text stream to write into. + * @param [in] description The description to write. */ void writeDescription(QTextStream& stream, QString const& description) override; /*! * Write a paragraph in which specific information is listed. * - * @param [in] stream The text stream to write into. - * @param [in] names The info item names. - * @param [in] values The info item values. + * @param [in] stream The text stream to write into. + * @param [in] names The info item names. + * @param [in] values The info item values. */ void writeInfoParagraph(QTextStream& stream, QStringList const& names, QStringList const& values) override; /*! * Write an error text to the document. * - * @param [in] stream The text stream to write into.. - * @param [in] message The description to write. + * @param [in] stream The text stream to write into.. + * @param [in] message The description to write. */ void writeErrorMessage(QTextStream& stream, QString const& message) override; /*! * Write the document contained within the selected VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] documentType Type of the document. - * @param [in] vlnvReference VLNV of the selected document. + * @param [in] stream Text stream to write the document. + * @param [in] documentType Type of the document. + * @param [in] vlnvReference VLNV of the selected document. */ void writeDocumentReference(QTextStream& stream, QString const& documentType, QSharedPointer vlnvReference) override; @@ -224,10 +224,10 @@ class HtmlWriter : public DocumentationWriter /*! * Write the design diagram. * - * @param [in] stream Text stream to write the diagram to. - * @param [in] title Diagram title. - * @param [in] link Diagram picture link or path. - * @param [in] altText Diagram alt text. + * @param [in] stream Text stream to write the diagram to. + * @param [in] title Diagram title. + * @param [in] link Diagram picture link or path. + * @param [in] altText Diagram alt text. */ void writeDiagram(QTextStream& stream, QString const& title, QString const& link, QString const& altText) override; @@ -235,9 +235,9 @@ class HtmlWriter : public DocumentationWriter /*! * Write the component instances contained within the selected design. * - * @param [in] stream Text stream to write the component instances. - * @param [in] design The selected design. - * @param [in] configuration The selected design configuration. + * @param [in] stream Text stream to write the component instances. + * @param [in] design The selected design. + * @param [in] configuration The selected design configuration. */ void writeDesignInstances(QTextStream& stream, QSharedPointer design, QSharedPointer configuration) override; @@ -245,7 +245,7 @@ class HtmlWriter : public DocumentationWriter /*! * Write the end of the HTML document. * - * @param [in] stream The text stream to write the documentation into. + * @param [in] stream The text stream to write the documentation into. */ void writeEndOfDocument(QTextStream& stream) override; @@ -254,33 +254,33 @@ class HtmlWriter : public DocumentationWriter /*! * Returns n tabs for HTML indentation. * - * @param [in] n The number of tabs. + * @param [in] n The number of tabs. * - * @returns n tabs. + * @returns n tabs. */ QString indent(int n) const; /*! * Writes a table of registers. * - * @param [in] stream The text stream to write into. - * @param [in] registers The registers to be written. + * @param [in] stream The text stream to write into. + * @param [in] registers The registers to be written. */ void writeRegisterTable(QTextStream& stream, QList >registers); /*! * Writes a table of register fields. * - * @param [in] stream The text stream to write into. - * @param [in] reg The register whose fields are written. + * @param [in] stream The text stream to write into. + * @param [in] reg The register whose fields are written. */ void writeFieldTable(QTextStream& stream, QSharedPointer reg); /*! * Writes the enumerations of a field. * - * @param [in] stream The text stream to write into. - * @param [in] field The field which enumerations are written. + * @param [in] stream The text stream to write into. + * @param [in] field The field which enumerations are written. */ void writeFieldEnumerations(QTextStream& stream, QSharedPointer field) override; @@ -288,9 +288,9 @@ class HtmlWriter : public DocumentationWriter * Writes a row with specified cells to a HTML table with chosen indentation. * Indentation is the number of tabs for the parent element. * - * @param [in] stream Text stream to write to. - * @param [in] cells Table row cells. - * @param [in] indentation The table element indentation. + * @param [in] stream Text stream to write to. + * @param [in] cells Table row cells. + * @param [in] indentation The table element indentation. */ void writeTableRow(QTextStream& stream, QStringList const& cells, int indentation) const; @@ -298,17 +298,17 @@ class HtmlWriter : public DocumentationWriter * Writes the table header row with chosen indentation. * Indentation should be one more than table element indentation. * - * @param [in] stream Text stream to write to. - * @param [in] headerCells The table headers. - * @param [in] indentation The table element indentation. + * @param [in] stream Text stream to write to. + * @param [in] headerCells The table headers. + * @param [in] indentation The table element indentation. */ void writeTableHeader(QTextStream& stream, QStringList const& headerCells, int indentation) const; /*! * Writes a port table for specified ports. * - * @param [in] stream Text stream to write to. - * @param [in] ports The ports to be written. + * @param [in] stream Text stream to write to. + * @param [in] ports The ports to be written. */ void writePortTable(QTextStream& stream, QString const& tableTitle, QList > ports) const; @@ -316,26 +316,26 @@ class HtmlWriter : public DocumentationWriter /*! * Writes group identifiers for a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set to write identifiers for. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set to write identifiers for. */ void writeFileSetGroupdIdentifiers(QTextStream& stream, QSharedPointer fileSet) const; /*! * Writes the default file builders for a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set to write file builders for. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set to write file builders for. */ void writeDefaultFileBuilders(QTextStream& stream, QSharedPointer fileSet) const; /*! * Writes the files of a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set whose files will be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] fileSetNumber The current file set number. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set whose files will be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] fileSetNumber The current file set number. */ void writeFiles(QTextStream& stream, QSharedPointer fileSet, int subHeaderNumber, int fileSetNumber); @@ -343,16 +343,16 @@ class HtmlWriter : public DocumentationWriter /*! * Writes a specified file of a file set. * - * @param [in] stream Text stream to write to. - * @param [in] file File to be written. + * @param [in] stream Text stream to write to. + * @param [in] file File to be written. */ void writeSingleFile(QTextStream& stream, QSharedPointer file) const; /*! * Writes the implementation details of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ void writeImplementationDetails(QTextStream& stream, QSharedPointer instantiation) override; @@ -360,8 +360,8 @@ class HtmlWriter : public DocumentationWriter /*! * Writes the file set references contained within a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ void writeFileSetReferences(QTextStream& stream, QSharedPointer instantiation) override; @@ -369,9 +369,9 @@ class HtmlWriter : public DocumentationWriter /*! * Writes the file build commands of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. - * @param [in] formatter The expression formatter for the component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. + * @param [in] formatter The expression formatter for the component instantiation. */ void writeFileBuildCommands(QTextStream& stream, QSharedPointer instantiation, QSharedPointer instantiationFormatter) override; @@ -379,10 +379,10 @@ class HtmlWriter : public DocumentationWriter /*! * Writes given parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table - * @param [in] parameters The parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table + * @param [in] parameters The parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ void writeParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > parameters, @@ -391,10 +391,10 @@ class HtmlWriter : public DocumentationWriter /*! * Writes given module parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table. - * @param [in] moduleParameters The module parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table. + * @param [in] moduleParameters The module parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ void writeModuleParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > moduleParameters, @@ -403,10 +403,10 @@ class HtmlWriter : public DocumentationWriter /*! * Writes the configurable element values of a VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] vlnvReference Configurable VLNV containing the selected configurable element + * @param [in] stream Text stream to write the document. + * @param [in] vlnvReference Configurable VLNV containing the selected configurable element * values. - * @param [in] instantiationFormatter Expression formatter for the configurable element values. + * @param [in] instantiationFormatter Expression formatter for the configurable element values. */ void writeConfigurableElementValues(QTextStream& stream, QSharedPointer vlnvReference, @@ -415,9 +415,9 @@ class HtmlWriter : public DocumentationWriter /*! * Gets the configurable element values of a component instance as a line-broken string. * - * @param [in] stream Text stream to write the document. - * @param [in] instance The component instance. - * @param [in] design The design in which the component instance is. + * @param [in] stream Text stream to write the document. + * @param [in] instance The component instance. + * @param [in] design The design in which the component instance is. */ QString getComponentInstanceConfigurableElements(QSharedPointer instance, QSharedPointer design); diff --git a/kactusGenerators/DocumentGenerator/MarkdownWriter.h b/kactusGenerators/DocumentGenerator/MarkdownWriter.h index 081058052..55955563d 100644 --- a/kactusGenerators/DocumentGenerator/MarkdownWriter.h +++ b/kactusGenerators/DocumentGenerator/MarkdownWriter.h @@ -44,69 +44,69 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the document header. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ void writeHeader(QTextStream& stream) override; /*! * Write a header for the component. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ void writeComponentHeader(QTextStream& stream) override; /*! * Write the component info. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeComponentInfo(QTextStream& stream) override; /*! * Write component kactus2 attributes. * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeKactusAttributes(QTextStream& stream, int subHeaderNumber) override; /*! * Write the table of contents header. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeTableOfContentsHeader(QTextStream& stream) override; /*! * Write the table of contents of the current component. * - * @param [in] stream The text stream to write into. + * @param [in] stream The text stream to write into. */ void writeTableOfContents(QTextStream& stream) override; /*! * Write the parameters of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeParameters(QTextStream& stream, int subHeaderNumber) override; /*! * Write the memory maps of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeMemoryMaps(QTextStream& stream, int subHeaderNumber) override; /*! * Write the given address blocks * - * @param [in] stream The text stream to write into. - * @param [in] addressBlocks The address blocks to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. + * @param [in] stream The text stream to write into. + * @param [in] addressBlocks The address blocks to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. */ void writeAddressBlocks(QTextStream& stream, QList > addressBlocks, int subHeaderNumber,int memoryMapNumber) override; @@ -114,10 +114,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the given register files * - * @param [in] stream The text stream to write into. - * @param [in] registerFiles The registers to be written. - * @param [in] subHeaderNumbers The current subheader number. - * @param [out] registerDataNumber The current address block number. + * @param [in] stream The text stream to write into. + * @param [in] registerFiles The registers to be written. + * @param [in] subHeaderNumbers The current subheader number. + * @param [out] registerDataNumber The current address block number. */ void writeRegisterFiles(QTextStream& stream, QList > registerFiles, @@ -126,11 +126,11 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the given registers * - * @param [in] stream The text stream to write into. - * @param [in] registers The registers to be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] memoryMapNumber The current memory map number. - * @param [in] addressBlockNumber The current address block number. + * @param [in] stream The text stream to write into. + * @param [in] registers The registers to be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] memoryMapNumber The current memory map number. + * @param [in] addressBlockNumber The current address block number. */ void writeRegisters(QTextStream& stream, QList > registers, int subHeaderNumber, int memoryMapNumber, int addressBlockNumber, int& registerDataNumber) override; @@ -138,9 +138,9 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the given register fields * - * @param [in] stream The text stream to write into. - * @param [in] register The register whose fields are to be written. - * @param [in] registerSubHeaderNumbers The parent register's subheader numbering. + * @param [in] stream The text stream to write into. + * @param [in] register The register whose fields are to be written. + * @param [in] registerSubHeaderNumbers The parent register's subheader numbering. */ void writeFields(QTextStream& stream, QSharedPointer currentRegister, QList registerSubHeaderNumbers) override; @@ -148,41 +148,41 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the ports of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writePorts(QTextStream& stream, int subHeaderNumber) override; /*! * Write the bus interfaces of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeInterfaces(QTextStream& stream, int& subHeaderNumber) override; /*! * Write the file sets of the component * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. */ void writeFileSets(QTextStream& stream, int& subHeaderNumber) override; /*! * Set the number of the component in the hierarchy * - * @param [in] componentNumber The new component number. + * @param [in] componentNumber The new component number. */ void setComponentNumber(int componentNumber) override; /*! * Write a referenced component subheader * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] headerText The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] headerText The displayed header text. + * @param [in] headerId The id for referencing within the document. */ void writeSubHeader(QTextStream& stream, int subHeaderNumber, QString const& title, QString const& headerId) const override; @@ -190,10 +190,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Write a non-referenced component subheader with specified header level * - * @param [in] stream The text stream to write into. - * @param [in] subHeaderNumbers The subheader numbers. - * @param [in] title The displayed header text. - * @param [in] headerId The id for referencing within the document. + * @param [in] stream The text stream to write into. + * @param [in] subHeaderNumbers The subheader numbers. + * @param [in] title The displayed header text. + * @param [in] headerId The id for referencing within the document. */ void writeSubHeader(QTextStream& stream, QList const& subHeaderNumbers, QString const& title, int level) const override; @@ -201,34 +201,34 @@ class MarkdownWriter : public DocumentationWriter /*! * Write a description text * - * @param [in] stream The text stream to write into. - * @param [in] description The description to write. + * @param [in] stream The text stream to write into. + * @param [in] description The description to write. */ void writeDescription(QTextStream& stream, QString const& description) override; /*! * Write a paragraph in which specific information is listed. * - * @param [in] stream The text stream to write into. - * @param [in] names The info item names. - * @param [in] values The info item values. + * @param [in] stream The text stream to write into. + * @param [in] names The info item names. + * @param [in] values The info item values. */ void writeInfoParagraph(QTextStream& stream, QStringList const& names, QStringList const& values) override; /*! * Write an error text to the document. * - * @param [in] stream The text stream to write into.. - * @param [in] message The description to write. + * @param [in] stream The text stream to write into.. + * @param [in] message The description to write. */ void writeErrorMessage(QTextStream& stream, QString const& message) override; /*! * Write the document contained within the selected VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] documentType Type of the document. - * @param [in] vlnvReference VLNV of the selected document. + * @param [in] stream Text stream to write the document. + * @param [in] documentType Type of the document. + * @param [in] vlnvReference VLNV of the selected document. */ void writeDocumentReference(QTextStream& stream, QString const& documentType, QSharedPointer vlnvReference) override; @@ -236,10 +236,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the design diagram. * - * @param [in] stream Text stream to write the diagram to. - * @param [in] title Diagram title. - * @param [in] link Diagram picture link or path. - * @param [in] altText Diagram alt text. + * @param [in] stream Text stream to write the diagram to. + * @param [in] title Diagram title. + * @param [in] link Diagram picture link or path. + * @param [in] altText Diagram alt text. */ void writeDiagram(QTextStream& stream, QString const& title, QString const& link, QString const& altText) override; @@ -247,9 +247,9 @@ class MarkdownWriter : public DocumentationWriter /*! * Write the component instances contained within the selected design. * - * @param [in] stream Text stream to write the component instances. - * @param [in] design The selected design. - * @param [in] configuration The selected design configuration. + * @param [in] stream Text stream to write the component instances. + * @param [in] design The selected design. + * @param [in] configuration The selected design configuration. */ void writeDesignInstances(QTextStream& stream, QSharedPointer design, QSharedPointer configuration) override; @@ -257,7 +257,7 @@ class MarkdownWriter : public DocumentationWriter /*! * Empty function for markdown writing. * - * @param [in] stream The text stream to write the documentation into. + * @param [in] stream The text stream to write the documentation into. */ void writeEndOfDocument(QTextStream& stream) override; @@ -266,82 +266,82 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes a table of registers. * - * @param [in] stream The text stream to write into. - * @param [in] registers The registers to be written. + * @param [in] stream The text stream to write into. + * @param [in] registers The registers to be written. */ void writeRegisterTable(QTextStream& stream, QList >registers) const; /*! * Writes a table of register fields. * - * @param [in] stream The text stream to write into. - * @param [in] reg The register whose fields are written. + * @param [in] stream The text stream to write into. + * @param [in] reg The register whose fields are written. */ void writeFieldTable(QTextStream& stream, QSharedPointer reg) const; /*! * Writes the enumerations of a field. * - * @param [in] stream The text stream to write into. - * @param [in] field The field which enumerations are written. + * @param [in] stream The text stream to write into. + * @param [in] field The field which enumerations are written. */ void writeFieldEnumerations(QTextStream& stream, QSharedPointer field) override; /*! * Writes a table row with specified cells to a MD table. * - * @param [in] stream Text stream to write to. - * @param [in] cells Table row cells. + * @param [in] stream Text stream to write to. + * @param [in] cells Table row cells. */ void writeTableRow(QTextStream& stream, QStringList const& cells) const; /*! * Writes a table separator to a MD table. * - * @param [in] stream Text stream to write to. - * @param [in] columns Number of columns. + * @param [in] stream Text stream to write to. + * @param [in] columns Number of columns. */ void writeTableSeparator(QTextStream& stream, int columns) const; /*! * Writes the table header cells and the separator. * - * @param [in] stream Text stream to write to. - * @param [in] headers The table headers. + * @param [in] stream Text stream to write to. + * @param [in] headers The table headers. */ void writeTableHeader(QTextStream& stream, QStringList const& headers) const; /*! * Writes a port table for specified ports. * - * @param [in] stream Text stream to write to. - * @param [in] ports The ports to be written. + * @param [in] stream Text stream to write to. + * @param [in] ports The ports to be written. */ void writePortTable(QTextStream& stream, QList > ports) const; /*! * Writes group identifiers for a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set to write identifiers for. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set to write identifiers for. */ void writeFileSetGroupdIdentifiers(QTextStream& stream, QSharedPointer fileSet) const; /*! * Writes the default file builders for a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set to write file builders for. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set to write file builders for. */ void writeDefaultFileBuilders(QTextStream& stream, QSharedPointer fileSet) const; /*! * Writes the files of a file set. * - * @param [in] stream Text stream to write to. - * @param [in] fileSet File set whose files will be written. - * @param [in] subHeaderNumber The current subheader number. - * @param [in] fileSetNumber The current file set number. + * @param [in] stream Text stream to write to. + * @param [in] fileSet File set whose files will be written. + * @param [in] subHeaderNumber The current subheader number. + * @param [in] fileSetNumber The current file set number. */ void writeFiles(QTextStream& stream, QSharedPointer fileSet, int subHeaderNumber, int fileSetNumber); @@ -349,16 +349,16 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes a specified file of a file set. * - * @param [in] stream Text stream to write to. - * @param [in] file File to be written. + * @param [in] stream Text stream to write to. + * @param [in] file File to be written. */ void writeSingleFile(QTextStream& stream, QSharedPointer file) const; /*! * Writes the implementation details of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ void writeImplementationDetails(QTextStream& stream, QSharedPointer instantiation) override; @@ -366,8 +366,8 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes the file set references contained within a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. */ void writeFileSetReferences(QTextStream& stream, QSharedPointer instantiation) override; @@ -375,9 +375,9 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes the file build commands of a component instantiation. * - * @param [in] stream Text stream to write to. - * @param [in] instantiation The component instantiation. - * @param [in] formatter The expression formatter for the component instantiation. + * @param [in] stream Text stream to write to. + * @param [in] instantiation The component instantiation. + * @param [in] formatter The expression formatter for the component instantiation. */ void writeFileBuildCommands(QTextStream& stream, QSharedPointer instantiation, QSharedPointer formatter) override; @@ -385,10 +385,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes given parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table - * @param [in] parameters The parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table + * @param [in] parameters The parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ void writeParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > parameters, @@ -397,10 +397,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes given module parameters to a table. * - * @param [in] stream Text stream to write to. - * @param [in] tableHeading The heading above the table. - * @param [in] moduleParameters The module parameters to be written. - * @param [in] formatter The expression formatter for the parameters. + * @param [in] stream Text stream to write to. + * @param [in] tableHeading The heading above the table. + * @param [in] moduleParameters The module parameters to be written. + * @param [in] formatter The expression formatter for the parameters. */ void writeModuleParameterTable(QTextStream& stream, QString const& tableHeading, QSharedPointer > > moduleParameters, @@ -409,10 +409,10 @@ class MarkdownWriter : public DocumentationWriter /*! * Writes the configurable element values of a VLNV. * - * @param [in] stream Text stream to write the document. - * @param [in] vlnvReference Configurable VLNV containing the selected configurable element + * @param [in] stream Text stream to write the document. + * @param [in] vlnvReference Configurable VLNV containing the selected configurable element * values. - * @param [in] instantiationFormatter Expression formatter for the configurable element values. + * @param [in] instantiationFormatter Expression formatter for the configurable element values. */ void writeConfigurableElementValues(QTextStream& stream, QSharedPointer vlnvReference, @@ -421,9 +421,9 @@ class MarkdownWriter : public DocumentationWriter /*! * Gets the configurable element values of a component instance as a line-broken string. * - * @param [in] stream Text stream to write the document. - * @param [in] instance The component instance. - * @param [in] design The design in which the component instance is. + * @param [in] stream Text stream to write the document. + * @param [in] instance The component instance. + * @param [in] design The design in which the component instance is. */ QString getComponentInstanceConfigurableElements(QSharedPointer instance, QSharedPointer design); diff --git a/kactusGenerators/DocumentGenerator/documentgenerator.h b/kactusGenerators/DocumentGenerator/documentgenerator.h index a5ac7ac9b..20666a245 100644 --- a/kactusGenerators/DocumentGenerator/documentgenerator.h +++ b/kactusGenerators/DocumentGenerator/documentgenerator.h @@ -55,12 +55,12 @@ class DocumentGenerator : public QObject /*! * The constructor. * - * @param [in] handler Library, where the components reside. - * @param [in] vlnv VLNV of the component or design. - * @param [in] designWidgetFactory Factory for making design widgets. - * @param [in] expressionFormatterFactory Factory for making expression formatters. - * @param [in] componentNumber Component number for current generator - * @param [in] parent The parent widget of the generator. + * @param [in] handler Library, where the components reside. + * @param [in] vlnv VLNV of the component or design. + * @param [in] designWidgetFactory Factory for making design widgets. + * @param [in] expressionFormatterFactory Factory for making expression formatters. + * @param [in] componentNumber Component number for current generator + * @param [in] parent The parent widget of the generator. */ DocumentGenerator(LibraryInterface* handler, const VLNV& vlnv, DesignWidgetFactory* designWidgetFactory, ExpressionFormatterFactory* expressionFormatterFactory, int componentNumber, QWidget* parent); @@ -73,73 +73,73 @@ class DocumentGenerator : public QObject /*! * Set the document format * - * @param [in] format The document file format + * @param [in] format The document file format */ void setFormat(DocumentFormat format); /*! * Write the documentation to the selected stream. * - * @param [in] stream The stream where to write. - * @param [in] targetPath The path where the document will be placed. + * @param [in] stream The stream where to write. + * @param [in] targetPath The path where the document will be placed. */ void writeDocumentation(QTextStream& stream, QString targetPath); /*! * Write the document header. * - * @param [in] stream The text stream to write the header into. + * @param [in] stream The text stream to write the header into. */ void writeHeader(QTextStream& stream); /*! * Write the table of contents for the component the generator is working on. * - * @param [in] componentNumber The number for this component. - * @param [in] stream The text stream to write the table of contents into. + * @param [in] componentNumber The number for this component. + * @param [in] stream The text stream to write the table of contents into. */ void writeTableOfContents(QTextStream& stream); /*! * Write the documentation for the given component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] targetPath File path to the file to be written. - * @param [in] filesToInclude List of file names that contain pictures needed to display the document. + * @param [in] stream The text stream to write the documentation into. + * @param [in] targetPath File path to the file to be written. + * @param [in] filesToInclude List of file names that contain pictures needed to display the document. */ void writeDocumentation(QTextStream& stream, const QString& targetPath, QStringList& filesToInclude); /*! * Write the kactus2 attributes of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub-header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub-header. */ void writeKactusAttributes(QTextStream& stream, int& subHeaderNumber); /*! * Write the parameters of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub-header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub-header. */ void writeParameters(QTextStream& stream, int& subHeaderNumber); /*! * Write the memory maps of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. */ void writeMemoryMaps(QTextStream& stream, int& subHeaderNumber); /*! * Write the address blocks of the memory map. * - * @param [in] addressBlocks The list of the address blocks. - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. - * @param [in] memoryMapNumber The number for the memory map, whose address blocks are written. + * @param [in] addressBlocks The list of the address blocks. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] memoryMapNumber The number for the memory map, whose address blocks are written. */ void writeAddressBlocks(QList > addressBlocks, QTextStream& stream, int subHeaderNumber, int memoryMapNumber); @@ -147,11 +147,11 @@ class DocumentGenerator : public QObject /*! * Write the registers of the address block. * - * @param [in] registers The list of registers. - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. - * @param [in] memoryMapNumber The number that defines the memory map. - * @param [in] addressBlockNumber The number that defines the address block. + * @param [in] registers The list of registers. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] memoryMapNumber The number that defines the memory map. + * @param [in] addressBlockNumber The number that defines the address block. */ void writeRegisters(QList > registers, QTextStream& stream, int subHeaderNumber, int memoryMapNumber, int addressBlockNumber, int registerDataNumber); @@ -159,55 +159,55 @@ class DocumentGenerator : public QObject /*! * Write the fields of the register. * - * @param [in] currentRegister The register, whose fields are to be written. - * @param [in] stream The text stream to write the documentation into. + * @param [in] currentRegister The register, whose fields are to be written. + * @param [in] stream The text stream to write the documentation into. */ void writeFields(QSharedPointer currentRegister, QTextStream& stream, QList subHeaderNumbers); /*! * Write the ports of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. */ void writePorts(QTextStream& stream, int& subHeaderNumber); /*! * Write the interfaces of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. */ void writeInterfaces(QTextStream& stream, int& subHeaderNumber); /*! * Write the file sets of the component. * - * @param [in] stream The text stream to write the documentation into. - * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] stream The text stream to write the documentation into. + * @param [in] subHeaderNumber The number that defines the sub header. */ void writeFileSets(QTextStream& stream, int& subHeaderNumber); /*! * Write the views of the component. * - * @param [in] stream The text stream to write the component views. - * @param [in] subHeaderNumber The number that defines the sub header. - * @param [in] pictureList List of file names to add the pictures of the referenced designs to. + * @param [in] stream The text stream to write the component views. + * @param [in] subHeaderNumber The number that defines the sub header. + * @param [in] pictureList List of file names to add the pictures of the referenced designs to. */ void writeViews(QTextStream& stream, int& subHeaderNumber, QStringList& pictureList); /*! * Write the end of the document, if the format requires it. * - * @param [in] stream The text stream to write the documentation into. + * @param [in] stream The text stream to write the documentation into. */ void writeEndOfDocument(QTextStream& stream); /*! * Sets the images folder path. * - * @param [in] path The new images path. + * @param [in] path The new images path. */ void setImagesPath(QString const& path); @@ -216,14 +216,14 @@ class DocumentGenerator : public QObject /*! * Print an error message to the user. * - * @param [in] errorMessage Selected error message. + * @param [in] errorMessage Selected error message. */ void errorMessage(const QString& errorMessage); /*! * Print a notification to the user. * - * @param [in] noticeMessage Selected notification. + * @param [in] noticeMessage Selected notification. */ void noticeMessage(const QString& noticeMessage); @@ -235,11 +235,11 @@ class DocumentGenerator : public QObject /*! * Write the selected view. * - * @param [in] stream The text stream to write the view. - * @param [in] view The selected view. - * @param [in] subHeaderNumber Number for the sub header. - * @param [in] viewNumber Number defining the selected view. - * @param [in] pictureList List of file names to add the pictures of the referenced designs to. + * @param [in] stream The text stream to write the view. + * @param [in] view The selected view. + * @param [in] subHeaderNumber Number for the sub header. + * @param [in] viewNumber Number defining the selected view. + * @param [in] pictureList List of file names to add the pictures of the referenced designs to. */ void writeSingleView(QTextStream& stream, QSharedPointer view, int const& subHeaderNumber, int const& viewNumber, QStringList& pictureList); @@ -247,11 +247,11 @@ class DocumentGenerator : public QObject /*! * Write the referenced component instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] instantiationReference Name of the selected component instantiation. - * @param [in] subHeaderNumber Number for the sub header. - * @param [in] viewNumber Number defining the selected view. - * @param [in] instantiationNumber Number defining the component instantiation. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] instantiationReference Name of the selected component instantiation. + * @param [in] subHeaderNumber Number for the sub header. + * @param [in] viewNumber Number defining the selected view. + * @param [in] instantiationNumber Number defining the component instantiation. */ void writeReferencedComponentInstantiation(QTextStream& stream, QString const& instantiationReference, int const& subHeaderNumber, int const& viewNumber, int const& instantiationNumber); @@ -259,11 +259,11 @@ class DocumentGenerator : public QObject /*! * Write the referenced design configuration instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] configurationReference Name of the selected design configuration instantiation. - * @param [in] subHeaderNumber Number for the sub header. - * @param [in] viewNumber Number defining the selected view. - * @param [in] instantiationNumber Number defining the component instantiation. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] configurationReference Name of the selected design configuration instantiation. + * @param [in] subHeaderNumber Number for the sub header. + * @param [in] viewNumber Number defining the selected view. + * @param [in] instantiationNumber Number defining the component instantiation. */ void writeReferencedDesignConfigurationInstantiation(QTextStream& stream, QString const& configurationReference, int const& subHeaderNumber, int const& viewNumber, @@ -271,11 +271,11 @@ class DocumentGenerator : public QObject /*! * Write the referenced design instantiation. * - * @param [in] stream Text stream to write the component instantiation. - * @param [in] designReference Name of the selected design instantiation. - * @param [in] subHeaderNumber Number for the sub header. - * @param [in] viewNumber Number defining the selected view. - * @param [in] instantiationNumber Number defining the component instantiation. + * @param [in] stream Text stream to write the component instantiation. + * @param [in] designReference Name of the selected design instantiation. + * @param [in] subHeaderNumber Number for the sub header. + * @param [in] viewNumber Number defining the selected view. + * @param [in] instantiationNumber Number defining the component instantiation. */ void writeReferencedDesignInstantiation(QTextStream& stream, QString const& designReference, int const& subHeaderNumber, int const& viewNumber, int const& instantiationNumber); @@ -283,45 +283,45 @@ class DocumentGenerator : public QObject /*! * Write the design diagram referenced by the design instantiation or the design configuration. * - * @param [in] stream Text stream to write the design diagram. - * @param [in] viewTabs Design diagram indentation in the file. - * @param [in] view View containing the design and design configuration references. - * @param [in] pictureList List of file names to add the pictures of the referenced designs to. + * @param [in] stream Text stream to write the design diagram. + * @param [in] viewTabs Design diagram indentation in the file. + * @param [in] view View containing the design and design configuration references. + * @param [in] pictureList List of file names to add the pictures of the referenced designs to. */ void writeDesign(QTextStream& stream, QSharedPointer view, QStringList& pictureList); /*! * Create a picture for the design * - * @param [in] pictureList List of file names to add the path of the created picture to. - * @param [in] viewName Name of the view to create the design picture for. + * @param [in] pictureList List of file names to add the path of the created picture to. + * @param [in] viewName Name of the view to create the design picture for. */ void createDesignPicture(QStringList& pictureList, QString const& viewName, QString const& designPicPath); /*! * Get the selected design instantiation. * - * @param [in] designReference Name of the selected design instantiation. + * @param [in] designReference Name of the selected design instantiation. * - * @return The design instantiation + * @return The design instantiation */ QSharedPointer getDesignInstantiation(QString const& designReference) const; /*! * Get the referenced component instantiation. * - * @param [in] instantiationReference Name of the selected component instantiation. + * @param [in] instantiationReference Name of the selected component instantiation. * - * @return Component instantiation containing the selected name. + * @return Component instantiation containing the selected name. */ QSharedPointer getComponentInstantiation(QString const& instantiationReference) const; /*! * Get the selected module parameters as a list of parameters. * - * @param [in] moduleParameters The selected module parameters. + * @param [in] moduleParameters The selected module parameters. * - * @return The module parameters as a list of parameters + * @return The module parameters as a list of parameters */ QSharedPointer > > getModuleParametersAsParameters( QSharedPointer > > moduleParameters) const; @@ -329,9 +329,9 @@ class DocumentGenerator : public QObject /*! * Get the selected design configuration instantiation. * - * @param [in] instantiationReference Name of the selected design configuration instantiation. + * @param [in] instantiationReference Name of the selected design configuration instantiation. * - * @return The selected design configuration instantiation + * @return The selected design configuration instantiation */ QSharedPointer getDesignConfigurationInstantiation( QString const& instantiationReference) const; @@ -339,18 +339,18 @@ class DocumentGenerator : public QObject /*! * Get the design configuration referenced by the selected view. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return The design configuration referenced by the selected view. + * @return The design configuration referenced by the selected view. */ QSharedPointer getDesignConfiguration(QSharedPointer view) const; /*! * Get the design referenced by the selected view. * - * @param [in] view The selected view. + * @param [in] view The selected view. * - * @return The design referenced by the selected view. + * @return The design referenced by the selected view. */ QSharedPointer getDesign(QSharedPointer view, QSharedPointer configuration) const; @@ -358,7 +358,7 @@ class DocumentGenerator : public QObject /*! * Parse the child items for the document generator. * - * @param [in] objects List of objects that have already been parsed so there won't be duplicate + * @param [in] objects List of objects that have already been parsed so there won't be duplicate * components in the generated document. */ void parseChildItems(QList& objects, int& currentComponentNumber); @@ -366,7 +366,7 @@ class DocumentGenerator : public QObject /*! * Create a picture for the component. * - * @param [in] pictureList List of file names to add the path of the created picture to. + * @param [in] pictureList List of file names to add the path of the created picture to. */ void createComponentPicture(QStringList& pictureList); diff --git a/library/HierarchyView/hierarchyfilter.h b/library/HierarchyView/hierarchyfilter.h index 5653ab974..5abb77c60 100644 --- a/library/HierarchyView/hierarchyfilter.h +++ b/library/HierarchyView/hierarchyfilter.h @@ -33,8 +33,8 @@ class HierarchyFilter : public LibraryFilter /*! The constructor * - * @param [in] libraryAccess Access interface to the library. - * @param [in] parent Pointer to the owner of this filter. + * @param [in] libraryAccess Access interface to the library. + * @param [in] parent Pointer to the owner of this filter. */ HierarchyFilter(LibraryInterface* libraryAccess, QObject *parent); @@ -51,10 +51,10 @@ class HierarchyFilter : public LibraryFilter /*! Validate the given row on a parent and check if item should be shown. * - * @param [in] source_row The row number of the child on the parent. - * @param [in] source_parent Model index that identifies the parent object. + * @param [in] source_row The row number of the child on the parent. + * @param [in] source_parent Model index that identifies the parent object. * - * @return bool True if object should be displayed. + * @return bool True if object should be displayed. */ virtual bool filterAcceptsRow(int sourceRow, QModelIndex const& sourceParent) const override final; diff --git a/library/HierarchyView/hierarchyview.h b/library/HierarchyView/hierarchyview.h index 1b84ddb9d..c828ed068 100644 --- a/library/HierarchyView/hierarchyview.h +++ b/library/HierarchyView/hierarchyview.h @@ -36,9 +36,9 @@ class HierarchyView : public ExpandingTreeView /*! The constructor * - * @param [in] parent The owner of this widget. - * @param [in] handler The instance that manages the library. - * @param [in] filter The instance that does sorting and filtering. + * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] filter The instance that does sorting and filtering. */ HierarchyView(QWidget *parent, LibraryInterface* handler, HierarchyFilter* filter); @@ -47,7 +47,7 @@ class HierarchyView : public ExpandingTreeView /*! Select the item with given indexes in the view. * - * @param [in] indexes List in model indexes to select. + * @param [in] indexes List in model indexes to select. */ void setSelectedIndexes(const QModelIndexList& indexes); @@ -77,7 +77,7 @@ public slots: /*! Set the index to be the current index and select and expand it. * - * @param [in] index Specified the index to be set as the current index. + * @param [in] index Specified the index to be set as the current index. * */ virtual void setCurrentIndex(QModelIndex const& index); @@ -147,7 +147,7 @@ public slots: /*! Handler for the context menu events. * - * @param [in] event The contextMenuEvent to be handled. + * @param [in] event The contextMenuEvent to be handled. */ virtual void contextMenuEvent(QContextMenuEvent* event); diff --git a/library/HierarchyView/hierarchywidget.h b/library/HierarchyView/hierarchywidget.h index 00e5d3ff0..03e7c561d 100644 --- a/library/HierarchyView/hierarchywidget.h +++ b/library/HierarchyView/hierarchywidget.h @@ -33,9 +33,9 @@ class HierarchyWidget : public QWidget /*! The constructor * - * @param [in] parent The owner of this widget. - * @param [in] handler The instance that manages library. - * @param [in] dataModel The model that provides data to view and filter. + * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages library. + * @param [in] dataModel The model that provides data to view and filter. */ HierarchyWidget(LibraryInterface* handler, HierarchyModel* dataModel, QWidget* parent); @@ -44,14 +44,14 @@ class HierarchyWidget : public QWidget /*! Select the library items that represent the given vlnv. * - * @param [in] vlnv Identifies the objects to select. + * @param [in] vlnv Identifies the objects to select. */ void selectItems(const VLNV& vlnv); /*! * Gets the filter for the tree model. * - * @return The filter in use. + * @return The filter in use. */ LibraryFilter* getFilter() const; diff --git a/library/ItemExporter.h b/library/ItemExporter.h index a85207dbb..875368375 100644 --- a/library/ItemExporter.h +++ b/library/ItemExporter.h @@ -41,9 +41,9 @@ class ItemExporter : public QObject /*! * The constructor. * - * @param [in] libraryAccess Access to the library. - * @param [in] dialogParentWidget Parent widget for the export dialog. - * @param [in] parent The parent object. + * @param [in] libraryAccess Access to the library. + * @param [in] dialogParentWidget Parent widget for the export dialog. + * @param [in] parent The parent object. */ ItemExporter(LibraryInterface* libraryAccess, QWidget* dialogParentWidget, QObject* parent = nullptr); @@ -62,14 +62,14 @@ public slots: /*! * Export a library item and it's subitems to a new location. * - * @param [in] vlnv VLNV tag that identifies the top item to export. + * @param [in] vlnv VLNV tag that identifies the top item to export. */ void onExportItem(VLNV const& vlnv); /*! * Export a group of items to a new location * - * @param [in] vlnvs QList containing the VLNVs that are to be exported. + * @param [in] vlnvs QList containing the VLNVs that are to be exported. */ void onExportItems(const QList vlnvs); @@ -99,10 +99,10 @@ public slots: /*! * Export the selected objects. * - * @param [in] exportedItems The selected items to be exported. - * @param [in] destinationPath The export destination path. + * @param [in] exportedItems The selected items to be exported. + * @param [in] destinationPath The export destination path. * - * @return The count of the exported items in a pair of 1. VLNVs and 2. files. + * @return The count of the exported items in a pair of 1. VLNVs and 2. files. */ DocumentStatistics exportSelectedObjects(QVector const& exportedItems, QString const& destinationPath); @@ -110,10 +110,10 @@ public slots: /*! * Get the selected exported files of the current component. * - * @param [in] componentIndex Index of the selected component. - * @param [in] exportedItems List of all the selected export items. + * @param [in] componentIndex Index of the selected component. + * @param [in] exportedItems List of all the selected export items. * - * @return List of the exported files of the current component. + * @return List of the exported files of the current component. */ QVector getExportedFilesForComponent(int const& componentIndex, QVector const& exportedItems) const; @@ -121,14 +121,14 @@ public slots: /*! * Export the selected component document. * - * @param [in] component The selected component. - * @param [in] exportedComponentFiles Selected files to be exported with the component. - * @param [in] destinationFolder Destination folder for the export. - * @param [in] handledFiles List of exported files. - * @param [in] selections Selections for overwriting existing files. - * @param [in] exportStatistics Export statistics. + * @param [in] component The selected component. + * @param [in] exportedComponentFiles Selected files to be exported with the component. + * @param [in] destinationFolder Destination folder for the export. + * @param [in] handledFiles List of exported files. + * @param [in] selections Selections for overwriting existing files. + * @param [in] exportStatistics Export statistics. * - * @return True, if the export was a success, false otherwise. + * @return True, if the export was a success, false otherwise. */ bool exportComponent(QSharedPointer component, QVector exportedComponentFiles, QDir const& destinationFolder, @@ -137,11 +137,11 @@ public slots: /*! * Change the path of the selected file. * - * @param [in] file The selected file. - * @param [in] containingFileSet File set containing the file. - * @param [in] originalComponent The original component. - * @param [in] originalComponentPath Path to the original component. - * @param [in] destinationFolder Destination folder for the export. + * @param [in] file The selected file. + * @param [in] containingFileSet File set containing the file. + * @param [in] originalComponent The original component. + * @param [in] originalComponentPath Path to the original component. + * @param [in] destinationFolder Destination folder for the export. */ void changeFilePath(QSharedPointer file, QSharedPointer containingFileSet, QSharedPointer originalComponent, QString const& originalComponentPath, @@ -150,12 +150,12 @@ public slots: /*! * Export the selected VLNV object. * - * @param [in] destinationFolder Destination folder for the export. - * @param [in] vlnv VLNV of the exported item. - * @param [in] handledFiles List of the files that have been handled. - * @param [in] selections Container for yes/no to all status. + * @param [in] destinationFolder Destination folder for the export. + * @param [in] vlnv VLNV of the exported item. + * @param [in] handledFiles List of the files that have been handled. + * @param [in] selections Container for yes/no to all status. * - * @return True, if the selected VLNV object was exported, false otherwise. + * @return True, if the selected VLNV object was exported, false otherwise. */ bool exportObject(QDir const& destinationFolder, VLNV const& vlnv, FileList& handledFiles, InputSelection &selections); @@ -163,15 +163,15 @@ public slots: /*! * Copy a single file. * - * @param [in] itemType Type of the copied file. - * @param [in] source The source file to be copied - * @param [in] containingVLNV VLNV of the containing document. - * @param [in/out] targetDirectory The directory where the file is copied to. - * @param [in/out] handledFiles List of files that have been copied - * @param [in/out] yesToAll Info if user has selected "yes to all" to overwrite - * @param [in/out] noToAll Info is user has selected "No to all" to overwrite + * @param [in] itemType Type of the copied file. + * @param [in] source The source file to be copied + * @param [in] containingVLNV VLNV of the containing document. + * @param [in/out] targetDirectory The directory where the file is copied to. + * @param [in/out] handledFiles List of files that have been copied + * @param [in/out] yesToAll Info if user has selected "yes to all" to overwrite + * @param [in/out] noToAll Info is user has selected "No to all" to overwrite * - * @return True, if the file was copied, false otherwise. + * @return True, if the file was copied, false otherwise. */ bool copyFile(ObjectSelectionListItem::ItemType itemType, QFileInfo const& source, VLNV const& containingVLNV, QDir& targetDirectory, FileList& handledFiles, InputSelection& selections); @@ -179,21 +179,21 @@ public slots: /*! * Set the action for overwriting an existing file. * - * @param [in] targetFileName Name of the selected file. - * @param [in] selections Selections made for overwriting an existing file. + * @param [in] targetFileName Name of the selected file. + * @param [in] selections Selections made for overwriting an existing file. * - * @return True, if the existing file is to be overwritten, false otherwise. + * @return True, if the existing file is to be overwritten, false otherwise. */ bool setActionForExistingFile(QString const& targetFileName, InputSelection& selections) const; /*! * Create the export message. * - * @param [in] vlnvCount The amount of exported VLNV items. - * @param [in] fileCount The amount of exported files. - * @param [in] destinationPath The export destination. + * @param [in] vlnvCount The amount of exported VLNV items. + * @param [in] fileCount The amount of exported files. + * @param [in] destinationPath The export destination. * - * @return The constructed export message. + * @return The constructed export message. */ QString createExportMessage(DocumentStatistics const& exportStatistics, QString const& destinationPath) const; diff --git a/library/LibraryErrorModel.h b/library/LibraryErrorModel.h index 0644710f3..8652ef236 100644 --- a/library/LibraryErrorModel.h +++ b/library/LibraryErrorModel.h @@ -31,7 +31,7 @@ class LibraryErrorModel : public QAbstractTableModel /*! * Constructor. * - * @param [in] parent The owner of this model. + * @param [in] parent The owner of this model. */ LibraryErrorModel(QObject* parent); @@ -55,35 +55,35 @@ class LibraryErrorModel : public QAbstractTableModel /*! * Returns the number of rows to be displayed. * - * @param [in] parent Identifies the parent. Must always be a invalid index. + * @param [in] parent Identifies the parent. Must always be a invalid index. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const override final; /*! * Returns the number of columns to display. * - * @param [in] parent Identifies the parent. Must always be a invalid index. + * @param [in] parent Identifies the parent. Must always be a invalid index. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const override final; /*! * Returns that data for specified index in given data role. * - * @param [in] index Identifies the object that's data is wanted. - * @param [in] role Identifies the type of data being requested. + * @param [in] index Identifies the object that's data is wanted. + * @param [in] role Identifies the type of data being requested. * - * @return QVariant containing the requested data. + * @return QVariant containing the requested data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override final; /*! * Returns the data for given header in given data role. * - * @param [in] section Identifies the header section. - * @param [in] orientation Only Qt::Horizontal is supported. - * @param [in] role Identifies the type of the data being requested. + * @param [in] section Identifies the header section. + * @param [in] orientation Only Qt::Horizontal is supported. + * @param [in] role Identifies the type of the data being requested. * - * @return QVariant contains the requested data. + * @return QVariant contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override final; @@ -91,9 +91,9 @@ class LibraryErrorModel : public QAbstractTableModel /*! * Retrieves info on what operations are possible for specified item. * - * @param [in] index Identifies the item that's operations are requested. + * @param [in] index Identifies the item that's operations are requested. * - * @return Item flags containing info on which operations are available for the given index. + * @return Item flags containing info on which operations are available for the given index. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const override final; diff --git a/library/LibraryFilter.h b/library/LibraryFilter.h index c97aab05d..6dfc267ff 100644 --- a/library/LibraryFilter.h +++ b/library/LibraryFilter.h @@ -36,10 +36,10 @@ class LibraryFilter : public QSortFilterProxyModel /*! * The constructor. * - * @param [in] libraryAccess Access to the library. - * @param [in] parent The parent object. + * @param [in] libraryAccess Access to the library. + * @param [in] parent The parent object. * - * @return . + * @return . */ LibraryFilter(LibraryInterface* libraryAccess, QObject *parent = 0); @@ -78,7 +78,7 @@ public slots: /*! * Handler for changing the filtered tags. * - * @param [in] filteredTags The new visible tags. + * @param [in] filteredTags The new visible tags. */ void onTagFilterChanged(QVector filteredTags); @@ -86,31 +86,31 @@ public slots: /*! Checks if the row should be shown in the view or not. * - * @param [in] sourceRow Specifies the row number of the item - * @param [in] sourceParent Specifies the parent of the item. + * @param [in] sourceRow Specifies the row number of the item + * @param [in] sourceParent Specifies the parent of the item. * - * @return True if item is shown. + * @return True if item is shown. */ virtual bool filterAcceptsRow(int sourceRow, QModelIndex const& sourceParent) const = 0; /*! * Gets the current firmness filter. * - * @return The firmness filter. + * @return The firmness filter. */ Utils::FirmnessOptions firmness() const; /*! * Gets the current implementation filter. * - * @return The implementation filter. + * @return The implementation filter. */ Utils::ImplementationOptions implementation() const; /*! * Gets the current VLNV type filter. * - * @return The VLNV type filter. + * @return The VLNV type filter. */ Utils::TypeOptions type() const; @@ -129,25 +129,25 @@ public slots: * * Check the validity of the selected document. * - * @param [in] document The selected document. + * @param [in] document The selected document. * - * @return True, if the document is valid, false otherwise. + * @return True, if the document is valid, false otherwise. */ bool checkValidity(bool isValid) const; /*! * Check the tag matching of the selected document. * - * @param [in] document The selected document. + * @param [in] document The selected document. * - * @return True, if the tags match the visible tags, false otherwise. + * @return True, if the tags match the visible tags, false otherwise. */ bool checkTags(QSharedPointer document) const; /*! * Get the access to the library. * - * @return Access to the library. + * @return Access to the library. */ LibraryInterface* getLibraryInterface() const; @@ -156,10 +156,10 @@ public slots: /*! * Check if a document contains the selected tag. * - * @param [in] document The selected document. - * @param [in] tag The selected tag. + * @param [in] document The selected document. + * @param [in] tag The selected tag. * - * @return True, if the selected document contains the selected tag, false otherwise. + * @return True, if the selected document contains the selected tag, false otherwise. */ bool documentContainsTag(QSharedPointer document, TagData const& tag) const; diff --git a/library/LibraryItemSelectionFactory.h b/library/LibraryItemSelectionFactory.h index d26b35634..b40d840c4 100644 --- a/library/LibraryItemSelectionFactory.h +++ b/library/LibraryItemSelectionFactory.h @@ -14,8 +14,8 @@ namespace LibraryItemSelectionFactory /*! * Construct the items for the selection dialog. * - * @param [in] dialog The selection dialog. - * @param [in] vlvns List of selectable VLNVs. + * @param [in] dialog The selection dialog. + * @param [in] vlvns List of selectable VLNVs. */ void constructItemsForSelectionDialog(LibraryInterface* library, ObjectSelectionDialog* dialog, QList const& vlvns); diff --git a/library/LibraryTreeFilter.h b/library/LibraryTreeFilter.h index d2cffdf24..2655efda6 100644 --- a/library/LibraryTreeFilter.h +++ b/library/LibraryTreeFilter.h @@ -27,8 +27,8 @@ class LibraryTreeFilter : public LibraryFilter /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] parent The owner of this widget. * */ LibraryTreeFilter(LibraryInterface* handler, QObject *parent = 0); @@ -46,10 +46,10 @@ class LibraryTreeFilter : public LibraryFilter /*! Checks if the row should be shown in the view or not. * - * @param [in] sourceRow Specifies the row number of the item - * @param [in] sourceParent Specifies the parent of the item. + * @param [in] sourceRow Specifies the row number of the item + * @param [in] sourceParent Specifies the parent of the item. * - * @return True if item is shown, otherwise false. + * @return True if item is shown, otherwise false. */ virtual bool filterAcceptsRow(int sourceRow, QModelIndex const& sourceParent) const override final; @@ -58,9 +58,9 @@ class LibraryTreeFilter : public LibraryFilter /*! * Checks if the VLNV should be shown in the view or not based on filters. * - * @param [in] vlnv The VLNV to check. + * @param [in] vlnv The VLNV to check. * - * @return True, if the VLNV should be shown, otherwise false. + * @return True, if the VLNV should be shown, otherwise false. */ bool checkType(VLNV const& vlnv) const; diff --git a/library/LibraryTreeView.h b/library/LibraryTreeView.h index 7e943969b..3d5ecbc3c 100644 --- a/library/LibraryTreeView.h +++ b/library/LibraryTreeView.h @@ -36,9 +36,9 @@ class LibraryTreeView : public ExpandingTreeView /*! The constructor * - * @param [in] handler The instance that manages the library. - * @param [in] filter The class that does the filtering for the view. - * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] filter The class that does the filtering for the view. + * @param [in] parent The owner of this widget. * */ LibraryTreeView(LibraryInterface* handler, LibraryTreeFilter* filter, QWidget* parent = 0); @@ -163,7 +163,7 @@ public slots: /*! Set the index to be the current index and select and expand it. * - * @param [in] index Specified the index to be set as the current index. + * @param [in] index Specified the index to be set as the current index. */ virtual void setCurrentIndex(QModelIndex const& index); @@ -192,7 +192,7 @@ public slots: /*! Handler for the context menu events. * - * @param [in] event The contextMenuEvent to be handled. + * @param [in] event The contextMenuEvent to be handled. */ virtual void contextMenuEvent(QContextMenuEvent* event); diff --git a/library/LibraryTreeWidget.h b/library/LibraryTreeWidget.h index fb74e74e8..1bed60e3d 100644 --- a/library/LibraryTreeWidget.h +++ b/library/LibraryTreeWidget.h @@ -36,9 +36,9 @@ class LibraryTreeWidget : public QWidget * Constructs the library tree view and the filter model for the tree view * and connects the view and filter model to the dataModel. * - * @param [in] handler The instance that manages the library. - * @param [in] dataModel The dataModel instance that holds the data to be displayed in the view. - * @param [in] parent The owner of this widget. + * @param [in] handler The instance that manages the library. + * @param [in] dataModel The dataModel instance that holds the data to be displayed in the view. + * @param [in] parent The owner of this widget. */ LibraryTreeWidget(LibraryInterface* handler, LibraryTreeModel* dataModel, QWidget* parent); @@ -47,14 +47,14 @@ class LibraryTreeWidget : public QWidget /*! Select the library item that is identified by the vlnv. * - * @param [in] vlnv The vlnv that identifies the libraryItem to select. + * @param [in] vlnv The vlnv that identifies the libraryItem to select. */ void selectItem(VLNV const& vlnv); /*! * Gets the filter for the tree model. * - * @return The filter in use. + * @return The filter in use. */ LibraryFilter* getFilter() const; diff --git a/library/LibraryUtils.h b/library/LibraryUtils.h index 5bccb57fe..e85df523f 100644 --- a/library/LibraryUtils.h +++ b/library/LibraryUtils.h @@ -28,9 +28,9 @@ class LibraryInterface; * searches for programmable elements, creates corresponding SW components and * generates a system design. * - * @param [in] lh The library interface. - * @param [in] component The component. - * @param [out] sysDesign The resulted system design. + * @param [in] lh The library interface. + * @param [in] component The component. + * @param [out] sysDesign The resulted system design. */ void generateSystemDesignV2(LibraryInterface* lh, VLNV const& designVLNV, Design& sysDesign); @@ -38,8 +38,8 @@ void generateSystemDesignV2(LibraryInterface* lh, VLNV const& designVLNV, Design * Updates the system design based on the given component. This function reflects * the changes in the HW component and its software mappings to the given system design. * - * @param [in] lh The library interface. - * @param [in,out] sysDesign The system design to update. + * @param [in] lh The library interface. + * @param [in,out] sysDesign The system design to update. */ void updateSystemDesignV2(LibraryInterface* lh, VLNV const& designVLNV, Design& sysDesign, QSharedPointer designConf); diff --git a/library/LibraryWidget.h b/library/LibraryWidget.h index 38f138b25..0677914e0 100644 --- a/library/LibraryWidget.h +++ b/library/LibraryWidget.h @@ -48,8 +48,8 @@ class LibraryWidget : public QWidget /*! The constructor. * - * @param [in] library The IP-XACT library interface. - * @param [in] parent The parent widget. + * @param [in] library The IP-XACT library interface. + * @param [in] parent The parent widget. */ LibraryWidget(LibraryHandler* library, MessageMediator* messageChannel, QWidget* parent = 0); @@ -58,28 +58,28 @@ class LibraryWidget : public QWidget /*! Gets the handle for library access. * - * @return The library access handle. + * @return The library access handle. */ LibraryHandler* getLibraryHandler() const; /*! * Set filter settings for the library. * - * @param [in] settings Settings containing the library filters. + * @param [in] settings Settings containing the library filters. */ void loadFilterSettings(QSettings& settings); /*! * Save settings for dock widget filters. * - * @param [in] settings The settings. + * @param [in] settings The settings. */ void saveFilterSettings(QSettings& settings) const; /*! * Selects the given VLNV in all library views. * - * @param [in] componentVLNV The VLVN to select. + * @param [in] componentVLNV The VLVN to select. */ void selectComponent(VLNV const& componentVLNV) const; @@ -110,20 +110,20 @@ public slots: /*! * Shows errors about the library item with the given VLNV. * - * @param [in] vlnv The VLNV of the library item. + * @param [in] vlnv The VLNV of the library item. */ void onShowErrors(VLNV const& vlnv); /*! Create a new abstraction definition for given bus definition. * - * @param [in] busDefVLNV Identifies the bus definition to create the abs def for. + * @param [in] busDefVLNV Identifies the bus definition to create the abs def for. * */ void onCreateAbsDef(VLNV const& busDefVLNV); /*! Create new design with given vlnv. * - * @param [in] vlnv The vlnv that identifies the design. + * @param [in] vlnv The vlnv that identifies the design. * */ void onCreateDesign(VLNV const& vlnv); @@ -147,7 +147,7 @@ public slots: /*! Connects the given filter to the filtering widget. * - * @param [in} filter The filter to connect. + * @param [in} filter The filter to connect. */ void connectLibraryFilter(LibraryFilter* filter) const; diff --git a/library/ObjectExportDialog.h b/library/ObjectExportDialog.h index 61e3364ba..7275a77e8 100644 --- a/library/ObjectExportDialog.h +++ b/library/ObjectExportDialog.h @@ -29,8 +29,8 @@ class ObjectExportDialog : public ObjectSelectionDialog /*! * The Constructor. * - * @param [in] parent The parent widget. - * @param [in] f Widget flags for the dialog. + * @param [in] parent The parent widget. + * @param [in] f Widget flags for the dialog. */ ObjectExportDialog(QWidget* parent = 0, Qt::WindowFlags f = Qt::WindowFlags()); @@ -42,7 +42,7 @@ class ObjectExportDialog : public ObjectSelectionDialog /*! * Get the path to the destination directory. * - * @return The path to the destination directory. + * @return The path to the destination directory. */ QString getTargetDirectory() const; @@ -56,7 +56,7 @@ private slots: /*! * Handles the changes in the changing of the destination path. * - * @param [in] newDestination The new destination path. + * @param [in] newDestination The new destination path. */ void onDestinationFolderChanged(const QString& newDestination); diff --git a/library/ObjectSelectionDialog.h b/library/ObjectSelectionDialog.h index 51d897b9c..2442effa1 100644 --- a/library/ObjectSelectionDialog.h +++ b/library/ObjectSelectionDialog.h @@ -41,12 +41,12 @@ class ObjectSelectionDialog : public QDialog /*! * The Constructor. * - * @param [in] okButtonText QString containing the text for the ok button. - * @param [in] iconPath Path to the icon used by the selection dialog. - * @param [in] okIconPath Path to the icon used by the ok button. - * @param [in] windowTitle Window title of the selection dialog. - * @param [in] parent The parent widget. - * @param [in] f Widget flags for the dialog. + * @param [in] okButtonText QString containing the text for the ok button. + * @param [in] iconPath Path to the icon used by the selection dialog. + * @param [in] okIconPath Path to the icon used by the ok button. + * @param [in] windowTitle Window title of the selection dialog. + * @param [in] parent The parent widget. + * @param [in] f Widget flags for the dialog. */ ObjectSelectionDialog(QString const& okButtonText, QString const& iconPath, QString const& okIconPath, QString const& windowTitle, QWidget* parent = 0, Qt::WindowFlags f = Qt::WindowFlags()); @@ -59,23 +59,23 @@ class ObjectSelectionDialog : public QDialog /*! * Create a list widget item for the dialog. * - * @param [in] path Location path of the item file. - * @param [in] vlnv VLNV of the item. - * @param [in] locked Value for separating exportable items. + * @param [in] path Location path of the item file. + * @param [in] vlnv VLNV of the item. + * @param [in] locked Value for separating exportable items. */ void createItem(const QString& path, const VLNV& vlnv = VLNV(), bool locked = false); /*! * Get the size hint of this dialog. * - * @return QSize contains the desired size for this dialog. + * @return QSize contains the desired size for this dialog. */ virtual QSize sizeHint() const; /*! * Get the items to be exported. * - * @return A list of items to be exported. + * @return A list of items to be exported. */ QVector getSelectedItems() const; @@ -84,14 +84,14 @@ private slots: /*! * Handles the selection of all the items in the list. * - * @param [in] checkAllState The new state of the items. + * @param [in] checkAllState The new state of the items. */ void onCheckAllChanged(int checkAllState); /*! * [Description]. * - * @param [in] currentItem [Description]. + * @param [in] currentItem [Description]. */ void onItemClicked(QListWidgetItem* currentItem); @@ -115,24 +115,24 @@ private slots: /*! * Construct the intro labels for the dialog. * - * @param [in] introName Name of the introduction. - * @param [in] introText Text explaining the use of this selection dialog. + * @param [in] introName Name of the introduction. + * @param [in] introText Text explaining the use of this selection dialog. * - * @return QWidget containing the information of the selection dialog. + * @return QWidget containing the information of the selection dialog. */ QWidget* setupIntroWidget(QString const& introName, QString const& introText) const; /*! * Setup the layout for the buttons used in the selection dialog. * - * @return The layout containing the dialog buttons. + * @return The layout containing the dialog buttons. */ QHBoxLayout* setupButtonLayout(); /*! * Get the list widget containing the selectable items. * - * @return The list widget containing the selectable items. + * @return The list widget containing the selectable items. */ QListWidget* getItemList(); @@ -150,19 +150,19 @@ private slots: /*! * Get the icon used by the selected item VLNV. * - * @param [in] itemVLNV VLNV of the selected item. + * @param [in] itemVLNV VLNV of the selected item. * - * @return Icon corresponding to the selected VLNV. + * @return Icon corresponding to the selected VLNV. */ QIcon getUsedIcon(const VLNV& itemVLNV) const; /*! * Check if an item exists in the list. * - * @param [in] itemPath Path of the selected item. - * @param [in] itemVLNV VLNV of the selected item. + * @param [in] itemPath Path of the selected item. + * @param [in] itemVLNV VLNV of the selected item. * - * @return True, if the item exists in the list, false otherwise. + * @return True, if the item exists in the list, false otherwise. */ bool itemExistsInList(QString const& itemPath, VLNV const& itemVLNV) const; diff --git a/library/ObjectSelectionListItem.h b/library/ObjectSelectionListItem.h index 0d45c6bb2..79af3898c 100644 --- a/library/ObjectSelectionListItem.h +++ b/library/ObjectSelectionListItem.h @@ -35,10 +35,10 @@ class ObjectSelectionListItem : public QListWidgetItem /*! * The constructor. * - * @param [in] itemIcon Icon used by the item. - * @param [in] itemPath File path of the item. - * @param [in] isLocked The lock status of the item. - * @param [in] vlnv VLNV associated with the item. + * @param [in] itemIcon Icon used by the item. + * @param [in] itemPath File path of the item. + * @param [in] isLocked The lock status of the item. + * @param [in] vlnv VLNV associated with the item. * */ ObjectSelectionListItem(QIcon itemIcon, QString const& itemPath, bool isLocked, VLNV vlnv = VLNV()); @@ -51,28 +51,28 @@ class ObjectSelectionListItem : public QListWidgetItem /*! * Get the VLNV associated with the item. * - * @return The VLNV of the item. + * @return The VLNV of the item. */ VLNV getVLNV() const; /*! * Get the file path of the item. * - * @return The file path of the item. + * @return The file path of the item. */ QString getPath() const; /*! * Get the item type. * - * @return The type of the item. + * @return The type of the item. */ ObjectSelectionListItem::ItemType getType() const; /*! * Check if the item is locked. * - * @return True, if the item is locked, false otherwise. + * @return True, if the item is locked, false otherwise. */ bool itemIsLocked() const; diff --git a/library/TableViewDialog.h b/library/TableViewDialog.h index fb630c93a..556627ea4 100644 --- a/library/TableViewDialog.h +++ b/library/TableViewDialog.h @@ -37,14 +37,14 @@ class TableViewDialog : public QDialog /*! * Sets the description text for the table view. * - * @param [in] desc The description text. + * @param [in] desc The description text. */ void setDescription(QString const& desc); /*! * Sets the model used for the table view. * - * @param [in] model The model to set. + * @param [in] model The model to set. */ void setModel(QAbstractTableModel* model); diff --git a/library/VLNVDialer/FilterGroup.h b/library/VLNVDialer/FilterGroup.h index e071e8347..a486c45ac 100644 --- a/library/VLNVDialer/FilterGroup.h +++ b/library/VLNVDialer/FilterGroup.h @@ -27,7 +27,7 @@ class FilterGroup : public QGroupBox /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ FilterGroup(QString const& title, QWidget *parent); @@ -43,7 +43,7 @@ class FilterGroup : public QGroupBox /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ virtual void selectAll(bool select) = 0; diff --git a/library/VLNVDialer/RevisionGroup.h b/library/VLNVDialer/RevisionGroup.h index 32752269b..3dcd2d64b 100644 --- a/library/VLNVDialer/RevisionGroup.h +++ b/library/VLNVDialer/RevisionGroup.h @@ -31,7 +31,7 @@ class RevisionGroup : public FilterGroup /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ explicit RevisionGroup(QWidget *parent); @@ -43,21 +43,21 @@ class RevisionGroup : public FilterGroup /*! * Sets new validity options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setRevision(Utils::RevisionOptions options); /*! * Gets the selected validity options. * - * @return Selected validity options. + * @return Selected validity options. */ [[nodiscard]] Utils::RevisionOptions getRevision() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select) final; diff --git a/library/VLNVDialer/ValidityGroup.h b/library/VLNVDialer/ValidityGroup.h index 9eaab7381..896dbc123 100644 --- a/library/VLNVDialer/ValidityGroup.h +++ b/library/VLNVDialer/ValidityGroup.h @@ -31,7 +31,7 @@ class ValidityGroup : public FilterGroup /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ ValidityGroup(QWidget *parent); @@ -47,21 +47,21 @@ class ValidityGroup : public FilterGroup /*! * Sets new validity options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setValidity(Utils::ValidityOptions options); /*! * Gets the selected validity options. * - * @return Selected validity options. + * @return Selected validity options. */ Utils::ValidityOptions getValidity() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select) override final; diff --git a/library/VLNVDialer/dialerwidget.h b/library/VLNVDialer/dialerwidget.h index b90363d88..ac399b5d7 100644 --- a/library/VLNVDialer/dialerwidget.h +++ b/library/VLNVDialer/dialerwidget.h @@ -31,7 +31,7 @@ class DialerWidget : public QWidget /*! * The constructor. * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ DialerWidget(QWidget *parent); @@ -43,7 +43,7 @@ class DialerWidget : public QWidget /*! * Set the root item used to create the suggestions for dialer. * - * @param [in] rootItem The root item of the library. + * @param [in] rootItem The root item of the library. */ void setRootItem(const LibraryItem* rootItem); diff --git a/library/VLNVDialer/filterwidget.h b/library/VLNVDialer/filterwidget.h index 364c0b82e..bd895126f 100644 --- a/library/VLNVDialer/filterwidget.h +++ b/library/VLNVDialer/filterwidget.h @@ -35,7 +35,7 @@ class FilterWidget : public QWidget /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ FilterWidget(QWidget *parent); @@ -51,21 +51,21 @@ class FilterWidget : public QWidget /*! * Setup the filters. * - * @param [in] options New filter options. + * @param [in] options New filter options. */ void setFilters(Utils::FilterOptions options); /*! * Get the filters. * - * @return The current filter options. + * @return The current filter options. */ Utils::FilterOptions getFilters() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select); diff --git a/library/VLNVDialer/firmnessgroup.h b/library/VLNVDialer/firmnessgroup.h index f4e929beb..1b1b5e992 100644 --- a/library/VLNVDialer/firmnessgroup.h +++ b/library/VLNVDialer/firmnessgroup.h @@ -31,7 +31,7 @@ class FirmnessGroup : public FilterGroup /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ FirmnessGroup(QWidget *parent); @@ -47,21 +47,21 @@ class FirmnessGroup : public FilterGroup /*! * Sets new firmness options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setFirmness(Utils::FirmnessOptions options); /*! * Gets the selected firmness options. * - * @return Selected firmness options. + * @return Selected firmness options. */ Utils::FirmnessOptions getFirmness() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select) override final; diff --git a/library/VLNVDialer/hierarchygroup.h b/library/VLNVDialer/hierarchygroup.h index 3b20c0080..7459b7f2d 100644 --- a/library/VLNVDialer/hierarchygroup.h +++ b/library/VLNVDialer/hierarchygroup.h @@ -31,7 +31,7 @@ class HierarchyGroup : public FilterGroup /*! * The constructor. * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ HierarchyGroup(QWidget *parent); @@ -47,21 +47,21 @@ class HierarchyGroup : public FilterGroup /*! * Sets new hierarchy options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setHierarchy(Utils::HierarchyOptions options); /*! * Gets the selected hierarchy options. * - * @return Selected hierarchy options. + * @return Selected hierarchy options. */ Utils::HierarchyOptions getHierarchy() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select) override final; diff --git a/library/VLNVDialer/implementationgroup.h b/library/VLNVDialer/implementationgroup.h index f48455c64..02a4ff96e 100644 --- a/library/VLNVDialer/implementationgroup.h +++ b/library/VLNVDialer/implementationgroup.h @@ -30,7 +30,7 @@ class ImplementationGroup : public FilterGroup /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ ImplementationGroup(QWidget *parent); @@ -46,21 +46,21 @@ class ImplementationGroup : public FilterGroup /*! * Sets new implementation options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setImplementation(Utils::ImplementationOptions options); /*! * Gets the selected implementation options. * - * @return Selected implementation options. + * @return Selected implementation options. */ Utils::ImplementationOptions getImplementation() const; /*! * Select/clear all filters. * - * @param [in] select If true, all filters are set, otherwise all filters are cleared. + * @param [in] select If true, all filters are set, otherwise all filters are cleared. */ void selectAll(bool select) override final; diff --git a/library/VLNVDialer/typegroup.h b/library/VLNVDialer/typegroup.h index a856f5a08..046421398 100644 --- a/library/VLNVDialer/typegroup.h +++ b/library/VLNVDialer/typegroup.h @@ -31,7 +31,7 @@ class TypeGroup : public FilterGroup /*! * The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. */ TypeGroup(QWidget *parent); @@ -47,14 +47,14 @@ class TypeGroup : public FilterGroup /*! * Sets new type options. * - * @param [in] options The options to set. + * @param [in] options The options to set. */ void setTypes(Utils::TypeOptions options); /*! * Gets the selected type options. * - * @return Selected type options. + * @return Selected type options. */ Utils::TypeOptions getTypes() const; diff --git a/library/VLNVDialer/vlnvdialer.h b/library/VLNVDialer/vlnvdialer.h index 9154fec0d..9fd4abea8 100644 --- a/library/VLNVDialer/vlnvdialer.h +++ b/library/VLNVDialer/vlnvdialer.h @@ -38,7 +38,7 @@ class VLNVDialer : public QWidget /*! The constructor * - * @param [in] parent The owner of this widget. + * @param [in] parent The owner of this widget. * */ VLNVDialer(QWidget *parent); @@ -55,14 +55,14 @@ class VLNVDialer : public QWidget /*! * Set filter settings for the library. * - * @param [in] settings Settings containing the library filters. + * @param [in] settings Settings containing the library filters. */ void loadFilterSettings(QSettings& settings); /*! * Save settings for dock widget filters. * - * @param [in] settings The settings. + * @param [in] settings The settings. */ void saveFilterSettings(QSettings& settings) const; @@ -92,7 +92,7 @@ class VLNVDialer : public QWidget /*! * Informs of tag filter change. * - * @param [in] tagFilters The new visible tags. + * @param [in] tagFilters The new visible tags. */ void tagFiltersChanged(QVector tagFilters); diff --git a/library/objectremovedialog.h b/library/objectremovedialog.h index beb734462..2357ac4f3 100644 --- a/library/objectremovedialog.h +++ b/library/objectremovedialog.h @@ -26,8 +26,8 @@ class ObjectRemoveDialog : public ObjectSelectionDialog /*! * The constructor. * - * @param [in] parent Pointer to the owner of this dialog. - * @param [in] f Widget flags for the dialog. + * @param [in] parent Pointer to the owner of this dialog. + * @param [in] f Widget flags for the dialog. * */ ObjectRemoveDialog(QWidget *parent = 0, Qt::WindowFlags f = Qt::WindowFlags()); diff --git a/mainwindow/CommandLineParser.h b/mainwindow/CommandLineParser.h index 1e335bd2e..5deda4ee8 100644 --- a/mainwindow/CommandLineParser.h +++ b/mainwindow/CommandLineParser.h @@ -35,24 +35,24 @@ class CommandLineParser * Reads the given arguments. * The arguments can then be checked before processing with argumentsValid() and helpOrVersionOptionSet(). * - * @param [in] arguments The arguments to read. + * @param [in] arguments The arguments to read. */ void readArguments(QStringList const& arguments); /*! * Checks if the command-line option is set. * - * @return True, if command-line option is set, otherwise false. + * @return True, if command-line option is set, otherwise false. */ bool commandlineMode() const; /*! * Processes the given command line arguments and executes accordingly. * - * @param [in] arguments The command line arguments to process. - * @param [in] messageChannel Interface for output and error messages. + * @param [in] arguments The command line arguments to process. + * @param [in] messageChannel Interface for output and error messages. * - * @return 0 for a successful run, any other value for errors. + * @return 0 for a successful run, any other value for errors. */ int process(QStringList const& arguments, MessageMediator* messageChannel); @@ -61,7 +61,7 @@ class CommandLineParser /*! * Get the usage help text. * - * @return The usage help text. + * @return The usage help text. */ QString helpText(); diff --git a/mainwindow/DeleteWorkspaceDialog.h b/mainwindow/DeleteWorkspaceDialog.h index 1a32480d5..34f19c0ff 100644 --- a/mainwindow/DeleteWorkspaceDialog.h +++ b/mainwindow/DeleteWorkspaceDialog.h @@ -27,7 +27,7 @@ class DeleteWorkspaceDialog : public QDialog /*! * Constructor which initializes the dialog. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ DeleteWorkspaceDialog(QWidget* parent = 0); @@ -39,7 +39,7 @@ class DeleteWorkspaceDialog : public QDialog /*! * Adds a workspace name to the dialog. * - * @param [in] name The name of the existing workspace. + * @param [in] name The name of the existing workspace. */ void addWorkspaceName(QString const& name); diff --git a/mainwindow/DockWidgetHandler.h b/mainwindow/DockWidgetHandler.h index b19425d2a..61fe7b671 100644 --- a/mainwindow/DockWidgetHandler.h +++ b/mainwindow/DockWidgetHandler.h @@ -59,11 +59,11 @@ class DockWidgetHandler: public QObject /*! * The constructor. * - * @param [in] library The used IP-XACT library. - * @param [in] messageChannel The message channel for notifications and errors. - * @param [in] leftToolbar The left side toolbar in mainwindow. - * @param [in] rightToolbar The right side toolbar in mainwindow. - * @param [in] parent The main window. + * @param [in] library The used IP-XACT library. + * @param [in] messageChannel The message channel for notifications and errors. + * @param [in] leftToolbar The left side toolbar in mainwindow. + * @param [in] rightToolbar The right side toolbar in mainwindow. + * @param [in] parent The main window. */ DockWidgetHandler(LibraryHandler* library, MessageMediator* messageChannel, QToolBar* leftToolbar, QToolBar* rightToolbar, QMainWindow* parent); @@ -85,42 +85,42 @@ class DockWidgetHandler: public QObject /*! * Setup the visibility actions for the visibility menu. * - * @param [in] visibilityMenu The visibility menu. + * @param [in] visibilityMenu The visibility menu. */ void setupVisibilityActionMenu(QMenu& visibilityMenu); /*! * Get the library handler created by the library widget. * - * @return The library handler. + * @return The library handler. */ LibraryHandler* getLibraryHandler() const; /*! * Load the visibilities for the dockable items. * - * @param [in] settings Settings containing the visibilities for the dockable items. + * @param [in] settings Settings containing the visibilities for the dockable items. */ void loadVisiblities(QSettings const& settings); /*! * Save settings for dock widget visibilities. * - * @param [in] settings The settings. + * @param [in] settings The settings. */ void saveVisibilitySettings(QSettings& settings) const; /*! * Set filter settings for the library. * - * @param [in] settings Settings containing the library filters. + * @param [in] settings Settings containing the library filters. */ void loadFilterSettings(QSettings& settings); /*! * Save settings for dock widget filters. * - * @param [in] settings The settings. + * @param [in] settings The settings. */ void saveFilterSettings(QSettings& settings) const; @@ -130,48 +130,48 @@ class DockWidgetHandler: public QObject /*! * Clear the item selection in design. * - * @param [in] designWidget Design widget containing the HW design. + * @param [in] designWidget Design widget containing the HW design. */ void clearItemSelection(HWDesignWidget* designWidget); /*! * Select a component item in design. * - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] component The selected component item. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] component The selected component item. */ void selectComponent(QWidget* currentTabWidget, ComponentItem* component); /*! * Select a connection interface. * - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] interface The selected interface. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] interface The selected interface. */ void selectConnectionInterface(QWidget* currentTabWidget, ConnectionEndpoint* interface); /*! * Select a connection item. * - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] connection The selected connection item. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] connection The selected connection item. */ void selectGraphicsConnection(QWidget* currentTabWidget, GraphicsConnection* connection); /*! * Update the visibility of the dock widgets. * - * @param [in] tabCount Number of items in the tab queue. - * @param [in] currentTabWidget The currently active tab widget. + * @param [in] tabCount Number of items in the tab queue. + * @param [in] currentTabWidget The currently active tab widget. */ void updateWindows(QWidget* currentTabWidget); /*! * Update the visibility of the selected dock widget. * - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] windowType Type selected dock widget. - * @param [in] dock The selected dock widget. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] windowType Type selected dock widget. + * @param [in] dock The selected dock widget. */ void updateWindowAndControlVisibility(QWidget* currentTabWidget, TabDocument::SupportedWindows windowType, QDockWidget* dock); @@ -179,7 +179,7 @@ class DockWidgetHandler: public QObject /*! * Handle the change of the currently active tab document. * - * @param [in] doc The new active tab document. + * @param [in] doc The new active tab document. */ void documentChanged(TabDocument* doc); @@ -196,9 +196,9 @@ class DockWidgetHandler: public QObject /*! * Set visibility for the supported window types. * - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] type Type of the selected dock widget. - * @param [in] show The new visibility value. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] type Type of the selected dock widget. + * @param [in] show The new visibility value. */ void setWindowVisibilityForSupportedWindow(QWidget* currentTabWidget, TabDocument::SupportedWindows type, bool show); @@ -206,36 +206,36 @@ class DockWidgetHandler: public QObject /*! * Change the locking status of the dock widgets. * - * @param [in] doc The currently active tab document. - * @param [in] locked The new lock value. + * @param [in] doc The currently active tab document. + * @param [in] locked The new lock value. */ void changeProtection(TabDocument* doc, bool locked); /*! * Get the design parameter reference tree finder. * - * @return The design parameter reference tree finder. + * @return The design parameter reference tree finder. */ QSharedPointer getDesignAndInstanceParameterFinder() const; /*! * Get the design parameter finder. * - * @return The design parameter finder. + * @return The design parameter finder. */ QSharedPointer getDesignParameterFinder() const; /*! * Refresh the design document. * - * @param [in] currentTabWidget The currently active tab widget. + * @param [in] currentTabWidget The currently active tab widget. */ void refreshDesignDocument(QWidget* currentTabWidget); /*! * Setup the design parameter finder. * - * @param [in] newDesign The design of the currently active design tab document. + * @param [in] newDesign The design of the currently active design tab document. */ void setupDesignParameterFinder(QSharedPointer newDesign); @@ -251,14 +251,14 @@ public slots: /*! * Transfers error messages between the main window and the message console. * - * @param [in] message The error message. + * @param [in] message The error message. */ void errorMessage(QString const& message); /*! * Transfers notice messages between the main window and the message console. * - * @param [in] message The notice message. + * @param [in] message The notice message. */ void noticeMessage(QString const& message); @@ -267,7 +267,7 @@ public slots: /*! * Transfers URL context help requirement between the main window and the message console. * - * @param [in] message The URL required for the context help window. + * @param [in] message The URL required for the context help window. */ void helpUrlRequested(QString const& helpURL); @@ -280,8 +280,8 @@ public slots: * Transfers the visibility change in the selected dock widget type to main window in order to receive * required tab document data. * - * @param [in] type Type of the selected dock widget. - * @param [in] show Value for the display of the dock widget. + * @param [in] type Type of the selected dock widget. + * @param [in] show Value for the display of the dock widget. */ void adjustVisibilityInWindow(TabDocument::SupportedWindows type, bool show); @@ -292,84 +292,84 @@ private slots: /*! * Handles the action for the visibility of the output dock widget. * - * @param [in] show Value for the visibility of the output dock widget. + * @param [in] show Value for the visibility of the output dock widget. */ void onOutputAction(bool show); /*! * Handles the action for the visibility of the context help dock widget. * - * @param [in] show Value for the visibility of the context help dock widget. + * @param [in] show Value for the visibility of the context help dock widget. */ void onContextHelpAction(bool show); /*! * Handles the action for the visibility of the library dock widget. * - * @param [in] show Value for the visibility of the library dock widget. + * @param [in] show Value for the visibility of the library dock widget. */ void onLibraryAction(bool show); /*! * Handles the action for the visibility of the design configuration dock widget. * - * @param [in] show Value for the visibility of the design configuration dock widget. + * @param [in] show Value for the visibility of the design configuration dock widget. */ void onConfigurationAction(bool show); /*! * Handles the action for the visibility of the system details dock widget. * - * @param [in] show Value for the visibility of the system details dock widget. + * @param [in] show Value for the visibility of the system details dock widget. */ void onSystemDetailsAction(bool show); /*! * Handles the action for the visibility of the connection editor dock widget. * - * @param [in] show Value for the visibility of the connection editor dock widget. + * @param [in] show Value for the visibility of the connection editor dock widget. */ void onConnectionAction(bool show); /*! * Handles the action for the visibility of the vendor extension editor dock widget. * - * @param [in] show Value for the visibility of the vendor extension editor dock widget. + * @param [in] show Value for the visibility of the vendor extension editor dock widget. */ void onVendorExtensionVisibilityAction(bool show); /*! * Handles the action for the visibility of the interface editor dock widget. * - * @param [in] show Value for the visibility of the interface editor dock widget. + * @param [in] show Value for the visibility of the interface editor dock widget. */ void onInterfaceAction(bool show); /*! * Handles the action for the visibility of the component instance dock widget. * - * @param [in] show Value for the visibility of the component instance dock widget. + * @param [in] show Value for the visibility of the component instance dock widget. */ void onInstanceAction(bool show); /*! * Handles the action for the visibility of the design parameters editor dock widget. * - * @param [in] show Value for the visibility of the design parameters editor dock widget. + * @param [in] show Value for the visibility of the design parameters editor dock widget. */ void onDesignParametersAction(bool show); /*! * Handles the action for the visibility of the ad hoc port editor dock widget. * - * @param [in] show Value for the visibility of the ad hoc port editor dock widget. + * @param [in] show Value for the visibility of the ad hoc port editor dock widget. */ void onAdHocEditorAction(bool show); /*! * Handles the change for the dock position. * - * @param [in] area The area where the dock has been positioned. + * @param [in] area The area where the dock has been positioned. */ void onDockLocationChanged(Qt::DockWidgetArea area); @@ -434,11 +434,11 @@ private slots: /*! * Check if the selected window type is supported by the currently active tab widget. * - * @param [in] tabCount Number of items in the tab queue. - * @param [in] currentTabWidget The currently active tab widget. - * @param [in] windowType Type of the selected window. + * @param [in] tabCount Number of items in the tab queue. + * @param [in] currentTabWidget The currently active tab widget. + * @param [in] windowType Type of the selected window. * - * @return True, if the window type is supported by the active document, false otherwise. + * @return True, if the window type is supported by the active document, false otherwise. */ bool isSupportedWindowType(QWidget* currentTabWidget, TabDocument::SupportedWindows windowType) const; @@ -446,24 +446,24 @@ private slots: /*! * Get the supported windows for the currently active tab widget. * - * @param [in] currentTabWidget The currently active tab widget. + * @param [in] currentTabWidget The currently active tab widget. * - * @return The currently supported dock widgets. + * @return The currently supported dock widgets. */ unsigned int currentlySupportedWindows(QWidget* currentTabWidget) const; /*! * Get the dock widgets that are visible regardless of the currently active tad document. * - * @return The default dock widgets. + * @return The default dock widgets. */ unsigned int defaultWindows() const; /*! * Set the visibility for the selected dock widget. * - * @param [in] windowType The type of the selected dock widget. - * @param [in] show The new visibility value. + * @param [in] windowType The type of the selected dock widget. + * @param [in] show The new visibility value. */ void setWindowVisibility(TabDocument::SupportedWindows windowType, bool show); @@ -471,10 +471,10 @@ private slots: /*! * Places the visibility control action in the correct toolbar. * - * @param [in] action The action to place in the toolbar. - * @param [in] area The area where the related dock widget is located. + * @param [in] action The action to place in the toolbar. + * @param [in] area The area where the related dock widget is located. * - * @return + * @return */ void placeActionInToolbar(QAction* action, Qt::DockWidgetArea area); diff --git a/mainwindow/DrawingBoard/DrawingBoard.h b/mainwindow/DrawingBoard/DrawingBoard.h index 9f681af29..1f176f752 100644 --- a/mainwindow/DrawingBoard/DrawingBoard.h +++ b/mainwindow/DrawingBoard/DrawingBoard.h @@ -27,7 +27,7 @@ class DrawingBoard : public QTabWidget /*! * The constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ DrawingBoard(QWidget* parent = 0); @@ -37,7 +37,7 @@ class DrawingBoard : public QTabWidget /*! * Registers a tab document (connects common signals etc.). * - * @param [in] doc The document to register. + * @param [in] doc The document to register. */ void addAndOpenDocument(TabDocument* doc); @@ -69,7 +69,7 @@ public slots: /*! * Closes and removes the document at given index. * - * @param [in] index The document index to close. + * @param [in] index The document index to close. */ void closeAndRemoveDocument(int index); @@ -86,10 +86,10 @@ public slots: /*! * Filters the events for given target. Used to create context menu for closing tabs. * - * @param [in] target The target object whose event to filter. - * @param [in] event The event captured before passing to target. + * @param [in] target The target object whose event to filter. + * @param [in] event The event captured before passing to target. * - * @return True, if the event was filtered and should not be passed further, otherwise false. + * @return True, if the event was filtered and should not be passed further, otherwise false. */ virtual bool eventFilter(QObject* target, QEvent* event); @@ -132,9 +132,9 @@ private slots: /*! * Checks if the current document should be saved. If the document contains errors, prompts the user. * - * @param [in] doc The document to save. + * @param [in] doc The document to save. * - * @return True, if the document should be saved, otherwise false. + * @return True, if the document should be saved, otherwise false. */ bool shouldSave(TabDocument* doc); diff --git a/mainwindow/MessageConsole/messageconsole.h b/mainwindow/MessageConsole/messageconsole.h index 1956a9e1c..3133bea5c 100644 --- a/mainwindow/MessageConsole/messageconsole.h +++ b/mainwindow/MessageConsole/messageconsole.h @@ -27,7 +27,7 @@ class MessageConsole : public QPlainTextEdit /*! The constructor * - * @param [in] parent The owner of this widget + * @param [in] parent The owner of this widget * */ explicit MessageConsole(QWidget *parent); @@ -45,13 +45,13 @@ public slots: /*! Prints an error message to the text edit. * - * @param [in] message The message to print. + * @param [in] message The message to print. */ void onErrorMessage(QString const& message); /*! Prints a notice message to the text edit. * - * @param [in] message The message to print. + * @param [in] message The message to print. */ void onNoticeMessage(QString const& message); @@ -64,7 +64,7 @@ public slots: /*! Set the color for text to be printed. * - * @param [in] color The color to apply to text. + * @param [in] color The color to apply to text. */ void setTextColor(QColor const& color); diff --git a/mainwindow/NewPages/NewApiDefinitionPage.h b/mainwindow/NewPages/NewApiDefinitionPage.h index cd0b63a6a..92fec601a 100644 --- a/mainwindow/NewPages/NewApiDefinitionPage.h +++ b/mainwindow/NewPages/NewApiDefinitionPage.h @@ -27,8 +27,8 @@ class NewApiDefinitionPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewApiDefinitionPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -44,7 +44,7 @@ class NewApiDefinitionPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewBusDefinitionPage.h b/mainwindow/NewPages/NewBusDefinitionPage.h index 3a30da620..28e94454f 100644 --- a/mainwindow/NewPages/NewBusDefinitionPage.h +++ b/mainwindow/NewPages/NewBusDefinitionPage.h @@ -39,7 +39,7 @@ class NewBusDefinitionPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewCatalogPage.h b/mainwindow/NewPages/NewCatalogPage.h index 75323134d..e19806147 100644 --- a/mainwindow/NewPages/NewCatalogPage.h +++ b/mainwindow/NewPages/NewCatalogPage.h @@ -27,8 +27,8 @@ class NewCatalogPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewCatalogPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -44,7 +44,7 @@ class NewCatalogPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewComDefinitionPage.h b/mainwindow/NewPages/NewComDefinitionPage.h index 6ceeed553..745086bda 100644 --- a/mainwindow/NewPages/NewComDefinitionPage.h +++ b/mainwindow/NewPages/NewComDefinitionPage.h @@ -28,8 +28,8 @@ class NewComDefinitionPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewComDefinitionPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -45,7 +45,7 @@ class NewComDefinitionPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewComponentPage.h b/mainwindow/NewPages/NewComponentPage.h index a87ed4646..0a82d9404 100644 --- a/mainwindow/NewPages/NewComponentPage.h +++ b/mainwindow/NewPages/NewComponentPage.h @@ -34,8 +34,8 @@ class NewComponentPage : public NewPage /*! * The constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewComponentPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -52,7 +52,7 @@ class NewComponentPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -66,7 +66,7 @@ class NewComponentPage : public NewPage /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ bool onPageChange() final; diff --git a/mainwindow/NewPages/NewDesignPage.h b/mainwindow/NewPages/NewDesignPage.h index 45646e8e3..f4fe8d88d 100644 --- a/mainwindow/NewPages/NewDesignPage.h +++ b/mainwindow/NewPages/NewDesignPage.h @@ -31,8 +31,8 @@ class NewDesignPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewDesignPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -48,7 +48,7 @@ class NewDesignPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -62,7 +62,7 @@ class NewDesignPage : public NewPage /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ bool onPageChange() final; diff --git a/mainwindow/NewPages/NewPage.h b/mainwindow/NewPages/NewPage.h index f8cc73623..219edeb57 100644 --- a/mainwindow/NewPages/NewPage.h +++ b/mainwindow/NewPages/NewPage.h @@ -36,8 +36,8 @@ class NewPage : public PropertyPageView /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewPage(LibraryInterface* libInterface, VLNV::IPXactType vlnvType, QString title = QString(), QString description = QString(), QWidget* parentDlg = 0); @@ -54,7 +54,7 @@ class NewPage : public PropertyPageView /*! * Pre-validates the contents of the page. This is used for enabling/disabling the OK button. * - * @return True, if the contents are valid and OK button should be enabled. + * @return True, if the contents are valid and OK button should be enabled. * False, if the contents are invalid and OK button should be disabled. * * @remarks Must not show any message boxes. @@ -64,7 +64,7 @@ class NewPage : public PropertyPageView /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -73,7 +73,7 @@ class NewPage : public PropertyPageView /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ virtual bool onPageChange(); @@ -92,46 +92,46 @@ public slots: /*! * Gets the selected product hierarchy level, if selected. * - * @return The selected product hierarchy. + * @return The selected product hierarchy. */ virtual KactusAttribute::ProductHierarchy getProductHierarchy() const; /*! * Checks if the given VLNV is not found in the library. * - * @param [in] vlnv The VLNV to check. + * @param [in] vlnv The VLNV to check. * - * @return True, if the VLNV is not already in the library, otherwise false. + * @return True, if the VLNV is not already in the library, otherwise false. */ bool isUnusedVLNV(VLNV const& vlnv) const; /*! * Gets the selected path within the library. * - * @return The selected path. + * @return The selected path. */ QString selectedPath() const; /*! * Shows an error message for a VLNV already found in the library. * - * @param [in] vlnv The reserved VLNV. + * @param [in] vlnv The reserved VLNV. */ void showErrorForReservedVLVN(VLNV const& vlnv); /*! * Gets the name of the VLNV type * - * @param [in] type The type whose name to get. + * @param [in] type The type whose name to get. * - * @return The name of the VLNV document type. + * @return The name of the VLNV document type. */ QString type2Show(VLNV::IPXactType const& type); /*! * Gets the selected document revision. * - * @return The selected IP-XACT revision. + * @return The selected IP-XACT revision. */ Document::Revision selectedRevision() const; diff --git a/mainwindow/NewPages/NewSWComponentPage.h b/mainwindow/NewPages/NewSWComponentPage.h index adb7b1a8c..2330b43d3 100644 --- a/mainwindow/NewPages/NewSWComponentPage.h +++ b/mainwindow/NewPages/NewSWComponentPage.h @@ -28,8 +28,8 @@ class NewSWComponentPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewSWComponentPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -45,7 +45,7 @@ class NewSWComponentPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewSWDesignPage.h b/mainwindow/NewPages/NewSWDesignPage.h index d99179bc1..5f88cda26 100644 --- a/mainwindow/NewPages/NewSWDesignPage.h +++ b/mainwindow/NewPages/NewSWDesignPage.h @@ -26,8 +26,8 @@ class NewSWDesignPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parentDlg The parent dialog. + * @param [in] libInterface The library interface. + * @param [in] parentDlg The parent dialog. */ NewSWDesignPage(LibraryInterface* libInterface, QWidget* parentDlg); @@ -43,7 +43,7 @@ class NewSWDesignPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/mainwindow/NewPages/NewSystemPage.h b/mainwindow/NewPages/NewSystemPage.h index b4b95d4fa..5ac65e634 100644 --- a/mainwindow/NewPages/NewSystemPage.h +++ b/mainwindow/NewPages/NewSystemPage.h @@ -36,8 +36,8 @@ class NewSystemPage : public NewPage /*! * Constructor. * - * @param [in] libInterface The library interface. - * @param [in] parent The parent widget. + * @param [in] libInterface The library interface. + * @param [in] parent The parent widget. */ NewSystemPage(LibraryInterface* libInterface, QWidget* parent); @@ -53,7 +53,7 @@ class NewSystemPage : public NewPage /*! * Pre-validates the contents of the page. This is used for enabling/disabling the OK button. * - * @return True, if the contents are valid and OK button should be enabled. + * @return True, if the contents are valid and OK button should be enabled. * False, if the contents are invalid and OK button should be disabled. * * @remarks Must not show any message boxes. @@ -63,7 +63,7 @@ class NewSystemPage : public NewPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -77,7 +77,7 @@ class NewSystemPage : public NewPage /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ bool onPageChange() final; @@ -102,16 +102,16 @@ private slots: /*! * Initializes the top component selection listing for HW mapping. * - * @param [in] libInterface The library interface. + * @param [in] libInterface The library interface. */ void initializeHWComponentSelectionWidget(LibraryInterface* libInterface); /*! * Creates an item for selection widget for the given library item finding child items recursively. * - * @param [in] libraryItem The library item to create the item for. + * @param [in] libraryItem The library item to create the item for. * - * @return The item for selection widget. + * @return The item for selection widget. */ QTreeWidgetItem* createChildRecursively(LibraryItem const* libraryItem) const; diff --git a/mainwindow/NewWorkspaceDialog.h b/mainwindow/NewWorkspaceDialog.h index 59307205d..58fb9aa96 100644 --- a/mainwindow/NewWorkspaceDialog.h +++ b/mainwindow/NewWorkspaceDialog.h @@ -27,7 +27,7 @@ class NewWorkspaceDialog : public QDialog /*! * Constructor which initializes the dialog. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ NewWorkspaceDialog(QWidget* parent = 0); diff --git a/mainwindow/Ribbon/Ribbon.h b/mainwindow/Ribbon/Ribbon.h index 26db2dcdb..9cf340599 100644 --- a/mainwindow/Ribbon/Ribbon.h +++ b/mainwindow/Ribbon/Ribbon.h @@ -33,7 +33,7 @@ class Ribbon : public QToolBar /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ Ribbon(QWidget* parent = 0); @@ -49,7 +49,7 @@ class Ribbon : public QToolBar /*! * Adds a group to the ribbon. * - * @param [in] title The title for the group. + * @param [in] title The title for the group. */ QAction* addGroup(RibbonGroup* group); diff --git a/mainwindow/Ribbon/RibbonGroup.h b/mainwindow/Ribbon/RibbonGroup.h index fdb791376..2b5a356a3 100644 --- a/mainwindow/Ribbon/RibbonGroup.h +++ b/mainwindow/Ribbon/RibbonGroup.h @@ -29,8 +29,8 @@ class RibbonGroup : public QToolBar /*! * Constructor. * - * @param [in] title The group title. - * @param [in] parent The parent ribbon. + * @param [in] title The group title. + * @param [in] parent The parent ribbon. */ RibbonGroup(QString const& title, Ribbon* parent); diff --git a/mainwindow/SaveHierarchy/DocumentTreeBuilder.h b/mainwindow/SaveHierarchy/DocumentTreeBuilder.h index fc090e669..ab8e704bc 100644 --- a/mainwindow/SaveHierarchy/DocumentTreeBuilder.h +++ b/mainwindow/SaveHierarchy/DocumentTreeBuilder.h @@ -29,7 +29,7 @@ class DocumentTreeBuilder /*! * The constructor. * - * @param [in] library The current IP-XACT library. + * @param [in] library The current IP-XACT library. */ DocumentTreeBuilder(LibraryInterface* library); @@ -39,9 +39,9 @@ class DocumentTreeBuilder /*! * Creates an object tree starting at the given document. * - * @param [in] root The VLNV of the root document. + * @param [in] root The VLNV of the root document. * - * @return The object tree representing the document tree. + * @return The object tree representing the document tree. */ QObject* createFrom(VLNV const& root) const; @@ -54,27 +54,27 @@ class DocumentTreeBuilder /*! * Creates an object tree starting at the given component. * - * @param [in] root The VLNV of the component document. + * @param [in] root The VLNV of the component document. * - * @return The object tree representing the document tree starting at the component. + * @return The object tree representing the document tree starting at the component. */ QObject* createFromComponent(VLNV const &root) const; /*! * Creates an object tree starting at the given design configuration. * - * @param [in] designConfiguration The VLNV of the design configuration document. + * @param [in] designConfiguration The VLNV of the design configuration document. * - * @return The object tree representing the document tree starting at the design configuration. + * @return The object tree representing the document tree starting at the design configuration. */ QObject* createFromDesignConfiguration(VLNV const& designConfiguration) const; /*! * Creates an object tree starting at the given design. * - * @param [in] designRef The VLNV of the design document. + * @param [in] designRef The VLNV of the design document. * - * @return The object tree representing the document tree starting at the design. + * @return The object tree representing the document tree starting at the design. */ QObject* createFromDesign(VLNV const& designRef) const; diff --git a/mainwindow/SaveHierarchy/HierarchicalSaveBuildStrategy.h b/mainwindow/SaveHierarchy/HierarchicalSaveBuildStrategy.h index 9ed5d0719..081ea2919 100644 --- a/mainwindow/SaveHierarchy/HierarchicalSaveBuildStrategy.h +++ b/mainwindow/SaveHierarchy/HierarchicalSaveBuildStrategy.h @@ -43,7 +43,7 @@ class HierarchicalSaveBuildStrategy : public QObject /*! * The constructor. * - * @param [in] library The document library in use. + * @param [in] library The document library in use. */ HierarchicalSaveBuildStrategy(LibraryInterface* library, QObject* parent = 0); @@ -53,30 +53,30 @@ class HierarchicalSaveBuildStrategy : public QObject /*! * Creates a tree model from the given object tree. * - * @param [in] rootObject The root object. + * @param [in] rootObject The root object. * - * @return Root item of the document tree. + * @return Root item of the document tree. */ QTreeWidgetItem* build(QObject* rootObject) const; /*! * Saves the documents in the tree and updates all references. * - * @param [in] item The root item to start the save from. + * @param [in] item The root item to start the save from. */ void saveItem(QTreeWidgetItem* item) const; /*! * Sets the saving mode specifying the save location. * - * @param [in] mode The selected mode. + * @param [in] mode The selected mode. */ void setSaveMode(HierarchicalSaveBuildStrategy::SaveMode mode); /*! * Sets the save path. * - * @param [in] path The path to set. + * @param [in] path The path to set. */ void setSavePath(QString const& path); @@ -94,103 +94,103 @@ class HierarchicalSaveBuildStrategy : public QObject /*! * Creates an item and its children. * - * @param [in] rootObject The object in the document tree to represent in the item. + * @param [in] rootObject The object in the document tree to represent in the item. * - * @return The created tree item. + * @return The created tree item. */ QTreeWidgetItem* createItemAndItsChildren(QObject* rootObject) const; /*! * Creates an item. * - * @param [in] object The object in the document tree to represent in the item. + * @param [in] object The object in the document tree to represent in the item. * - * @return The created tree item. + * @return The created tree item. */ QTreeWidgetItem* createItem(QObject* object) const; /*! * Sets an item to be invalid. * - * @param [in] item The item to set invalid. + * @param [in] item The item to set invalid. */ void setInvalid(QTreeWidgetItem* item) const; /*! * Sets the appropriate icon for the item. * - * @param [in] object The object in the document tree representing the item. - * @param [in] item The item whose icon to set. + * @param [in] object The object in the document tree representing the item. + * @param [in] item The item whose icon to set. */ void setIcon(QObject* object, QTreeWidgetItem* item) const; /*! * Generates an unused VLVN. * - * @param [in] previousVLNV The base VLNV for generation. + * @param [in] previousVLNV The base VLNV for generation. * - * @return The generated unique VLNV. + * @return The generated unique VLNV. */ QString generateUnusedVLNV(QString const& previousVLNV) const; /*! * Creates child items for an item. * - * @param [in] object The object in the document tree representing the item. - * @param [in] treeItem The item whose children to create. + * @param [in] object The object in the document tree representing the item. + * @param [in] treeItem The item whose children to create. */ void createChildItems(QObject* object, QTreeWidgetItem* treeItem) const; /*! * Checks if an item has no children with the given VLNV. * - * @param [in] item The item to check. - * @param [in] vlnv The VLNV to search for. + * @param [in] item The item to check. + * @param [in] vlnv The VLNV to search for. * - * @return True, if no child has the given VLNV, otherwise false. + * @return True, if no child has the given VLNV, otherwise false. */ bool hasNoChildWithVLNV(QTreeWidgetItem* item, QString const& vlnv) const; /*! * Checks if the given item should be saved. * - * @param [in] item The item to check. + * @param [in] item The item to check. * - * @return True, if the item is to be saved, otherwise false. + * @return True, if the item is to be saved, otherwise false. */ bool shouldSaveItem(QTreeWidgetItem* item) const; /*! * Updates all references from the given document to the given child item. * - * @param [in] model The document model to update. - * @param [in] childItem The child item to update the references to. + * @param [in] model The document model to update. + * @param [in] childItem The child item to update the references to. */ void updateReferencesFromTo(QSharedPointer model, QTreeWidgetItem* childItem) const; /*! * Updates all references in a component to another. * - * @param [in] component The component whose references to update. - * @param [in] reference The reference to update. - * @param [in] updatedReference The new reference. + * @param [in] component The component whose references to update. + * @param [in] reference The reference to update. + * @param [in] updatedReference The new reference. */ void updateComponentReferences(QSharedPointer component, VLNV const& reference, VLNV const& updatedReference) const; /*! * Updates all references in a design to another. * - * @param [in] design The design whose references to update. - * @param [in] childVLNV The reference to update. - * @param [in] newChildVLNV The new reference. + * @param [in] design The design whose references to update. + * @param [in] childVLNV The reference to update. + * @param [in] newChildVLNV The new reference. */ void updateDesignReferences(QSharedPointer design, VLNV childVLNV, VLNV newChildVLNV) const; /*! * Saves a document model to the library. * - * @param [in] previousReference The earlier VLNV of the document model. - * @param [in] model The document model to save. + * @param [in] previousReference The earlier VLNV of the document model. + * @param [in] model The document model to save. */ void saveToLibrary(VLNV const& previousReference, QSharedPointer model) const; diff --git a/mainwindow/SaveHierarchy/SaveAsItem.h b/mainwindow/SaveHierarchy/SaveAsItem.h index 849d81026..a7a655afa 100644 --- a/mainwindow/SaveHierarchy/SaveAsItem.h +++ b/mainwindow/SaveHierarchy/SaveAsItem.h @@ -24,7 +24,7 @@ class SaveAsItem : public QTreeWidgetItem /*! * The constructor. * - * @param [in] parent The parent item. + * @param [in] parent The parent item. */ SaveAsItem(QTreeWidgetItem* parent); @@ -34,9 +34,9 @@ class SaveAsItem : public QTreeWidgetItem /*! * Sets the data in the item. * - * @param [in] column The column whose data to set. - * @param [in] role The data role to set. - * @param [in] value The value to set. + * @param [in] column The column whose data to set. + * @param [in] role The data role to set. + * @param [in] value The value to set. */ virtual void setData(int column, int role, QVariant const& value); diff --git a/mainwindow/SaveHierarchy/SaveHierarchyDelegate.h b/mainwindow/SaveHierarchy/SaveHierarchyDelegate.h index 18657290f..421edee1f 100644 --- a/mainwindow/SaveHierarchy/SaveHierarchyDelegate.h +++ b/mainwindow/SaveHierarchy/SaveHierarchyDelegate.h @@ -26,8 +26,8 @@ class SaveHierarchyDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] library The document library to use. - * @param [in] parent The parent object. + * @param [in] library The document library to use. + * @param [in] parent The parent object. */ SaveHierarchyDelegate(LibraryInterface* library, QObject* parent); @@ -36,27 +36,27 @@ class SaveHierarchyDelegate : public QStyledItemDelegate /*! Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; /*! Set the data for the editor. * - * @param [in] editor The editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor The editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. * */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! Save the data from the editor to the model. * - * @param [in] editor The editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor The editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -64,19 +64,19 @@ class SaveHierarchyDelegate : public QStyledItemDelegate /*! * Finds the preferred size for an item. * - * @param [in] option Style options for the item. - * @param [in] index The model index whose size to find. + * @param [in] option Style options for the item. + * @param [in] index The model index whose size to find. * - * @return The preferred size for the item. + * @return The preferred size for the item. */ virtual QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const; /*! * Draws an item. * - * @param [in] painter The painter to use for drawing. - * @param [in] option Style options for the item. - * @param [in] index The item to draw. + * @param [in] painter The painter to use for drawing. + * @param [in] option Style options for the item. + * @param [in] index The item to draw. */ virtual void paint(QPainter *painter, QStyleOptionViewItem const& option, QModelIndex const& index) const; diff --git a/mainwindow/SaveHierarchy/SaveHierarchyDialog.h b/mainwindow/SaveHierarchy/SaveHierarchyDialog.h index da318b134..735555840 100644 --- a/mainwindow/SaveHierarchy/SaveHierarchyDialog.h +++ b/mainwindow/SaveHierarchy/SaveHierarchyDialog.h @@ -61,9 +61,9 @@ private slots: /*! * Finds the number of checked items under a given tree item. * - * @param [in] item The item to start the count from. + * @param [in] item The item to start the count from. * - * @return The number of checked items under the item including the item itself. + * @return The number of checked items under the item including the item itself. */ int findNumberOfCheckedItems(QTreeWidgetItem* item); diff --git a/mainwindow/WorkspaceSettings.h b/mainwindow/WorkspaceSettings.h index d9f85c983..e779a19b8 100644 --- a/mainwindow/WorkspaceSettings.h +++ b/mainwindow/WorkspaceSettings.h @@ -30,8 +30,8 @@ class WorkspaceSettings : public QObject /*! * The constructor. * - * @param [in] mainWindow The mainwindow of the application. - * @param [in] docks The DockWidgetHandler which holds the visibility and filter settings. + * @param [in] mainWindow The mainwindow of the application. + * @param [in] docks The DockWidgetHandler which holds the visibility and filter settings. * */ WorkspaceSettings(QMainWindow* mainWindow, DockWidgetHandler* docks); @@ -62,21 +62,21 @@ class WorkspaceSettings : public QObject /*! * Saves the settings for the given workspace. * - * @param [in] workspaceName The name of the workspace. + * @param [in] workspaceName The name of the workspace. */ void saveWorkspace(QString const& workspaceName) const; /*! * Loads the settings for the given workspace and sets it as active workspace. * - * @param [in] workspaceName The name of the workspace. + * @param [in] workspaceName The name of the workspace. */ void loadWorkspace(QString const& workspaceName); /*! * Creates a new workspace. * - * @param [in] workspaceName The name of the new workspace. + * @param [in] workspaceName The name of the new workspace. */ void createNewWorkspace(QString const& workspaceName) const; @@ -112,7 +112,7 @@ private slots: /*! * Copy the component editor settings from the current workspace. * - * @param [in] workspaceName The name of the new workspace. + * @param [in] workspaceName The name of the new workspace. */ void copyComponentEditorSettings(QString const& workspaceName) const; diff --git a/mainwindow/mainwindow.h b/mainwindow/mainwindow.h index 5bdee35be..6e63aebdb 100644 --- a/mainwindow/mainwindow.h +++ b/mainwindow/mainwindow.h @@ -57,8 +57,8 @@ class MainWindow : public QMainWindow /*! * The constructor. * - * @param [in] library The used IP-XACT library instance. - * @param [in] parent The parent widget. + * @param [in] library The used IP-XACT library instance. + * @param [in] parent The parent widget. */ MainWindow(LibraryHandler* library, MessageMediator* messageChannel, QWidget *parent = 0); @@ -76,23 +76,23 @@ public slots: /*! * Opens the source file of the given component. * - * @param [in] compItem The component item. + * @param [in] compItem The component item. */ void openCSource(ComponentItem* compItem); /*! * Opens the specific C source file of the given component. * - * @param [in] filename The name of the file to open. - * @param [in] component The component containing the file. + * @param [in] filename The name of the file to open. + * @param [in] component The component containing the file. */ void openCSource(QString const& filename, QSharedPointer component); /*! * Opens a HW design. * - * @param [in] vlnv The VLNV of the top-level component. - * @param [in] viewName The name of the view to open. + * @param [in] vlnv The VLNV of the top-level component. + * @param [in] viewName The name of the view to open. */ void openHWDesign(VLNV const& vlnv = VLNV(), QString const& viewName = QString()); @@ -105,31 +105,31 @@ public slots: /*! * Opens the memory design of the HW design specified by the component VLNV and view name. * - * @param [in] vlnv The VLNV of the top-level component. - * @param [in] viewName Name of the view to open. + * @param [in] vlnv The VLNV of the top-level component. + * @param [in] viewName Name of the view to open. */ void openMemoryDesign(const VLNV& vlnv, const QString& viewName = QString()); /*! * Opens a SW design. * - * @param [in] vlnv The VLNV of the top-level component. - * @param [in] viewName The name of the view to open. + * @param [in] vlnv The VLNV of the top-level component. + * @param [in] viewName The name of the view to open. */ void openSWDesign(const VLNV& vlnv = VLNV(), QString const& viewName = QString()); /*! * Opens a system design. * - * @param [in] vlnv The VLNV of the system component whose system design to open. - * @param [in] viewName The name of the view to open. + * @param [in] vlnv The VLNV of the system component whose system design to open. + * @param [in] viewName The name of the view to open. */ void openSystemDesign(VLNV const &vlnv, QString const& viewName = QString()); /*! * Open bus to be edited. * - * @param [in] busDefVLNV Identifies the bus definition. + * @param [in] busDefVLNV Identifies the bus definition. */ void openBus(const VLNV& busDefVLNV); @@ -137,28 +137,28 @@ public slots: /*! * Open catalog editor to edit catalog details. * - * @param [in] vlnv Identifies the catalog to edit. + * @param [in] vlnv Identifies the catalog to edit. */ void openCatalog(const VLNV& vlnv); /*! * Open component editor to edit a component details. * - * @param [in] vlnv Identifies the component to edit. + * @param [in] vlnv Identifies the component to edit. */ void openComponent(const VLNV& vlnv); /*! * Opens a COM definition for editing. * - * @param [in] vlnv The VLNV of the COM definition to open. + * @param [in] vlnv The VLNV of the COM definition to open. */ void openComDefinition(VLNV const& vlnv); /*! * Opens an API definition for editing. * - * @param [in] vlnv The VLNV of the API definition to open. + * @param [in] vlnv The VLNV of the API definition to open. */ void openApiDefinition(VLNV const& vlnv); @@ -178,21 +178,21 @@ public slots: /*! * Called when user selects a component on the draw board. * - * @param [in] component Pointer to the DiagramComponent instance that is selected. + * @param [in] component Pointer to the DiagramComponent instance that is selected. */ void onComponentSelected(ComponentItem* component); /*! * Called when user selects an interface on the draw board. * - * @param [in] interface Pointer to the interface instance that is selected. + * @param [in] interface Pointer to the interface instance that is selected. */ void onInterfaceSelected(ConnectionEndpoint* interface); /*! * Called when user selects a connection on the draw board. * - * @param [in] connection Pointer to the connection that was selected. + * @param [in] connection Pointer to the connection that was selected. */ void onConnectionSelected(GraphicsConnection* connection); @@ -214,7 +214,7 @@ public slots: /*! * Runs the plugin generator specified by the given action. * - * @param [in] action The action corresponding to the plugin. + * @param [in] action The action corresponding to the plugin. */ void runGeneratorPlugin(QAction* action); @@ -249,12 +249,12 @@ public slots: /*! * Creates a new component to the library. * - * @param [in] prodHier The product hierarchy attribute. - * @param [in] firmness The firmness attribute. - * @param [in] tags Document tags. - * @param [in] vlnv The component's VLNV. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the component. + * @param [in] prodHier The product hierarchy attribute. + * @param [in] firmness The firmness attribute. + * @param [in] tags Document tags. + * @param [in] vlnv The component's VLNV. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the component. * * @remarks The component editor is opened automatically after successful creation. */ @@ -264,9 +264,9 @@ public slots: /*! * Creates a SW component to the library. * - * @param [in] vlnv The component's VLNV. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the component. + * @param [in] vlnv The component's VLNV. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the component. * * @remarks The component editor is opened automatically after successful creation. */ @@ -275,12 +275,12 @@ public slots: /*! * Creates a new design. * - * @param [in] prodHier The product hierarchy attribute. - * @param [in] firmness The firmness attribute. - * @param [in] tags Document tags. - * @param [in] vlnv The component's VLNV. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the component. + * @param [in] prodHier The product hierarchy attribute. + * @param [in] firmness The firmness attribute. + * @param [in] tags Document tags. + * @param [in] vlnv The component's VLNV. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the component. * * @remarks The HW design editor is opened automatically after successful creation. */ @@ -290,7 +290,7 @@ public slots: /*! * Creates a new design for an existing component. * - * @param [in] vlnv The component's VLNV. + * @param [in] vlnv The component's VLNV. * * @remarks The HW design editor is opened automatically after successful creation. */ @@ -301,18 +301,18 @@ public slots: /*! * Creates a new Catalog * - * @param [in] catalogVLNV The VLNV for the catalog. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the catalog. + * @param [in] catalogVLNV The VLNV for the catalog. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the catalog. */ void createCatalog(VLNV const& catalogVLNV, Document::Revision revision, QString const& directory); /*! * Creates a new hierarchical SW component with an SW design. * - * @param [in] vlnv The component's VLNV. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the component. + * @param [in] vlnv The component's VLNV. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the component. * * @remarks The SW design editor is opened automatically after successful creation. */ @@ -321,7 +321,7 @@ public slots: /*! * Creates a SW design for an existing component. * - * @param [in] vlnv The component's VLNV. + * @param [in] vlnv The component's VLNV. * * @remarks The SW design editor is opened automatically after successful creation. */ @@ -330,11 +330,11 @@ public slots: /*! * Creates a new system design. * - * @param [in] compVLNV The VLNV of an existing component. - * @param [in] viewName The name of the view to which the system design will be based on. - * @param [in] sysVLNV The VLNV of the system to be created. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the system. + * @param [in] compVLNV The VLNV of an existing component. + * @param [in] viewName The name of the view to which the system design will be based on. + * @param [in] sysVLNV The VLNV of the system to be created. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the system. */ void createSystem(VLNV const& compVLNV, QString const& viewName, VLNV const& sysVLNV, Document::Revision , QString const& directory); @@ -344,26 +344,26 @@ public slots: /*! * Creates a new bus definition and abstraction definition * - * @param [in] vlnv The vlnv for the bus definition - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the bus definition and abstraction definition. + * @param [in] vlnv The vlnv for the bus definition + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the bus definition and abstraction definition. */ void createBus(VLNV const& vlnv, Document::Revision revision, QString const& directory); /*! * Creates a new abstraction definition for given bus definition. * - * @param [in] busDefVLNV Identifies the bus definition. - * @param [in] directory The directory where to save the abstraction definition. + * @param [in] busDefVLNV Identifies the bus definition. + * @param [in] directory The directory where to save the abstraction definition. */ void createAbsDef(const VLNV& busDefVLNV, const QString& directory); /*! * Creates a new COM definition. * - * @param [in] vlnv VLNV for the COM definition. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the design. + * @param [in] vlnv VLNV for the COM definition. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the design. * * @remarks The COM definition editor is opened automatically after successful creation. */ @@ -372,9 +372,9 @@ public slots: /*! * Creates a new API definition. * - * @param [in] vlnv VLNV for the API definition. - * @param [in] revision The IP-XACT standard revision to comply to. - * @param [in] directory The directory where to save the design. + * @param [in] vlnv VLNV for the API definition. + * @param [in] revision The IP-XACT standard revision to comply to. + * @param [in] directory The directory where to save the design. * * @remarks The API definition editor is opened automatically after successful creation. */ @@ -463,14 +463,14 @@ private slots: /*! * Set the filtering of chained address space memory connections within a memory design. * - * @param [in] filterChains Value for the filter. + * @param [in] filterChains Value for the filter. */ void onFilterAddressSpaceChains(bool filterChains); /*! * Set the condensing of memory graphics items within a memory design. * - * @param [in] condenseMemoryItems Value for condensing the memory graphics items. + * @param [in] condenseMemoryItems Value for condensing the memory graphics items. */ void onCondenseMemoryItems(bool condenseMemoryItems); @@ -487,58 +487,58 @@ private slots: /*! * Set the filtering of address space segments within a memory design. * - * @param [in] filterSegments Value for the filter. + * @param [in] filterSegments Value for the filter. */ void onFilterSegments(bool filterSegments); /*! * Set the filtering of address blocks within a memory design. * - * @param [in] filterBlocks Value for the filter. + * @param [in] filterBlocks Value for the filter. */ void onFilterAddressBlocks(bool filterBlocks); /*! * Set the filtering of registers within a memory design. * - * @param [in] filterRegisters Value for the filter. + * @param [in] filterRegisters Value for the filter. */ void onFilterRegisters(bool filterRegisters); /*! * Set the filtering of fields within a memory design. * - * @param [in] filterFields Value for the filter. + * @param [in] filterFields Value for the filter. */ void onFilterFields(bool filterFields); /*! * Set the filtering of the unconnected memory items within a memory design. * - * @param [in] filterUnconnected Value for the filter. + * @param [in] filterUnconnected Value for the filter. */ void onFilterUnconnectedMemoryItems(bool filterUnconnected); /*! * Set the filtering of the memory overlap items within a memory design. * - * @param [in] filterOverlap Value for the filter. + * @param [in] filterOverlap Value for the filter. */ void onFilterMemoryOverlapItems(bool filterOverlap); /*! * Open the document containing the selected component and select the identified component item editor. * - * @param [in] componentVLNV VLNV of the selected component. - * @param [in] identifierChain List of string identifying the selected component item. + * @param [in] componentVLNV VLNV of the selected component. + * @param [in] identifierChain List of string identifying the selected component item. */ void onOpenComponentItem(const VLNV& componentVLNV, QVector identifierChain); /*! * Adjust the visibility of the selected dock widget. * - * @param [in] type Type of the selected dock widget. - * @param [in] show New value for the visibility of the dock widget. + * @param [in] type Type of the selected dock widget. + * @param [in] show New value for the visibility of the dock widget. */ void onAdjustVisibilityInWindow(TabDocument::SupportedWindows type, bool show); @@ -562,10 +562,10 @@ private slots: /*! * Checks if the given list of VLVNs contain invalid references. * - * @param [in] hierRefs The list of VLNVs to check - * @param [in] referencingVlnv The referencing VLNV. + * @param [in] hierRefs The list of VLNVs to check + * @param [in] referencingVlnv The referencing VLNV. * - * @return True, if at least one invalid reference is found, otherwise false. + * @return True, if at least one invalid reference is found, otherwise false. */ bool hasInvalidReferences(QList hierRefs, VLNV const& referencingVlnv); @@ -582,7 +582,7 @@ private slots: /*! * Restores the settings for the given workspace. * - * @param [in] workspaceName The name of the workspace. + * @param [in] workspaceName The name of the workspace. */ void loadWorkspace(QString const& workspaceName); @@ -629,11 +629,11 @@ private slots: /*! * Check if a document with the given vlnv is already open. * - * @param [in] vlnv The vlnv that identifies the document. + * @param [in] vlnv The vlnv that identifies the document. * * @remark If a document with given vlnv is open then the document is shown. * - * @return True if the document was already open. + * @return True if the document was already open. */ bool isOpen(const VLNV& vlnv, TabDocument::DocumentType const& type) const; @@ -645,7 +645,7 @@ private slots: /*! * Updates the visibility control menu according to the open document. * - * @param [in] document The currently open document. + * @param [in] document The currently open document. */ void updateVisibilityControlMenu(TabDocument* document); @@ -662,8 +662,8 @@ private slots: /*! * Runs the component editor for the given component. * - * @param [in] component The component to run the wizard for. - * @param [in] directory The directory containing the component xml file. + * @param [in] component The component to run the wizard for. + * @param [in] directory The directory containing the component xml file. */ void runComponentWizard(QSharedPointer component, QString const& directory); diff --git a/settings/CodeEditorSettingsPage.h b/settings/CodeEditorSettingsPage.h index 71c15bb50..b265d9fd1 100644 --- a/settings/CodeEditorSettingsPage.h +++ b/settings/CodeEditorSettingsPage.h @@ -38,7 +38,7 @@ class CodeEditorSettingsPage : public SettingsPage /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ CodeEditorSettingsPage(QSettings& settings); @@ -55,7 +55,7 @@ class CodeEditorSettingsPage : public SettingsPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/settings/ComponentEditorSettingsPage.h b/settings/ComponentEditorSettingsPage.h index be0144d75..86e078c8f 100644 --- a/settings/ComponentEditorSettingsPage.h +++ b/settings/ComponentEditorSettingsPage.h @@ -41,35 +41,35 @@ public slots: /*! * Select all hardware check boxes from the selected row. * - * @param [in] rowIndex The selected row. + * @param [in] rowIndex The selected row. */ void onHwHorizonSelectAll(int rowIndex); /*! * Select all hardware check boxes from the selected column. * - * @param [in] columnIndex The selected column. + * @param [in] columnIndex The selected column. */ void onHwVerticalSelectAll(int columnIndex); /*! * Select all software check boxes from the selected row. * - * @param [in] rowIndex The selected row. + * @param [in] rowIndex The selected row. */ void onSwHorizonSelectAll(int rowIndex); /*! * Select all software check boxes from the selected column. * - * @param [in] columnIndex If software would have hierarchy, this selects it. + * @param [in] columnIndex If software would have hierarchy, this selects it. */ void onSwVerticalSelectAll(); /*! * Change the workspace index. * - * @param [in] workspaceIndex The index value of the new workspace. + * @param [in] workspaceIndex The index value of the new workspace. */ void onWorkspaceChanged(int workspaceIndex); @@ -78,14 +78,14 @@ public slots: /*! * Apply the hardware settings. * - * @param [in] workspaceIndex The current workspace index. + * @param [in] workspaceIndex The current workspace index. */ void applyHwSettings(int workspaceIndex) const; /*! * Apply the software settings. * - * @param [in] workspaceIndex The current workspace index. + * @param [in] workspaceIndex The current workspace index. */ void applySwSettings(int workspaceIndex) const; @@ -107,17 +107,17 @@ public slots: /*! * Set the check box names to correct format. * - * @param [in/out] checkBoxNames List of names to be changed. + * @param [in/out] checkBoxNames List of names to be changed. */ void changeNameSeparators(QStringList& checkBoxNames); /*! * Set the hardware table. * - * @param [in] table The table. - * @param [in] horizontalHeaders Horizontal headers for the table. - * @param [in] verticalHeaders Vertical headers for the table. - * @param [in] workspaceIndex Current workspace index. + * @param [in] table The table. + * @param [in] horizontalHeaders Horizontal headers for the table. + * @param [in] verticalHeaders Vertical headers for the table. + * @param [in] workspaceIndex Current workspace index. */ void setHwTable(QTableWidget* table, QStringList horizontalHeaders, QStringList verticalHeaders, int workspaceIndex); @@ -125,10 +125,10 @@ public slots: /*! * Set the software table. * - * @param [in] table The table. - * @param [in] horizontalHeaders Horizontal headers for the table. - * @param [in] verticalHeaders Vertical headers for the table. - * @param [in] workspaceIndex Current workspace index. + * @param [in] table The table. + * @param [in] horizontalHeaders Horizontal headers for the table. + * @param [in] verticalHeaders Vertical headers for the table. + * @param [in] workspaceIndex Current workspace index. */ void setSwTable(QTableWidget* table, QStringList horizontalHeaders, QStringList verticalHeaders, int workspaceIndex); @@ -136,7 +136,7 @@ public slots: /*! * Center the check box to a table cell. * - * @param [in] checkBox Check box to be centered. + * @param [in] checkBox Check box to be centered. */ QWidget* centeredCheckBox(QCheckBox* checkBox); @@ -148,7 +148,7 @@ public slots: /*! * Set the check boxes to their respective lists. * - * @param [in] checkBoxes The current usable check box list. + * @param [in] checkBoxes The current usable check box list. */ QList setCheckBoxes(); diff --git a/settings/FileTypeSettingsPage.h b/settings/FileTypeSettingsPage.h index 6ffa7105a..6d83a6353 100644 --- a/settings/FileTypeSettingsPage.h +++ b/settings/FileTypeSettingsPage.h @@ -32,7 +32,7 @@ class FileTypeSettingsPage : public SettingsPage /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ FileTypeSettingsPage(QSettings& settings); diff --git a/settings/FileTypesDelegate.h b/settings/FileTypesDelegate.h index ec79e4cbf..5b1bacfbe 100644 --- a/settings/FileTypesDelegate.h +++ b/settings/FileTypesDelegate.h @@ -25,8 +25,8 @@ class FileTypesDelegate : public QStyledItemDelegate /*! * Constructor. * - * @param [in] revision The applied IP-XACT standard. - * @param [in] parent Pointer to the owner of this instance. + * @param [in] revision The applied IP-XACT standard. + * @param [in] parent Pointer to the owner of this instance. */ FileTypesDelegate(QObject* parent = nullptr); @@ -42,11 +42,11 @@ class FileTypesDelegate : public QStyledItemDelegate /*! * Creates a new editor for the given item. * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return The editor to be used to edit the item. + * @return The editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -54,17 +54,17 @@ class FileTypesDelegate : public QStyledItemDelegate /*! * Sets the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, const QModelIndex& index) const; /*! * Saves the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. * */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, diff --git a/settings/FileTypesModel.h b/settings/FileTypesModel.h index bb43b6990..a4f44fd47 100644 --- a/settings/FileTypesModel.h +++ b/settings/FileTypesModel.h @@ -31,8 +31,8 @@ class FileTypesModel : public QAbstractTableModel /*! * Constructor which loads the model from settings. * - * @param [in] settings The settings store. - * @param [in] parent The owner of this model. + * @param [in] settings The settings store. + * @param [in] parent The owner of this model. * */ FileTypesModel(QSettings& settings, QObject* parent); @@ -49,21 +49,21 @@ class FileTypesModel : public QAbstractTableModel /*! * Saves the model to settings. * - * @param [in,out] settings The settings store. + * @param [in,out] settings The settings store. */ void apply(QSettings& settings); /*! * Returns the number of rows to be displayed. * - * @param [in] parent Identifies the parent. Must always be a invalid index. + * @param [in] parent Identifies the parent. Must always be a invalid index. */ virtual int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Returns the number of columns to display. * - * @param [in] parent Identifies the parent. Must always be a invalid index. + * @param [in] parent Identifies the parent. Must always be a invalid index. */ virtual int columnCount(const QModelIndex& parent = QModelIndex()) const; @@ -72,41 +72,41 @@ class FileTypesModel : public QAbstractTableModel * * Qt::UserRole returns QStringList containing the file types that are already defined. * - * @param [in] index Identifies the object that's data is wanted. - * @param [in] role Identifies the type of data being requested. + * @param [in] index Identifies the object that's data is wanted. + * @param [in] role Identifies the type of data being requested. * - * @return QVariant containing the requested data. + * @return QVariant containing the requested data. */ virtual QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; /*! * Returns the data for given header in given data role. * - * @param [in] section Identifies the header section. - * @param [in] orientation Only Qt::Horizontal is supported. - * @param [in] role Identifies the type of the data being requested. + * @param [in] section Identifies the header section. + * @param [in] orientation Only Qt::Horizontal is supported. + * @param [in] role Identifies the type of the data being requested. * - * @return QVariant contains the requested data. + * @return QVariant contains the requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const; /*! * Sets the data for specified index. * - * @param [in] index Identifies the object that's data is to be saved. - * @param [in] value Contains the data to be saved. - * @param [in] role Identifies the type of the data to be saved. + * @param [in] index Identifies the object that's data is to be saved. + * @param [in] value Contains the data to be saved. + * @param [in] role Identifies the type of the data to be saved. * - * @return True if data was saved successfully. + * @return True if data was saved successfully. */ virtual bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole ); /*! * Retrieves info on what operations are possible for specified item. * - * @param [in] index Identifies the item that's operations are requested. + * @param [in] index Identifies the item that's operations are requested. * - * @return Item flags containing info on which operations are available for the given index. + * @return Item flags containing info on which operations are available for the given index. */ virtual Qt::ItemFlags flags(const QModelIndex& index) const; @@ -119,21 +119,21 @@ public slots: /*! * Removes a row from the model. * - * @param [in] row Specifies the row to remove. + * @param [in] row Specifies the row to remove. */ void onRemoveRow(int row); /*! * Called when a new item should be added to given index. * - * @param [in] index The position where new item should be added at. + * @param [in] index The position where new item should be added at. */ void onAddItem(const QModelIndex& index); /*! * An item should be removed from the model. * - * @param [in] index Identifies the item that should be removed. + * @param [in] index Identifies the item that should be removed. */ void onRemoveItem(const QModelIndex& index); diff --git a/settings/GeneralSettingsPage.h b/settings/GeneralSettingsPage.h index b537908c0..c37659274 100644 --- a/settings/GeneralSettingsPage.h +++ b/settings/GeneralSettingsPage.h @@ -31,7 +31,7 @@ class GeneralSettingsPage : public SettingsPage /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ GeneralSettingsPage(QSettings& settings); @@ -47,7 +47,7 @@ class GeneralSettingsPage : public SettingsPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ diff --git a/settings/NamingPolicySettingsPage.h b/settings/NamingPolicySettingsPage.h index 97bd9c1f7..65dfda750 100644 --- a/settings/NamingPolicySettingsPage.h +++ b/settings/NamingPolicySettingsPage.h @@ -34,7 +34,7 @@ class NamingPolicySettingsPage : public SettingsPage /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ NamingPolicySettingsPage(QSettings& settings); @@ -56,7 +56,7 @@ private slots: /*! * Updates the widget contents according to the new category selection. * - * @param [in] index The category index. + * @param [in] index The category index. */ void onCategoryChanged(int index); diff --git a/settings/NewPluginsDialog.h b/settings/NewPluginsDialog.h index a6e931ef1..01847646f 100644 --- a/settings/NewPluginsDialog.h +++ b/settings/NewPluginsDialog.h @@ -31,7 +31,7 @@ class NewPluginsDialog : public QDialog /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ NewPluginsDialog(QWidget* parent); @@ -47,14 +47,14 @@ class NewPluginsDialog : public QDialog /*! * Adds a plugin to the plugin list. * - * @param [in] plugin The plugin to add. + * @param [in] plugin The plugin to add. */ void addPlugin(IPlugin* plugin); /*! * Adds plugins to the plugin list. * - * @param [in] plugins The plugins to add. + * @param [in] plugins The plugins to add. */ void addPlugins(QList plugins); diff --git a/settings/PluginInfoWidget.h b/settings/PluginInfoWidget.h index 96128fe06..e3360822f 100644 --- a/settings/PluginInfoWidget.h +++ b/settings/PluginInfoWidget.h @@ -26,10 +26,10 @@ class PluginInfoWidget : public QWidget /*! * . * - * @param [in] plugin The plugin whose information to display. - * @param [in] parent The parent widget. + * @param [in] plugin The plugin whose information to display. + * @param [in] parent The parent widget. * - * @return + * @return */ PluginInfoWidget(IPlugin* plugin = nullptr, QWidget *parent = nullptr); diff --git a/settings/PluginSettingsPage.h b/settings/PluginSettingsPage.h index c89b0e8f1..bdce4d68f 100644 --- a/settings/PluginSettingsPage.h +++ b/settings/PluginSettingsPage.h @@ -32,7 +32,7 @@ class PluginSettingsPage : public SettingsPage /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ PluginSettingsPage(QSettings& settings); @@ -49,7 +49,7 @@ class PluginSettingsPage : public SettingsPage /*! * Validates the contents of the page thoroughly. * - * @return True, if the contents are valid. False, if they are invalid. + * @return True, if the contents are valid. False, if they are invalid. * * @remarks Showing message boxes for errors is allowed. */ @@ -90,17 +90,17 @@ private slots: /*! * Creates a new category item to the tree. * - * @param [in] text Category title text. - * @param [in] icon Icon for the category. + * @param [in] text Category title text. + * @param [in] icon Icon for the category. */ QTreeWidgetItem* createCategoryItem(QString const& text, QIcon const& icon); /*! * Creates a new plugin item to the tree. * - * @param [in] plugin Target plugin for the item. + * @param [in] plugin Target plugin for the item. * - * @return The created tree item. + * @return The created tree item. */ QTreeWidgetItem* createPluginItem(IPlugin* plugin); diff --git a/settings/SettingsDialog.h b/settings/SettingsDialog.h index 35c161f3c..098ecca3f 100644 --- a/settings/SettingsDialog.h +++ b/settings/SettingsDialog.h @@ -27,7 +27,7 @@ class SettingsDialog : public PropertyPageDialog /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ SettingsDialog(QWidget* parent = 0); diff --git a/settings/SettingsPage.h b/settings/SettingsPage.h index 1f3029c59..0be34edce 100644 --- a/settings/SettingsPage.h +++ b/settings/SettingsPage.h @@ -26,7 +26,7 @@ class SettingsPage : public PropertyPageView /*! * Constructor. * - * @param [in/out] settings The settings store. + * @param [in/out] settings The settings store. */ SettingsPage(QSettings& settings); @@ -42,7 +42,7 @@ class SettingsPage : public PropertyPageView /*! * Called when the page is to be changed and this page would be hidden. * - * @return False, if the page change should be rejected. Otherwise true. + * @return False, if the page change should be rejected. Otherwise true. */ virtual bool onPageChange(); diff --git a/settings/SettingsUpdater.h b/settings/SettingsUpdater.h index 253d1635c..c3ffb3104 100644 --- a/settings/SettingsUpdater.h +++ b/settings/SettingsUpdater.h @@ -32,28 +32,28 @@ namespace SettingsUpdater /*! * Compares version numbers. * - * @param [in] version The version to compare. - * @param [in] comparison The version to compare against. + * @param [in] version The version to compare. + * @param [in] comparison The version to compare against. * - * @return True, if the first version is older than the comparison. + * @return True, if the first version is older than the comparison. */ bool isVersionOlderThan(QString const& version, QString const& comparison); /*! * Open the configuration file for reading. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. * - * @return The open configuration file. + * @return The open configuration file. */ QFile* openConfigurationFile(MessageMediator* mediator); /*! * Parses a QVariant from the given text stream. * - * @param [in] lineStream The source text stream. + * @param [in] lineStream The source text stream. * - * @return The parsed QVariant. + * @return The parsed QVariant. */ QVariant parseVariant(QTextStream& lineStream); } diff --git a/settings/k2envvarmodel.h b/settings/k2envvarmodel.h index 79518b8f4..6eb5d27cb 100644 --- a/settings/k2envvarmodel.h +++ b/settings/k2envvarmodel.h @@ -51,68 +51,68 @@ class K2EnvVarModel : public QAbstractTableModel /*! * Save the model to settings. * - * @param [in] settings The settings to store to. + * @param [in] settings The settings to store to. */ void apply(QSettings& settings); /*! Get the number of rows an item contains. * - * @param [in] parent Identifies the parent that's row count is requested. + * @param [in] parent Identifies the parent that's row count is requested. * - * @return Number of rows the item has. + * @return Number of rows the item has. */ virtual int rowCount(QModelIndex const& parent = QModelIndex()) const override final; /*! Get the number of columns the item has to be displayed. * - * @param [in] parent Identifies the parent that's column count is requested. + * @param [in] parent Identifies the parent that's column count is requested. * - * @return The number of columns to be displayed. + * @return The number of columns to be displayed. */ virtual int columnCount(QModelIndex const& parent = QModelIndex()) const override final; /*! Get the item flags that defines the possible operations for the item. * - * @param [in] index Model index that identifies the item. + * @param [in] index Model index that identifies the item. * - * @return Flags specify the possible operations for the item. + * @return Flags specify the possible operations for the item. */ virtual Qt::ItemFlags flags(QModelIndex const& index) const override final; /*! Get the header data for specified header. * - * @param [in] section The section specifies the row/column number for the header. - * @param [in] orientation Specified if horizontal or vertical header is wanted. - * @param [in] role Specifies the type of the requested data. + * @param [in] section The section specifies the row/column number for the header. + * @param [in] orientation Specified if horizontal or vertical header is wanted. + * @param [in] role Specifies the type of the requested data. * - * @return The requested data. + * @return The requested data. */ virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override final; /*! Get the data for specified item. * - * @param [in] index Specifies the item that's data is requested. - * @param [in] role The role that defines what kind of data is requested. + * @param [in] index Specifies the item that's data is requested. + * @param [in] role The role that defines what kind of data is requested. * - * @return The data for the item. + * @return The data for the item. */ virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const override final; /*! Save the data to the model for specified item * - * @param [in] index The model index of the item that's data is to be saved. - * @param [in] value The data that is to be saved. - * @param [in] role The role specifies what kind of data should be saved. + * @param [in] index The model index of the item that's data is to be saved. + * @param [in] value The data that is to be saved. + * @param [in] role The role specifies what kind of data should be saved. * - * @return True if saving happened successfully. + * @return True if saving happened successfully. */ virtual bool setData(QModelIndex const& index, const QVariant& value, int role = Qt::EditRole) override final; /*! * Check that all variables have at least the name defined. * - * @return True if all defined variables contain a name, otherwise false. + * @return True if all defined variables contain a name, otherwise false. */ bool containsEmptyVariables() const; @@ -120,14 +120,14 @@ public slots: /*! Add a new item to the given index. * - * @param [in] index The index identifying the position for new item. + * @param [in] index The index identifying the position for new item. * */ virtual void onAddItem(QModelIndex const& index); /*! Remove the item in the given index. * - * @param [in] index The index identifying the item to remove. + * @param [in] index The index identifying the item to remove. */ virtual void onRemoveItem(QModelIndex const& index); @@ -157,11 +157,11 @@ public slots: /*! The constructor. * - * @param [in] name The name for the variable. - * @param [in] value The value for the variable. - * @param [in] fileSuffix The file suffix. - * @param [in] description Textual description for the variable. - * @param [in] fromPlugin Defines whether the variable is requested by the plugins. + * @param [in] name The name for the variable. + * @param [in] value The value for the variable. + * @param [in] fileSuffix The file suffix. + * @param [in] description Textual description for the variable. + * @param [in] fromPlugin Defines whether the variable is requested by the plugins. * */ explicit EnvSetting(QString const& name, diff --git a/tests/MockObjects/LibraryMock.h b/tests/MockObjects/LibraryMock.h index 231a22bc5..83f2f6fa9 100644 --- a/tests/MockObjects/LibraryMock.h +++ b/tests/MockObjects/LibraryMock.h @@ -30,196 +30,196 @@ class LibraryMock : public QObject, public LibraryInterface /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ void addComponent(QSharedPointer component); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ void clear(); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual QSharedPointer getModel(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual QSharedPointer getModelReadOnly(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual bool contains(const VLNV& vlnv) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual const QString getPath(const VLNV& vlnv) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual QString getDirectoryPath(const VLNV& vlnv) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual bool writeModelToFile(const QString& path, QSharedPointer model); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual bool writeModelToFile(QSharedPointer model); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void searchForIPXactFiles(); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void getNeededVLNVs(const VLNV& vlnv, QList& list); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void getDependencyFiles(const VLNV& vlnv, QStringList& list); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void getHierarchicalDependencyFiles(const VLNV& vlnv, QStringList& list); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual LibraryItem const* getTreeRoot() const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual VLNV::IPXactType getDocumentType(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual int referenceCount(const VLNV& vlnv) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual int getOwners(QList& list, const VLNV& vlnvToSearch) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual int getChildren(QList& list, const VLNV& vlnvToSearch) const; /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual VLNV getDesignVLNV(const VLNV& hierarchyRef); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual QSharedPointer getDesign(const VLNV& hierarchyRef); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual bool isValid(const VLNV& vlnv); /*! * Gets all the VLVNs currently in the library. * - * @return All current VLNVs. + * @return All current VLNVs. */ virtual QList getAllVLNVs() const; @@ -228,99 +228,99 @@ public slots: /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onCheckLibraryIntegrity(); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onSelectionChanged(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onClearSelection(); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onEditItem(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onOpenDesign(const VLNV& vlnv, QString const& viewName); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onCreateNewItem(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void onCreateDesign(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void removeObject(const VLNV& vlnv); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void removeObjects(const QList& vlnvList); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void beginSave(); /*! * Method description. * - * @param [in] Description. + * @param [in] Description. * - * @return Description. + * @return Description. */ virtual void endSave(); diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizard.h b/wizards/BusInterfaceWizard/BusInterfaceWizard.h index 66099d6d3..88694932b 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizard.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizard.h @@ -57,14 +57,14 @@ class BusInterfaceWizard : public QWizard /*! * The constructor. * - * @param [in] component The component for which the wizard is run. - * @param [in] busIf The bus interface for which the wizard is run. - * @param [in] handler Pointer to the instance which manages the library. - * @param [in] portNames Names of the physical ports used to generate the interface. - * @param [in] parent The parent widget. - * @param [in] absDefVLNV VLNV of the fixed abstraction definition of the bus interface. + * @param [in] component The component for which the wizard is run. + * @param [in] busIf The bus interface for which the wizard is run. + * @param [in] handler Pointer to the instance which manages the library. + * @param [in] portNames Names of the physical ports used to generate the interface. + * @param [in] parent The parent widget. + * @param [in] absDefVLNV VLNV of the fixed abstraction definition of the bus interface. * If invalid, VLNV can be chosen freely on general page. - * @param [in] descriptionAsLogicalName Logical signal naming selection. + * @param [in] descriptionAsLogicalName Logical signal naming selection. */ BusInterfaceWizard(QSharedPointer component, QSharedPointer busIf, @@ -83,14 +83,14 @@ class BusInterfaceWizard : public QWizard /*! * Increase the number of references made to a specific parameter. * - * @param [in] id The id of the parameter whose reference count is to be increased. + * @param [in] id The id of the parameter whose reference count is to be increased. */ void increaseReferences(QString id); /*! * Decrease the number of references made to a specific parameter. * - * @param [in] id The id of the parameter whose reference count is to be decreased. + * @param [in] id The id of the parameter whose reference count is to be decreased. */ void decreaseReferences(QString id); diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizardAbsDefinitionPage.h b/wizards/BusInterfaceWizard/BusInterfaceWizardAbsDefinitionPage.h index 27880f4f5..06f675bb8 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizardAbsDefinitionPage.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizardAbsDefinitionPage.h @@ -50,13 +50,13 @@ class BusInterfaceWizardAbsDefinitionPage : public QWizardPage /*! * The constructor. * - * @param [in] component The component whose bus interface is being edited. - * @param [in] busIf The bus interface being edited. - * @param [in] lh The component library handler. - * @param [in] physicalPorts Physical ports used in logical signal generation. - * @param [in] parent The parent wizard. - * @param [in] absDefVLNV VLNV of the editable abstraction defintion. - * @param [in] namingPolicy Policy for naming generated logical signals. + * @param [in] component The component whose bus interface is being edited. + * @param [in] busIf The bus interface being edited. + * @param [in] lh The component library handler. + * @param [in] physicalPorts Physical ports used in logical signal generation. + * @param [in] parent The parent wizard. + * @param [in] absDefVLNV VLNV of the editable abstraction defintion. + * @param [in] namingPolicy Policy for naming generated logical signals. */ BusInterfaceWizardAbsDefinitionPage(QSharedPointer component, QSharedPointer busIf, LibraryInterface* lh, @@ -109,17 +109,17 @@ public slots: * Creates the logical ports to the abstraction definition and initial mapping of physical ports to the * created logical ports. * - * @param [in] physPorts The physical ports from which the logical ports are generated. - * @param [in] absDef The abstraction definition to create the ports to. + * @param [in] physPorts The physical ports from which the logical ports are generated. + * @param [in] absDef The abstraction definition to create the ports to. */ void createLogicalPortsAndMappings(QStringList const& physPorts, QSharedPointer absDef); /*! * Creates initial mapping of physical ports to a single logical port. * - * @param [in] physPorts The physical ports to map. - * @param [in] logicalPort The logical port to map to. - * @param [in] logicalPort The direction of the logical port. + * @param [in] physPorts The physical ports to map. + * @param [in] logicalPort The logical port to map to. + * @param [in] logicalPort The direction of the logical port. */ void createLogicalMappings(QStringList const& physPorts, QString const& logicalPort, DirectionTypes::Direction logicalDirection); @@ -132,10 +132,10 @@ public slots: /*! * Finds a logical port by name. * - * @param [in] portName The name of the port to find. - * @param [in] ports The group of ports to search. + * @param [in] portName The name of the port to find. + * @param [in] ports The group of ports to search. * - * @return The searched port or 0 if port was not found in the group. + * @return The searched port or 0 if port was not found in the group. */ QSharedPointer findPortByName(QString const& portName, QSharedPointer > > ports); @@ -144,11 +144,11 @@ public slots: /*! * Creates a port abstraction. * - * @param [in] portName Name of the port. - * @param [in] portDirection Direction of the port. - * @param [in] portWidth Width of the port. + * @param [in] portName Name of the port. + * @param [in] portDirection Direction of the port. + * @param [in] portWidth Width of the port. * - * @return The created port. + * @return The created port. */ QSharedPointer createAbsPort(QString const& portName, DirectionTypes::Direction portDirection, int portWidth ); @@ -156,9 +156,9 @@ public slots: /*! * Get the size of a port. * - * @param [in] targetPort The port whose size is being searched for. + * @param [in] targetPort The port whose size is being searched for. * - * @return The size of the port. + * @return The size of the port. */ int getPortSize(QSharedPointer targetPort) const; diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizardBusDefinitionPage.h b/wizards/BusInterfaceWizard/BusInterfaceWizardBusDefinitionPage.h index ea5d4dbcb..c2274fe77 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizardBusDefinitionPage.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizardBusDefinitionPage.h @@ -43,10 +43,10 @@ class BusInterfaceWizardBusDefinitionEditorPage : public QWizardPage /*! * The constructor. * - * @param [in] component The component whose bus interface is being edited. - * @param [in] busIf The bus interface being edited. - * @param [in] lh The component library handler. - * @param [in] parent The parent wizard. + * @param [in] component The component whose bus interface is being edited. + * @param [in] busIf The bus interface being edited. + * @param [in] lh The component library handler. + * @param [in] parent The parent wizard. */ BusInterfaceWizardBusDefinitionEditorPage(QSharedPointer component, QSharedPointer busIf, LibraryInterface* lh, bool editable, diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizardConclusionPage.h b/wizards/BusInterfaceWizard/BusInterfaceWizardConclusionPage.h index 3d669803c..aae9eb185 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizardConclusionPage.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizardConclusionPage.h @@ -30,9 +30,9 @@ class BusInterfaceWizardConclusionPage : public QWizardPage /*! * The constructor. * - * @param [in] busIf The bus interface being edited. - * @param [in] ports The ports selected to the wizard. - * @param [in] parent The parent wizard. + * @param [in] busIf The bus interface being edited. + * @param [in] ports The ports selected to the wizard. + * @param [in] parent The parent wizard. */ BusInterfaceWizardConclusionPage(QSharedPointer busIf, QStringList ports, BusInterfaceWizard* parent); diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizardGeneralOptionsPage.h b/wizards/BusInterfaceWizard/BusInterfaceWizardGeneralOptionsPage.h index 233e66ea0..75396df95 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizardGeneralOptionsPage.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizardGeneralOptionsPage.h @@ -40,15 +40,15 @@ class BusInterfaceWizardGeneralOptionsPage : public QWizardPage /*! * The constructor. * - * @param [in] component The component whose bus interface is being edited. - * @param [in] busIf The bus interface being edited. - * @param [in] lh The component library handler. - * @param [in] absDefEditable The editability of abstract definition. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] busValidator Validator for bus interfaces. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent wizard. + * @param [in] component The component whose bus interface is being edited. + * @param [in] busIf The bus interface being edited. + * @param [in] lh The component library handler. + * @param [in] absDefEditable The editability of abstract definition. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] busValidator Validator for bus interfaces. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent wizard. */ BusInterfaceWizardGeneralOptionsPage(QSharedPointer component, QSharedPointer busIf, @@ -78,7 +78,7 @@ class BusInterfaceWizardGeneralOptionsPage : public QWizardPage /*! * Checks if all the required fields on the page are valid. * - * @return True, if all fields are valid, otherwise false. + * @return True, if all fields are valid, otherwise false. */ virtual bool isComplete() const; @@ -87,21 +87,21 @@ class BusInterfaceWizardGeneralOptionsPage : public QWizardPage /*! * Increase the number of references made to a specific parameter. * - * @param [in] id The id of the parameter whose reference count is to be increased. + * @param [in] id The id of the parameter whose reference count is to be increased. */ void increaseReferences(QString id); /*! * Decrease the number of references made to a specific parameter. * - * @param [in] id The id of the parameter whose reference count is to be decreased. + * @param [in] id The id of the parameter whose reference count is to be decreased. */ void decreaseReferences(QString id); /*! * Inform of a change in the name of the bus interface. * - * @param [in] busName The new name of the bus interface. + * @param [in] busName The new name of the bus interface. */ void busNameChanged(std::string const& busName); @@ -113,7 +113,7 @@ class BusInterfaceWizardGeneralOptionsPage : public QWizardPage /*! * Checks if all the mandatory fields are filled in. * - * @return True, if mandatory fields are filled, otherwise false. + * @return True, if mandatory fields are filled, otherwise false. */ bool mandatoryFieldsAreFilledIn() const; @@ -125,7 +125,7 @@ class BusInterfaceWizardGeneralOptionsPage : public QWizardPage /*! * Check if a valid reference to an existing abstraction definition is found. * - * @return True, if a valid abstraction definition is found, false otherwise. + * @return True, if a valid abstraction definition is found, false otherwise. */ bool abstractionReferenceIsFound() const; diff --git a/wizards/BusInterfaceWizard/BusInterfaceWizardPortMapPage.h b/wizards/BusInterfaceWizard/BusInterfaceWizardPortMapPage.h index e3951072d..ba0933831 100644 --- a/wizards/BusInterfaceWizard/BusInterfaceWizardPortMapPage.h +++ b/wizards/BusInterfaceWizard/BusInterfaceWizardPortMapPage.h @@ -42,15 +42,15 @@ class BusInterfaceWizardPortMapPage : public QWizardPage /*! * The constructor. * - * @param [in] component The component whose bus interface is being edited. - * @param [in] busIf The bus interface being edited. - * @param [in] lh The component library handler. - * @param [in] physicalPorts The physical ports selected for mapping. - * @param [in] expressionParser The used expression parser. - * @param [in] parameterFinder The used parameter finder. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] portMapInterface Interface for accessing port maps. - * @param [in] parent The parent wizard. + * @param [in] component The component whose bus interface is being edited. + * @param [in] busIf The bus interface being edited. + * @param [in] lh The component library handler. + * @param [in] physicalPorts The physical ports selected for mapping. + * @param [in] expressionParser The used expression parser. + * @param [in] parameterFinder The used parameter finder. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] portMapInterface Interface for accessing port maps. + * @param [in] parent The parent wizard. */ BusInterfaceWizardPortMapPage(QSharedPointer component, QSharedPointer busIf, @@ -80,7 +80,7 @@ class BusInterfaceWizardPortMapPage : public QWizardPage /*! * Checks if all the required fields on the page are valid. * - * @return True, if all fields are valid, otherwise false. + * @return True, if all fields are valid, otherwise false. */ virtual bool isComplete() const; @@ -89,7 +89,7 @@ class BusInterfaceWizardPortMapPage : public QWizardPage /*! * Inform of a change in the bus interface name. * - * @param [in] busName The new name of the bus interface. + * @param [in] busName The new name of the bus interface. */ void busNameChanged(std::string const& busName); diff --git a/wizards/ComponentWizard/ComponentWizard.h b/wizards/ComponentWizard/ComponentWizard.h index 4385faa88..3c8dfb7f8 100644 --- a/wizards/ComponentWizard/ComponentWizard.h +++ b/wizards/ComponentWizard/ComponentWizard.h @@ -35,10 +35,10 @@ class ComponentWizard : public QWizard /*! * Constructor. * - * @param [in] component The component for which the wizard is run. - * @param [in] basePath The base path where the component XML will be located. - * @param [in] handler Pointer to the instance which manages the library. - * @param [in] parent The parent widget. + * @param [in] component The component for which the wizard is run. + * @param [in] basePath The base path where the component XML will be located. + * @param [in] handler Pointer to the instance which manages the library. + * @param [in] parent The parent widget. */ ComponentWizard(QSharedPointer component, QString const& basePath, @@ -60,7 +60,7 @@ class ComponentWizard : public QWizard /*! * Called when back has been selected on a wizard page. * - * @param [in] id The id of the page. + * @param [in] id The id of the page. */ virtual void cleanupPage(int id); @@ -69,7 +69,7 @@ private slots: /*! * Called when a new component has been imported. * - * @param [in] component The newly imported component. + * @param [in] component The newly imported component. */ virtual void onComponentChanged(QSharedPointer component); @@ -81,9 +81,9 @@ private slots: /*! * Create an interface for accessing file sets. * - * @param [in] parser Expression parser. + * @param [in] parser Expression parser. * - * @return Interface for accessing file sets. + * @return Interface for accessing file sets. */ FileSetInterface* createFileSetInterface(QSharedPointer parser); diff --git a/wizards/ComponentWizard/ComponentWizardConclusionPage.h b/wizards/ComponentWizard/ComponentWizardConclusionPage.h index 29d125066..ecdaae346 100644 --- a/wizards/ComponentWizard/ComponentWizardConclusionPage.h +++ b/wizards/ComponentWizard/ComponentWizardConclusionPage.h @@ -33,10 +33,10 @@ class ComponentWizardConclusionPage : public QWizardPage /*! * Constructor. * - * @param [in] component The initial component to create. - * @param [in] lh The library interface. - * @param [in] expressionFormatter The expression formatter. - * @param [in] parent The parent wizard. + * @param [in] component The initial component to create. + * @param [in] lh The library interface. + * @param [in] expressionFormatter The expression formatter. + * @param [in] parent The parent wizard. */ ComponentWizardConclusionPage(QSharedPointer component, LibraryInterface* lh, @@ -86,10 +86,10 @@ public slots: /*! * Creates a summary of changes in given element. * - * @param [in] element The name of the element to summarize. - * @param [in] diffs List of changes to the component. + * @param [in] element The name of the element to summarize. + * @param [in] diffs List of changes to the component. * - * @return Summary of changes of the given element. + * @return Summary of changes of the given element. */ DiffSummary creteSummaryFor(QString const& element, QList > const& diffs) const; diff --git a/wizards/ComponentWizard/ComponentWizardDependencyPage.h b/wizards/ComponentWizard/ComponentWizardDependencyPage.h index 86e242a96..5f12f4dfd 100644 --- a/wizards/ComponentWizard/ComponentWizardDependencyPage.h +++ b/wizards/ComponentWizard/ComponentWizardDependencyPage.h @@ -34,11 +34,11 @@ class ComponentWizardDependencyPage : public QWizardPage /*! * The constructor. * - * @param [in] component The component. - * @param [in] parameterFinder Finder used to identify parameters. - * @param [in] componentPath Path to the component. - * @param [in] fileSetInterface Interface for accessing file sets. - * @param [in] parent The parent wizard. + * @param [in] component The component. + * @param [in] parameterFinder Finder used to identify parameters. + * @param [in] componentPath Path to the component. + * @param [in] fileSetInterface Interface for accessing file sets. + * @param [in] parent The parent wizard. */ ComponentWizardDependencyPage(QSharedPointer component, QSharedPointer parameterFinder, diff --git a/wizards/ComponentWizard/ComponentWizardGeneralInfoPage.h b/wizards/ComponentWizard/ComponentWizardGeneralInfoPage.h index 9a93772b2..a9ba3d4c8 100644 --- a/wizards/ComponentWizard/ComponentWizardGeneralInfoPage.h +++ b/wizards/ComponentWizard/ComponentWizardGeneralInfoPage.h @@ -33,7 +33,7 @@ class ComponentWizardGeneralInfoPage : public QWizardPage * Constructor. * * @param [in, out] component Pointer to the component being edited. - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ComponentWizardGeneralInfoPage(QSharedPointer component, QWidget* parent); @@ -50,7 +50,7 @@ class ComponentWizardGeneralInfoPage : public QWizardPage /*! * Check if the settings on the page are valid and user can move to next page. * - * @return True if all settings are valid, otherwise false. + * @return True if all settings are valid, otherwise false. */ virtual bool isComplete() const; diff --git a/wizards/ComponentWizard/ComponentWizardImportPage.h b/wizards/ComponentWizard/ComponentWizardImportPage.h index 7e3aa0ad9..5812ae638 100644 --- a/wizards/ComponentWizard/ComponentWizardImportPage.h +++ b/wizards/ComponentWizard/ComponentWizardImportPage.h @@ -39,12 +39,12 @@ class ComponentWizardImportPage : public QWizardPage /*! * The constructor. * - * @param [in] component Pointer to the component being edited. - * @param [in] handler Pointer to the instance which manages the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent wizard. + * @param [in] component Pointer to the component being edited. + * @param [in] handler Pointer to the instance which manages the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent wizard. */ ComponentWizardImportPage(QSharedPointer component, LibraryInterface* handler, @@ -72,7 +72,7 @@ class ComponentWizardImportPage : public QWizardPage /*! * Check if the settings on the page are valid and user can move to next page. * - * @return True if all settings are valid, otherwise false. + * @return True if all settings are valid, otherwise false. */ virtual bool isComplete() const; @@ -84,14 +84,14 @@ class ComponentWizardImportPage : public QWizardPage /*! * Increase the number of references to the selected parameter. * - * @param [in] id The selected parameter. + * @param [in] id The selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references to the selected parameter. * - * @param [in] id The selected parameter. + * @param [in] id The selected parameter. */ void decreaseReferences(QString const& id); @@ -100,7 +100,7 @@ private slots: /*! * Handle the change in imported component. * - * @param [in] newComponent The new component. + * @param [in] newComponent The new component. */ void onComponentChange(QSharedPointer newComponent); @@ -112,9 +112,9 @@ private slots: /*! * Get the list of imported instances from the selected component. * - * @param [in] newComponent The selected component. + * @param [in] newComponent The selected component. * - * @return List of imported instances from the selected component. + * @return List of imported instances from the selected component. */ QVector getVerilogInstancesFromComponent(QSharedPointer newComponent) const; @@ -122,9 +122,9 @@ private slots: /*! * Get the list of imported instances from the selected vendor extension. * - * @param [in] instancesGroup Extension group for component instances. + * @param [in] instancesGroup Extension group for component instances. * - * @return List of imported instances from the selected extension group. + * @return List of imported instances from the selected extension group. */ QVector getVerilogInstancesFromExtension( QSharedPointer instancesGroup) const; @@ -132,21 +132,21 @@ private slots: /*! * Get the string for the selected instance parameter. * - * @param [in] stringID ID of the selected parameter. - * @param [in] extensionGroup Vendor extension group containing the instance. + * @param [in] stringID ID of the selected parameter. + * @param [in] extensionGroup Vendor extension group containing the instance. * - * @return Instance data matching the ID. + * @return Instance data matching the ID. */ QString getInstanceString(QString const& stringID, QSharedPointer extensionGroup) const; /*! * Get the string pairs for the selected instance parameter pair. * - * @param [in] itemGroupID ID of the selected item group. - * @param [in] itemID ID of the item pair. - * @param [in] extensionGroup Vendor extension group for the parameter pairs. + * @param [in] itemGroupID ID of the selected item group. + * @param [in] itemID ID of the item pair. + * @param [in] extensionGroup Vendor extension group for the parameter pairs. * - * @return Parameter pair data for the selected ID. + * @return Parameter pair data for the selected ID. */ QVector > getInstanceStringPairs(QString const& itemGroupID, QString const& itemID, QSharedPointer extensionGroup) const; @@ -154,10 +154,10 @@ private slots: /*! * Get a single value from the selected extension group. * - * @param [in] valueID ID of the selected item. - * @param [in] extensionGroup Vendor extension group for the parameter pairs. + * @param [in] valueID ID of the selected item. + * @param [in] extensionGroup Vendor extension group for the parameter pairs. * - * @return Value of the selected ID. + * @return Value of the selected ID. */ QString getSingleValueFromGroup(QString const& valueID, QSharedPointer extensionGroup) const; diff --git a/wizards/ComponentWizard/ComponentWizardIntroPage.h b/wizards/ComponentWizard/ComponentWizardIntroPage.h index 37134df43..be31d453a 100644 --- a/wizards/ComponentWizard/ComponentWizardIntroPage.h +++ b/wizards/ComponentWizard/ComponentWizardIntroPage.h @@ -28,7 +28,7 @@ class ComponentWizardIntroPage : public QWizardPage * Constructor. * * @param [in, out] component The component being edited. - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ComponentWizardIntroPage(QSharedPointer component, QWidget* parent); diff --git a/wizards/ComponentWizard/ComponentWizardViewsPage.h b/wizards/ComponentWizard/ComponentWizardViewsPage.h index 16b26813c..6a4b8b2b6 100644 --- a/wizards/ComponentWizard/ComponentWizardViewsPage.h +++ b/wizards/ComponentWizard/ComponentWizardViewsPage.h @@ -42,10 +42,10 @@ class ComponentWizardViewsPage : public QWizardPage /*! * The Constructor. * - * @param [in] lh The library interface. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] parent The parent wizard. + * @param [in] lh The library interface. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] parent The parent wizard. */ ComponentWizardViewsPage(LibraryInterface* lh, QSharedPointer parameterFinder, QSharedPointer expressionFormatter, ComponentWizard* parent); @@ -85,7 +85,7 @@ private slots: /*! * Called when a view is selected from the list. * - * @param [in] index The index of the selected view. + * @param [in] index The index of the selected view. */ void onViewSelected(QModelIndex const& index); @@ -97,22 +97,22 @@ private slots: /*! * Updates the icon for a given tab according to editor validity. * - * @param [in] tabIndex The index of the tab to update. + * @param [in] tabIndex The index of the tab to update. */ void updateIconForTab(int tabIndex) const; /*! * Creates an editor for a given view. * - * @param [in] component The component whose view the editor is for. - * @param [in] view The view for which to create an editor. + * @param [in] component The component whose view the editor is for. + * @param [in] view The view for which to create an editor. */ void createEditorForView(QSharedPointer component, QSharedPointer view); /*! * Removes all editors for a given view. * - * @param [in] viewName The name of the view whose editors to remove. + * @param [in] viewName The name of the view whose editors to remove. */ void removeEditorsForView(QString const& viewName); @@ -122,10 +122,10 @@ private slots: /*! * Finds a design instantiation referenced by a view. * - * @param [in] component The component containing the view. - * @param [in] targetView The selected view. + * @param [in] component The component containing the view. + * @param [in] targetView The selected view. * - * @return A design instantiation referenced by a view. + * @return A design instantiation referenced by a view. */ QSharedPointer getReferencedDesignInstantiation(QSharedPointer component, QSharedPointer targetView) const; @@ -133,10 +133,10 @@ private slots: /*! * Finds a design configuration instantiation referenced by a view. * - * @param [in] component The component containing the view. - * @param [in] targetView The selected view. + * @param [in] component The component containing the view. + * @param [in] targetView The selected view. * - * @return A component design configuration referenced by a view. + * @return A component design configuration referenced by a view. */ QSharedPointer getReferencedDesignConfigurationInstantiation( QSharedPointer component, QSharedPointer targetView) const; diff --git a/wizards/ComponentWizard/ImportEditor.h b/wizards/ComponentWizard/ImportEditor.h index 11c5a21c3..eb9212cc1 100644 --- a/wizards/ComponentWizard/ImportEditor.h +++ b/wizards/ComponentWizard/ImportEditor.h @@ -44,12 +44,12 @@ class ImportEditor : public QWidget /*! * The constructor. * - * @param [in] component The component being edited. - * @param [in] handler The instance which manages the library. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The owner of this widget. + * @param [in] component The component being edited. + * @param [in] handler The instance which manages the library. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The owner of this widget. */ ImportEditor(QSharedPointer component, LibraryInterface* handler, @@ -72,7 +72,7 @@ class ImportEditor : public QWidget /*! * Checks the validity of model parameter and port editors. * - * @return False if contents of either editor is not valid. + * @return False if contents of either editor is not valid. */ bool checkEditorValidity() const; @@ -87,14 +87,14 @@ class ImportEditor : public QWidget /*! * Increase the number of references to the selected parameter. * - * @param [in] id The selected parameter. + * @param [in] id The selected parameter. */ void increaseReferences(QString const& id); /*! * Decrease the number of references to the selected parameter. * - * @param [in] id The selected parameter. + * @param [in] id The selected parameter. */ void decreaseReferences(QString const& id); @@ -117,7 +117,7 @@ private slots: /*! * Handle the change in the imported component. * - * @param [in] index Index of the new component. + * @param [in] index Index of the new component. */ void onChangeSelectedComponent(int index); @@ -132,16 +132,16 @@ private slots: /*! * Finds the file extensions for given file types. * - * @param [in] possibleFileTypes The file types whose extensions to find. + * @param [in] possibleFileTypes The file types whose extensions to find. * - * @return The file extensions for the file types. + * @return The file extensions for the file types. */ QStringList fileExtensionsForTypes(QStringList possibleFileTypes) const; /*! * Gets the absolute path to the selected source file. * - * @return The absolute path to the selected source file. + * @return The absolute path to the selected source file. */ QString selectedFileAbsolutePath() const; @@ -156,16 +156,16 @@ private slots: /*! * Get the filters for file browsing. * - * @return List of filters combined with white space. + * @return List of filters combined with white space. */ QString getFileBrowsingFilters() const; /*! * Check if a file exists in the file selector. * - * @param [in] filePath Path of the selected file. + * @param [in] filePath Path of the selected file. * - * @return True, if the file exists in the file selector, false otherwise. + * @return True, if the file exists in the file selector, false otherwise. */ bool fileExistsInFileSelector(QString const& filePath) const; diff --git a/wizards/ComponentWizard/ViewListModel.h b/wizards/ComponentWizard/ViewListModel.h index d1fe36124..bde09fa76 100644 --- a/wizards/ComponentWizard/ViewListModel.h +++ b/wizards/ComponentWizard/ViewListModel.h @@ -29,7 +29,7 @@ class ViewListModel : public QAbstractListModel /*! * The constructor. * - * @param [in] parent The parent object. + * @param [in] parent The parent object. */ ViewListModel(QObject *parent); @@ -39,26 +39,26 @@ class ViewListModel : public QAbstractListModel /*! * Sets the component whose views to list. * - * @param [in] component The component whose views to list in the model. + * @param [in] component The component whose views to list in the model. */ void setComponent(QSharedPointer component); /*! * Returns the number of rows in the model. * - * @param [in] parent The parent index whose row count to return. Should always be invalid in list. + * @param [in] parent The parent index whose row count to return. Should always be invalid in list. * - * @return The number of rows in the model. + * @return The number of rows in the model. */ int rowCount(const QModelIndex& parent = QModelIndex()) const; /*! * Returns the data in the model. * - * @param [in] index The index whose data to fetch. - * @param [in] role The role of the data to fetch. + * @param [in] index The index whose data to fetch. + * @param [in] role The role of the data to fetch. * - * @return The model data for the given role. + * @return The model data for the given role. */ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const; diff --git a/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesDelegate.h b/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesDelegate.h index b9feb0dc8..0a0d03b2e 100644 --- a/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesDelegate.h +++ b/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesDelegate.h @@ -32,10 +32,10 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * The constructor. * - * @param [in] workingComponent The imported component. - * @param [in] defaultPath The default library path. - * @param [in] libraryAccess The library interface. - * @param [in] parent The parent of the object. + * @param [in] workingComponent The imported component. + * @param [in] defaultPath The default library path. + * @param [in] libraryAccess The library interface. + * @param [in] parent The parent of the object. */ ImportInstancesDelegate(QSharedPointer workingComponent, QString const& defaultPath, LibraryInterface* libraryAccess, QObject* parent = 0); @@ -48,8 +48,8 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * Setup the options for the VLNV editor. * - * @param [in] instanceComponentMatches The possible component modules for each component instance. - * @param [in] newInstances List of imported component instances. + * @param [in] instanceComponentMatches The possible component modules for each component instance. + * @param [in] newInstances List of imported component instances. */ void setupVLNVEditors(QMultiMap< QString, QSharedPointer > instanceComponentMatches, QVector const& newInstances); @@ -57,11 +57,11 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * Create a new editor for the given item * - * @param [in] parent Owner for the editor. - * @param [in] option Contains options for the editor. - * @param [in] index Model index identifying the item. + * @param [in] parent Owner for the editor. + * @param [in] option Contains options for the editor. + * @param [in] index Model index identifying the item. * - * @return Pointer to the editor to be used to edit the item. + * @return Pointer to the editor to be used to edit the item. */ virtual QWidget* createEditor(QWidget* parent, QStyleOptionViewItem const& option, QModelIndex const& index) const; @@ -69,17 +69,17 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * Set the data for the editor. * - * @param [in] editor Pointer to the editor where the data is to be set. - * @param [in] index Model index identifying the item that's data is to be set. + * @param [in] editor Pointer to the editor where the data is to be set. + * @param [in] index Model index identifying the item that's data is to be set. */ virtual void setEditorData(QWidget* editor, QModelIndex const& index) const; /*! * Save the data from the editor to the model. * - * @param [in] editor Pointer to the editor that contains the data to store. - * @param [in] model Model that contains the data structure where data is to be saved to. - * @param [in] index Model index identifying the item that's data is to be saved. + * @param [in] editor Pointer to the editor that contains the data to store. + * @param [in] model Model that contains the data structure where data is to be saved to. + * @param [in] index Model index identifying the item that's data is to be saved. */ virtual void setModelData(QWidget* editor, QAbstractItemModel* model, QModelIndex const& index) const; @@ -93,23 +93,23 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * Change the status of the indexed item. * - * @param [in] index Index of the selected item. - * @param [in] isEditable New status of the indexed item. + * @param [in] index Index of the selected item. + * @param [in] isEditable New status of the indexed item. */ void changeItemEditableStatus(QModelIndex const& index, bool isEditable) const; /*! * Check if the selected path is located in a new library location. * - * @param [in] newPath The selected path. + * @param [in] newPath The selected path. */ void checkForNewLibraryLocation(QString const& newPath) const; /*! * Change the tooltip of the indexed item. * - * @param [in] index The index of the selected item. - * @param [in] newText The new tooltip. + * @param [in] index The index of the selected item. + * @param [in] newText The new tooltip. */ void changeIndexItemTooltip(QModelIndex const& index, QString const& newText) const; @@ -118,26 +118,26 @@ class ImportInstancesDelegate : public QStyledItemDelegate /*! * Create the selection widget for VLNVs. * - * @param [in] selectionIndex Index of the item selector. - * @param [in] parent Parent item of the editor. + * @param [in] selectionIndex Index of the item selector. + * @param [in] parent Parent item of the editor. * - * @return Combobox for VLNVs. + * @return Combobox for VLNVs. */ QComboBox* createVLNVSelector(QModelIndex const& selectionIndex, QWidget* parent) const; /*! * Set a new XML path for the selected VLNV. * - * @param [in] vlnvIndex Index of the VLNV. - * @param [in] newVLNVText The VLNV in string. - * @param [in] model Model containing the data. + * @param [in] vlnvIndex Index of the VLNV. + * @param [in] newVLNVText The VLNV in string. + * @param [in] model Model containing the data. */ void setNewXMLPath(QModelIndex const& vlnvIndex, QString const& newVLNVText, QAbstractItemModel* model) const; /*! * Get the name of the instanced module. * - * @param [in] instanceName Name of the selected component instance. + * @param [in] instanceName Name of the selected component instance. */ QString getModuleNameForInstance(QString const& instanceName) const; diff --git a/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesEditor.h b/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesEditor.h index a75cba53f..4503abfaf 100644 --- a/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesEditor.h +++ b/wizards/ImportWizard/ImportInstancesEditor/ImportInstancesEditor.h @@ -38,9 +38,9 @@ class ImportInstancesEditor : public QTableWidget /*! * The constructor. * - * @param [in] workingComponent The importedComponent. - * @param [in] libraryAccess The instance which manages the library. - * @param [in] parent The owner of this widget. + * @param [in] workingComponent The importedComponent. + * @param [in] libraryAccess The instance which manages the library. + * @param [in] parent The owner of this widget. */ ImportInstancesEditor(QSharedPointer workingComponent, LibraryInterface* libraryAccess, QWidget* parent); @@ -53,7 +53,7 @@ class ImportInstancesEditor : public QTableWidget /*! * Setup the imported component instances. * - * @param [in] newInstances The new imported instances. + * @param [in] newInstances The new imported instances. */ void setupInstances(QVector const& newInstances); @@ -66,23 +66,23 @@ public slots: /*! * Change the status of the indexed item. * - * @param [in] index Index of the selected item. - * @param [in] isEditable New status for the selected item. + * @param [in] index Index of the selected item. + * @param [in] isEditable New status for the selected item. */ void changeItemEditableStatus(QModelIndex const& index, bool isEditable); /*! * Check if the selected path is in a new library location. * - * @param [in] newPath The selected path. + * @param [in] newPath The selected path. */ void onCheckForNewLibraryLocation(QString const& newPath); /*! * Handle the tooltip change in the selected item. * - * @param [in] index Index of the selected item. - * @param [in] newText New text for the selected item. + * @param [in] index Index of the selected item. + * @param [in] newText New text for the selected item. */ void onChangeIndexItemTooltip(QModelIndex const& index, QString const& newText); @@ -91,7 +91,7 @@ public slots: /*! * The context menu handler. * - * @param [in] event The context menu event. + * @param [in] event The context menu event. */ virtual void contextMenuEvent(QContextMenuEvent* event); @@ -112,69 +112,69 @@ private slots: /*! * Create a table item for the instance name. * - * @param [in] instanceName Name of the instance. - * @param [in] instanceRow Row of the instance. + * @param [in] instanceName Name of the instance. + * @param [in] instanceRow Row of the instance. */ void createInstanceNameItem(QString const& instanceName, int const& instanceRow); /*! * Create table items for the import files of the instances. * - * @param [in] instances List of imported instances. + * @param [in] instances List of imported instances. */ void createInstancePathItems(QVector const& instances); /*! * Get the possible file paths for the imported instances. * - * @param [in] instances List of imported instances. + * @param [in] instances List of imported instances. * - * @return List of instance name file path pairs. + * @return List of instance name file path pairs. */ QMultiMap getPossibleFilePaths(QVector const& instances) const; /*! * Get the importable files of the selected component. * - * @param [in] component The selected component. + * @param [in] component The selected component. * - * @return List importable component files. + * @return List importable component files. */ QVector > getCompatibleComponentFiles(QSharedPointer component) const; /*! * Read the selected file. * - * @param [in] relativePath Relative path of the selected file. - * @param [in] basePath File path to the containing component. + * @param [in] relativePath Relative path of the selected file. + * @param [in] basePath File path to the containing component. * - * @return The contents of the selected file. + * @return The contents of the selected file. */ QString readInputFile(QString const& relativePath, QString const& basePath) const; /*! * Check if the selected file is a verilog file. * - * @param [in] file The selected file. + * @param [in] file The selected file. * - * @return True, if the selected file is verilog, false otherwise. + * @return True, if the selected file is verilog, false otherwise. */ bool fileIsVerilogFile(QSharedPointer file) const; /*! * Create VLNV items for the selected component instances. * - * @param [in] instances List of the selected component instances. + * @param [in] instances List of the selected component instances. */ void createInstanceVLNVItems(QVector const& instances); /*! * Check if the selected instance data matches ports of the selected component. * - * @param [in] instance The selected instance data. - * @param [in] component The compared component. + * @param [in] instance The selected instance data. + * @param [in] component The compared component. * - * @return True, if the instance data matches component ports, false otherwise. + * @return True, if the instance data matches component ports, false otherwise. */ bool instanceDataMatchesComponentPorts(InstanceData::instanceData const& instance, QSharedPointer component) const; @@ -182,39 +182,39 @@ private slots: /*! * Get the component from the selected VLNV. * - * @param [in] componentVLNV The selected VLNV. + * @param [in] componentVLNV The selected VLNV. * - * @return Component matching the selected VLNV. + * @return Component matching the selected VLNV. */ QSharedPointer getComponentFromVLNV(VLNV const& componentVLNV) const; /*! * Set the active library locations. * - * @param [in] settings The settings. + * @param [in] settings The settings. */ void setActiveLibraryLocations(QSettings const& settings); /*! * Check if the selected path exists in the active libraries. * - * @param [in] path The selected path. + * @param [in] path The selected path. * - * @return True, if the path exists in the active libraries, false otherwise. + * @return True, if the path exists in the active libraries, false otherwise. */ bool pathExistsInActiveLibraries(QString const& path) const; /*! * Get the path of the currently selected item. * - * @return The path of the currently selected item. + * @return The path of the currently selected item. */ QString getCurrentPath() const; /*! * Set a new path for the currently selected item. * - * @param [in] targetPath The new path. + * @param [in] targetPath The new path. */ void setTargetPath(QString const& targetPath); diff --git a/wizards/ImportWizard/ImportWizard.h b/wizards/ImportWizard/ImportWizard.h index ff333ed50..492cc60a8 100644 --- a/wizards/ImportWizard/ImportWizard.h +++ b/wizards/ImportWizard/ImportWizard.h @@ -33,9 +33,9 @@ class ImportWizard : public QWizard /*! * Constructor. * - * @param [in] component The component for which the wizard is run. - * @param [in] handler The library handle. - * @param [in] parent The parent widget. + * @param [in] component The component for which the wizard is run. + * @param [in] handler The library handle. + * @param [in] parent The parent widget. */ ImportWizard(QSharedPointer component, LibraryInterface* handler, QWidget* parent); @@ -54,7 +54,7 @@ private slots: /*! * Called when a new component has been imported. * - * @param [in] component The newly imported component. + * @param [in] component The newly imported component. */ virtual void onComponentChanged(QSharedPointer component); diff --git a/wizards/ImportWizard/ImportWizardImportPage.h b/wizards/ImportWizard/ImportWizardImportPage.h index 85cb8933d..e23041cc5 100644 --- a/wizards/ImportWizard/ImportWizardImportPage.h +++ b/wizards/ImportWizard/ImportWizardImportPage.h @@ -35,12 +35,12 @@ class ImportWizardImportPage : public ComponentWizardImportPage /*! * The Constructor. * - * @param [in] component Pointer to the component to import to. - * @param [in] handler The library handle. - * @param [in] parameterFinder The parameter finder. - * @param [in] expressionFormatter The expression formatter. - * @param [in] busInterface Interface for accessing bus interfaces. - * @param [in] parent The parent wizard. + * @param [in] component Pointer to the component to import to. + * @param [in] handler The library handle. + * @param [in] parameterFinder The parameter finder. + * @param [in] expressionFormatter The expression formatter. + * @param [in] busInterface Interface for accessing bus interfaces. + * @param [in] parent The parent wizard. */ ImportWizardImportPage(QSharedPointer component, LibraryInterface* handler, diff --git a/wizards/ImportWizard/ImportWizardInstancesPage.h b/wizards/ImportWizard/ImportWizardInstancesPage.h index 9aae88203..9cc69d863 100644 --- a/wizards/ImportWizard/ImportWizardInstancesPage.h +++ b/wizards/ImportWizard/ImportWizardInstancesPage.h @@ -29,9 +29,9 @@ class ImportWizardInstancesPage : public QWizardPage /*! * The Constructor. * - * @param [in] workingComponent Pointer to the component to import to. - * @param [in] libraryAccess The library handle. - * @param [in] parent The parent wizard. + * @param [in] workingComponent Pointer to the component to import to. + * @param [in] libraryAccess The library handle. + * @param [in] parent The parent wizard. */ ImportWizardInstancesPage(QSharedPointer workingComponent, LibraryInterface* libraryAccess, QWidget* parent); diff --git a/wizards/ImportWizard/ImportWizardIntroPage.h b/wizards/ImportWizard/ImportWizardIntroPage.h index 68bc8069e..e6000d41e 100644 --- a/wizards/ImportWizard/ImportWizardIntroPage.h +++ b/wizards/ImportWizard/ImportWizardIntroPage.h @@ -24,7 +24,7 @@ class ImportWizardIntroPage : public QWizardPage /*! * Constructor. * - * @param [in] parent The parent widget. + * @param [in] parent The parent widget. */ ImportWizardIntroPage(QWidget* parent); diff --git a/wizards/common/ComponentComparator/ComponentComparator.h b/wizards/common/ComponentComparator/ComponentComparator.h index e64cf1edf..81048301b 100644 --- a/wizards/common/ComponentComparator/ComponentComparator.h +++ b/wizards/common/ComponentComparator/ComponentComparator.h @@ -38,20 +38,20 @@ class ComponentComparator : public IPXactElementComparator /*! * Compares the sub-elements of two components. * - * @param [in] first The first components. - * @param [in] second The second components. + * @param [in] first The first components. + * @param [in] second The second components. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ bool compareFields(QSharedPointer first, QSharedPointer second) const; /*! * Finds the differences between the two given components. * - * @param [in] reference The component to compare to. - * @param [in] subject The component to compare against the reference. + * @param [in] reference The component to compare to. + * @param [in] subject The component to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QSharedPointer reference, QSharedPointer subject) const; @@ -59,10 +59,10 @@ class ComponentComparator : public IPXactElementComparator /*! * Finds the differences between the sub-elements of two given elements. * - * @param [in] reference The reference element to compare to. - * @param [in] subject The element to compare against the reference. + * @param [in] reference The reference element to compare to. + * @param [in] subject The element to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -70,7 +70,7 @@ class ComponentComparator : public IPXactElementComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; @@ -83,10 +83,10 @@ class ComponentComparator : public IPXactElementComparator /*! * Compares the VLNVs in the given components. * - * @param [in] referenceComponent The reference component to compare to. - * @param [in] subjectComponent The subject component to compare against the reference. + * @param [in] referenceComponent The reference component to compare to. + * @param [in] subjectComponent The subject component to compare against the reference. * - * @return True, if the VLVNs are similar, otherwise false. + * @return True, if the VLVNs are similar, otherwise false. */ bool compareVLNVs(QSharedPointer referenceComponent, QSharedPointer subjectComponent) const; @@ -94,10 +94,10 @@ class ComponentComparator : public IPXactElementComparator /*! * Compares the parameters in the given components. * - * @param [in] referenceComponent The reference component to compare to. - * @param [in] subjectComponent The subject component to compare against the reference. + * @param [in] referenceComponent The reference component to compare to. + * @param [in] subjectComponent The subject component to compare against the reference. * - * @return True, if the parameters are similar, otherwise false. + * @return True, if the parameters are similar, otherwise false. */ bool compareParameters(QSharedPointer referenceComponent, QSharedPointer subjectComponent) const; @@ -105,20 +105,20 @@ class ComponentComparator : public IPXactElementComparator /*! * Compares the ports in the given components. * - * @param [in] referenceComponent The reference component to compare to. - * @param [in] subjectComponent The subject component to compare against the reference. + * @param [in] referenceComponent The reference component to compare to. + * @param [in] subjectComponent The subject component to compare against the reference. * - * @return True, if the ports are similar, otherwise false. + * @return True, if the ports are similar, otherwise false. */ bool comparePorts(QSharedPointer first, QSharedPointersecond) const; /*! * Compares the views in the given components. * - * @param [in] referenceComponent The reference component to compare to. - * @param [in] subjectComponent The subject component to compare against the reference. + * @param [in] referenceComponent The reference component to compare to. + * @param [in] subjectComponent The subject component to compare against the reference. * - * @return True, if the views are similar, otherwise false. + * @return True, if the views are similar, otherwise false. */ bool compareViews(QSharedPointer first, QSharedPointer second) const; }; diff --git a/wizards/common/ComponentDiffWidget/ComponentDiffWidget.h b/wizards/common/ComponentDiffWidget/ComponentDiffWidget.h index caf1a4b60..26c9b1829 100644 --- a/wizards/common/ComponentDiffWidget/ComponentDiffWidget.h +++ b/wizards/common/ComponentDiffWidget/ComponentDiffWidget.h @@ -41,8 +41,8 @@ class ComponentDiffWidget : public QTreeWidget /*! * The constructor. * - * @param [in] expressionFormatter Pointer to the expression formatter. - * @param [in] parent Pointer to the parent item. + * @param [in] expressionFormatter Pointer to the expression formatter. + * @param [in] parent Pointer to the parent item. */ ComponentDiffWidget(QSharedPointer expressionFormatter, QWidget *parent); @@ -52,8 +52,8 @@ class ComponentDiffWidget : public QTreeWidget /*! * Sets the components to diff in the view. * - * @param [in] reference The reference component to compare to. - * @param [in] subject The component to compare against the reference. + * @param [in] reference The reference component to compare to. + * @param [in] subject The component to compare against the reference. */ void setComponents(QSharedPointer reference, QSharedPointer subject); @@ -67,60 +67,60 @@ class ComponentDiffWidget : public QTreeWidget /*! * Checks if a list of diffs shows no change. * - * @param [in] diffs The list to check. + * @param [in] diffs The list to check. * - * @return True, if nothing has changed, otherwise false. + * @return True, if nothing has changed, otherwise false. */ bool nothingChanged(QList > const& diffs); /*! * Creates the top level items in the tree. * - * @param [in] diffs The diffs to display in the tree. + * @param [in] diffs The diffs to display in the tree. * - * @return Top level items indexed by their element type. + * @return Top level items indexed by their element type. */ QMap createTopLevelItems(QList > const& diffs); /*! * Creates a top level item for a given element. * - * @param [in] elementName The name of the element. + * @param [in] elementName The name of the element. * - * @return The created item. + * @return The created item. */ QTreeWidgetItem* createTopLevelItemForElement(QString const& elementName); /*! * Adds an item to the tree indicating an added element. * - * @param [in] name The name of the added element. - * @param [in] parent The parent item. + * @param [in] name The name of the added element. + * @param [in] parent The parent item. */ void addAddItem(QString const& name, QTreeWidgetItem* parent); /*! * Adds an item to the tree indicating a removed element. * - * @param [in] name The name of the removed element. - * @param [in] parent The parent item. + * @param [in] name The name of the removed element. + * @param [in] parent The parent item. */ void addRemoveItem(QString const& name, QTreeWidgetItem* parent); /*! * Adds an item to the tree indicating a modified element. * - * @param [in] name The name of the modified element. - * @param [in] parent The parent item. + * @param [in] name The name of the modified element. + * @param [in] parent The parent item. */ void addModificationItem(QSharedPointer diff, QTreeWidgetItem* parent); /*! * Adds an item to the tree indicating an modified element with a single modified sub-element. * - * @param [in] name The name of the modified element. - * @param [in] modification The modification to the element. - * @param [in] parent The parent item. + * @param [in] name The name of the modified element. + * @param [in] modification The modification to the element. + * @param [in] parent The parent item. */ void addSingleLevelModificationItem(QString const& name, IPXactDiff::Modification const& modification, QTreeWidgetItem* parent); @@ -128,11 +128,11 @@ class ComponentDiffWidget : public QTreeWidget /*! * Creates an item to indicate a modified sub-element. * - * @param [in] modification The modification to the element. - * @param [in] parent The parent item. + * @param [in] modification The modification to the element. + * @param [in] parent The parent item. * - * @return Item for a modified sub-element. + * @return Item for a modified sub-element. */ QTreeWidgetItem* createModificationItem(IPXactDiff::Modification const& modification, QTreeWidgetItem* parent = 0) const; @@ -140,9 +140,9 @@ class ComponentDiffWidget : public QTreeWidget /*! * Adds an item to the tree indicating an modified element with multiple modified sub-elements. * - * @param [in] name The name of the modified element. - * @param [in] changelist The modifications to the element. - * @param [in] parent The parent item. + * @param [in] name The name of the modified element. + * @param [in] changelist The modifications to the element. + * @param [in] parent The parent item. */ void addMultiLevelModificationItem(QString const& name, QList changelist, QTreeWidgetItem* parent); diff --git a/wizards/common/IPXactDiff.h b/wizards/common/IPXactDiff.h index df1d994f0..a910bdc5d 100644 --- a/wizards/common/IPXactDiff.h +++ b/wizards/common/IPXactDiff.h @@ -47,8 +47,8 @@ class IPXactDiff /*! * The constructor. * - * @param [in] element The identifier for the IP-XACT element. - * @param [in] name The name of the element. + * @param [in] element The identifier for the IP-XACT element. + * @param [in] name The name of the element. */ IPXactDiff(QString const& element, QString const& name = ""); @@ -58,44 +58,44 @@ class IPXactDiff /*! * Returns the identifier for the element. * - * @return The identifier for the element. + * @return The identifier for the element. */ QString element() const; /*! * Returns the name of the element. * - * @return The name of the element. + * @return The name of the element. */ QString name() const; /*! * Returns the change type. * - * @return The change type. + * @return The change type. */ IPXactDiff::DiffType changeType() const; /*! * Sets the change type. * - * @param [in] type The type to set. + * @param [in] type The type to set. */ void setChangeType(DiffType type); /*! * Gets the modifications in the contained elements. * - * @return The modifications to contained elements. + * @return The modifications to contained elements. */ QList getChangeList() const; /*! * Checks if the given element has changed. If the element has changed, stores the modification. * - * @param [in] element The name of the contained element. - * @param [in] referenceValue The value in the reference element. - * @param [in] subjectValue The value in the subject element. + * @param [in] element The name of the contained element. + * @param [in] referenceValue The value in the reference element. + * @param [in] subjectValue The value in the subject element. */ void checkForChange(QString const& element, QString const& referenceValue, QString const& subjectValue); diff --git a/wizards/common/IPXactElementComparator.h b/wizards/common/IPXactElementComparator.h index 6fbed3c2b..d6f9a895a 100644 --- a/wizards/common/IPXactElementComparator.h +++ b/wizards/common/IPXactElementComparator.h @@ -29,30 +29,30 @@ class IPXactElementComparator /*! * Compares the two elements. * - * @param [in] first The first element. - * @param [in] second The second element. + * @param [in] first The first element. + * @param [in] second The second element. * - * @return True, if the elements are similar, otherwise false. + * @return True, if the elements are similar, otherwise false. */ virtual bool compare(QSharedPointer first, QSharedPointer second) const; /*! * Compares the sub-elements of two elements. * - * @param [in] first The first elements. - * @param [in] second The second elements. + * @param [in] first The first elements. + * @param [in] second The second elements. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ virtual bool compareFields(QSharedPointer first, QSharedPointer second) const = 0; /*! * Finds the differences between the two given elements. * - * @param [in] reference The reference element to compare to. - * @param [in] subject The element to compare against the reference. + * @param [in] reference The reference element to compare to. + * @param [in] subject The element to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QSharedPointer reference, QSharedPointer subject) const; @@ -60,10 +60,10 @@ class IPXactElementComparator /*! * Finds the differences between the sub-elements of two given elements. * - * @param [in] reference The reference element to compare to. - * @param [in] subject The element to compare against the reference. + * @param [in] reference The reference element to compare to. + * @param [in] subject The element to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ virtual QList > diffFields(QSharedPointer first, QSharedPointer second) const = 0; @@ -71,7 +71,7 @@ class IPXactElementComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const = 0; @@ -80,21 +80,21 @@ class IPXactElementComparator /*! * Creates a diff result for an added element. * - * @return Diff result for added element. + * @return Diff result for added element. */ virtual QList > addDiff() const; /*! * Creates a diff result for a removed element. * - * @return Diff result for removed element. + * @return Diff result for removed element. */ virtual QList > removeDiff() const; /*! * Creates a diff result for an unchanged element. * - * @return Diff result for unchanged element. + * @return Diff result for unchanged element. */ virtual QList > noChangeDiff() const; }; diff --git a/wizards/common/ListComparator.h b/wizards/common/ListComparator.h index d3e10d24e..ff0cf1370 100644 --- a/wizards/common/ListComparator.h +++ b/wizards/common/ListComparator.h @@ -33,20 +33,20 @@ class ListComparator : public IPXactElementComparator /*! * Compares the two lists of elements. * - * @param [in] first The first lists. - * @param [in] second The second lists. + * @param [in] first The first lists. + * @param [in] second The second lists. * - * @return True, if the lists are similar, otherwise false. + * @return True, if the lists are similar, otherwise false. */ virtual bool compare(QList > const first, QList > const second) const; /*! * Finds the differences between the two given lists. * - * @param [in] references The reference lists to compare to. - * @param [in] subjects The lists to compare against the reference. + * @param [in] references The reference lists to compare to. + * @param [in] subjects The lists to compare against the reference. * - * @return Set of differences between the references and subjects. + * @return Set of differences between the references and subjects. */ virtual QList > diff(QList > const references, QList > const subjects) const; @@ -54,7 +54,7 @@ class ListComparator : public IPXactElementComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const = 0; @@ -63,9 +63,9 @@ class ListComparator : public IPXactElementComparator /*! * Creates a map of elements where the name of the element is the key. * - * @param [in] list The elements to include in the map. + * @param [in] list The elements to include in the map. * - * @return Map of elements. + * @return Map of elements. */ virtual QMap > mapByName(QList > const list) const; diff --git a/wizards/common/ModuleParameterComparator/ModuleParameterComparator.h b/wizards/common/ModuleParameterComparator/ModuleParameterComparator.h index 292b07e74..6a316a983 100644 --- a/wizards/common/ModuleParameterComparator/ModuleParameterComparator.h +++ b/wizards/common/ModuleParameterComparator/ModuleParameterComparator.h @@ -34,20 +34,20 @@ class ModuleParameterComparator : public ListComparator /*! * Finds the differences between the two given module parameters. * - * @param [in] reference The reference module parameter to compare to. - * @param [in] subject The module parameter to compare against the reference. + * @param [in] reference The reference module parameter to compare to. + * @param [in] subject The module parameter to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual bool compare(QSharedPointer first, QSharedPointer second) const; /*! * Compares the sub-elements of two module parameters. * - * @param [in] first The first module parameters. - * @param [in] second The second module parameters. + * @param [in] first The first module parameters. + * @param [in] second The second module parameters. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ virtual bool compareFields(QSharedPointer first, QSharedPointer second) const; @@ -55,10 +55,10 @@ class ModuleParameterComparator : public ListComparator /*! * Compares the two lists of module parameters. * - * @param [in] first The first lists. - * @param [in] second The second lists. + * @param [in] first The first lists. + * @param [in] second The second lists. * - * @return True, if the lists are similar, otherwise false. + * @return True, if the lists are similar, otherwise false. */ bool compare(QList > const first, QList > const second) ; @@ -66,10 +66,10 @@ class ModuleParameterComparator : public ListComparator /*! * Finds the differences between the sub-elements of two given module parameters. * - * @param [in] reference The reference module parameter to compare to. - * @param [in] subject The module parameter to compare against the reference. + * @param [in] reference The reference module parameter to compare to. + * @param [in] subject The module parameter to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ virtual QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -77,7 +77,7 @@ class ModuleParameterComparator : public ListComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; diff --git a/wizards/common/ParameterComparator/ParameterComparator.h b/wizards/common/ParameterComparator/ParameterComparator.h index 41c93d053..b2a6087a0 100644 --- a/wizards/common/ParameterComparator/ParameterComparator.h +++ b/wizards/common/ParameterComparator/ParameterComparator.h @@ -35,20 +35,20 @@ class ParameterComparator : public ListComparator /*! * Finds the differences between the two given model parameters. * - * @param [in] reference The reference model parameter to compare to. - * @param [in] subject The model parameters to compare against the reference. + * @param [in] reference The reference model parameter to compare to. + * @param [in] subject The model parameters to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual bool compare(QSharedPointer first, QSharedPointer second) const; /*! * Compares the sub-elements of two model parameters. * - * @param [in] first The first model parameters. - * @param [in] second The second model parameters. + * @param [in] first The first model parameters. + * @param [in] second The second model parameters. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ virtual bool compareFields(QSharedPointer first, QSharedPointer second) const; @@ -56,20 +56,20 @@ class ParameterComparator : public ListComparator /*! * Compares the two lists of model parameters. * - * @param [in] first The first lists. - * @param [in] second The second lists. + * @param [in] first The first lists. + * @param [in] second The second lists. * - * @return True, if the lists are similar, otherwise false. + * @return True, if the lists are similar, otherwise false. */ bool compare(QList > const first, QList > const second); /*! * Finds the differences between the sub-elements of two given model parameters. * - * @param [in] reference The reference model parameter to compare to. - * @param [in] subject The model parameter to compare against the reference. + * @param [in] reference The reference model parameter to compare to. + * @param [in] subject The model parameter to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ virtual QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -77,7 +77,7 @@ class ParameterComparator : public ListComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; diff --git a/wizards/common/PortComparator/PortComparator.h b/wizards/common/PortComparator/PortComparator.h index 846b54de2..9e797dcc3 100644 --- a/wizards/common/PortComparator/PortComparator.h +++ b/wizards/common/PortComparator/PortComparator.h @@ -34,40 +34,40 @@ class PortComparator : public ListComparator /*! * Compares the two ports. * - * @param [in] first The first port. - * @param [in] second The second port. + * @param [in] first The first port. + * @param [in] second The second port. * - * @return True, if the ports are similar, otherwise false. + * @return True, if the ports are similar, otherwise false. */ virtual bool compare(QSharedPointer first, QSharedPointer second) const; /*! * Compares the sub-elements of two ports. * - * @param [in] first The first port. - * @param [in] second The second port. + * @param [in] first The first port. + * @param [in] second The second port. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ bool compareFields(QSharedPointer first, QSharedPointer second) const; /*! * Compares the two lists of ports. * - * @param [in] first The first list. - * @param [in] second The second list. + * @param [in] first The first list. + * @param [in] second The second list. * - * @return True, if the lists are similar, otherwise false. + * @return True, if the lists are similar, otherwise false. */ virtual bool compare(QList > const first, QList > const second) const; /*! * Finds the differences between the two ports. * - * @param [in] reference The port to compare to. - * @param [in] subject The port to compare against the reference. + * @param [in] reference The port to compare to. + * @param [in] subject The port to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QSharedPointer reference, QSharedPointer subject) const; @@ -75,10 +75,10 @@ class PortComparator : public ListComparator /*! * Finds the differences between the sub-elements of two given ports. * - * @param [in] reference The reference port to compare to. - * @param [in] subject The port to compare against the reference. + * @param [in] reference The reference port to compare to. + * @param [in] subject The port to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ virtual QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -86,10 +86,10 @@ class PortComparator : public ListComparator /*! * Finds the differences between the two given lists. * - * @param [in] reference The reference lists to compare to. - * @param [in] subject The lists to compare against the reference. + * @param [in] reference The reference lists to compare to. + * @param [in] subject The lists to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QList > const reference, QList > const subject) const; @@ -97,7 +97,7 @@ class PortComparator : public ListComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; diff --git a/wizards/common/VLNVComparator/VLNVComparator.h b/wizards/common/VLNVComparator/VLNVComparator.h index 252cd7bb8..1febe32a4 100644 --- a/wizards/common/VLNVComparator/VLNVComparator.h +++ b/wizards/common/VLNVComparator/VLNVComparator.h @@ -34,20 +34,20 @@ class VLNVComparator : public IPXactElementComparator /*! * Compares the two VLNV elements. * - * @param [in] first The first VLNV. - * @param [in] second The second VLNV. + * @param [in] first The first VLNV. + * @param [in] second The second VLNV. * - * @return True, if the VLNVs are similar, otherwise false. + * @return True, if the VLNVs are similar, otherwise false. */ virtual bool compareFields(QSharedPointer first, QSharedPointer second) const; /*! * Finds the differences between the two given VLNVs. * - * @param [in] reference The VLNVs to compare to. - * @param [in] subject The VLNVs to compare against the reference. + * @param [in] reference The VLNVs to compare to. + * @param [in] subject The VLNVs to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -55,7 +55,7 @@ class VLNVComparator : public IPXactElementComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; diff --git a/wizards/common/ViewComparator/ViewComparator.h b/wizards/common/ViewComparator/ViewComparator.h index c7ebff559..30d915de1 100644 --- a/wizards/common/ViewComparator/ViewComparator.h +++ b/wizards/common/ViewComparator/ViewComparator.h @@ -33,40 +33,40 @@ class ViewComparator : public ListComparator /*! * Compares the two views. * - * @param [in] first The first view. - * @param [in] second The second view. + * @param [in] first The first view. + * @param [in] second The second view. * - * @return True, if the ports are similar, otherwise false. + * @return True, if the ports are similar, otherwise false. */ virtual bool compare(QSharedPointer first, QSharedPointer second) const; /*! * Compares the sub-elements of two views. * - * @param [in] first The first view. - * @param [in] second The second view. + * @param [in] first The first view. + * @param [in] second The second view. * - * @return True, if the sub-elements are similar, otherwise false. + * @return True, if the sub-elements are similar, otherwise false. */ bool compareFields(QSharedPointer first, QSharedPointer second) const; /*! * Compares the two lists of views. * - * @param [in] first The first lists. - * @param [in] second The second lists. + * @param [in] first The first lists. + * @param [in] second The second lists. * - * @return True, if the lists are similar, otherwise false. + * @return True, if the lists are similar, otherwise false. */ virtual bool compare(QList > const first, QList > const second) const; /*! * Finds the differences between two views. * - * @param [in] reference The view to compare to. - * @param [in] subject The view to compare against the reference. + * @param [in] reference The view to compare to. + * @param [in] subject The view to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QSharedPointer reference, QSharedPointer subject) const; @@ -74,10 +74,10 @@ class ViewComparator : public ListComparator /*! * Finds the differences between the sub-elements of two given views. * - * @param [in] reference The reference view to compare to. - * @param [in] subject The view to compare against the reference. + * @param [in] reference The reference view to compare to. + * @param [in] subject The view to compare against the reference. * - * @return Set of differences between the sub-elements of reference and subject. + * @return Set of differences between the sub-elements of reference and subject. */ virtual QList > diffFields(QSharedPointer reference, QSharedPointer subject) const; @@ -85,10 +85,10 @@ class ViewComparator : public ListComparator /*! * Finds the differences between the two given lists. * - * @param [in] reference The reference lists to compare to. - * @param [in] subject The lists to compare against the reference. + * @param [in] reference The reference lists to compare to. + * @param [in] subject The lists to compare against the reference. * - * @return Set of differences between the reference and subject. + * @return Set of differences between the reference and subject. */ virtual QList > diff(QList > const reference, QList > const subject) const; @@ -96,7 +96,7 @@ class ViewComparator : public ListComparator /*! * Returns the type for the element. * - * @return The element type. + * @return The element type. */ virtual QString elementType() const; @@ -105,10 +105,10 @@ class ViewComparator : public ListComparator /*! * Compares two string lists. * - * @param [in] first The first list. - * @param [in] second The second list. + * @param [in] first The first list. + * @param [in] second The second list. * - * @return True, if the lists contain the same strings in any order, otherwise false. + * @return True, if the lists contain the same strings in any order, otherwise false. */ bool compareLists(QSharedPointer > > first, QSharedPointer > > second) const; @@ -116,9 +116,9 @@ class ViewComparator : public ListComparator /*! * Gets the type for a given view. * - * @param [in] view The view whose type to get. + * @param [in] view The view whose type to get. * - * @return The type (hierarchical/non-hierarchical) of the view. + * @return The type (hierarchical/non-hierarchical) of the view. */ QString viewHierarchyType(QSharedPointer view) const; };