mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2026-02-01 17:19:59 +01:00
Fix some doxygen issues (~100)
This commit is contained in:
@@ -174,7 +174,7 @@ namespace autonum
|
||||
|
||||
/**
|
||||
@brief AssignVariables::formulaToLabel
|
||||
Return the @formula with variable assigned
|
||||
Return the formula with variable assigned
|
||||
(ready to be displayed)
|
||||
@param formula - the formula to work
|
||||
@param seqStruct - struct where is stocked int values
|
||||
@@ -199,7 +199,7 @@ namespace autonum
|
||||
|
||||
/**
|
||||
@brief AssignVariables::replaceVariable
|
||||
Replace the variables in @formula in form %{my-var}
|
||||
Replace the variables in formula in form %{my-var}
|
||||
to the corresponding value stored in dc
|
||||
@param formula
|
||||
@param dc
|
||||
@@ -354,7 +354,7 @@ namespace autonum
|
||||
|
||||
/**
|
||||
@brief setSequentialToList
|
||||
Append all sequential of type @type owned by @context in list
|
||||
Append all sequential of type type owned by context in list
|
||||
@param list : list to have value inserted
|
||||
@param context : numerotation context to retrieve value
|
||||
@param type : type of sequential
|
||||
@@ -379,7 +379,7 @@ namespace autonum
|
||||
|
||||
/**
|
||||
@brief setFolioSequentialToHash
|
||||
Insert all value of @list in @hash with key @autoNumName
|
||||
Insert all value of list in hash with key autoNumName
|
||||
@param list : list to get values from
|
||||
@param hash : hash to have values inserted
|
||||
@param autoNumName : name to use as key of hash
|
||||
@@ -542,7 +542,7 @@ namespace autonum
|
||||
@param location
|
||||
@return the prefix for an element represented by location,
|
||||
prefix can be null.
|
||||
Search for a prefix only if @location represent
|
||||
Search for a prefix only if location represent
|
||||
an element embedded in a project
|
||||
*/
|
||||
QString elementPrefixForLocation(const ElementsLocation &location)
|
||||
|
||||
@@ -59,7 +59,8 @@ bool NumerotationContext::addValue(const QString &type, const QVariant &value, c
|
||||
|
||||
/**
|
||||
@brief NumerotationContext::operator []
|
||||
@return the string at position @i
|
||||
@param i
|
||||
@return the string at position i
|
||||
*/
|
||||
QString NumerotationContext::operator [] (const int &i) const {
|
||||
return (content_.at(i));
|
||||
@@ -90,7 +91,8 @@ bool NumerotationContext::isEmpty() const {
|
||||
}
|
||||
/**
|
||||
@brief NumerotationContext::itemAt
|
||||
@return the content at position @i 1:type 2:value 3:increase
|
||||
@param i
|
||||
@return the content at position i 1:type 2:value 3:increase
|
||||
*/
|
||||
QStringList NumerotationContext::itemAt(const int i) const {
|
||||
return (content_.at(i).split("|"));
|
||||
@@ -114,7 +116,7 @@ QString NumerotationContext::validRegExpNumber() const {
|
||||
|
||||
/**
|
||||
@brief NumerotationContext::keyIsAcceptable
|
||||
@return true if @type is acceptable
|
||||
@return true if type is acceptable
|
||||
*/
|
||||
bool NumerotationContext::keyIsAcceptable(const QString &type) const {
|
||||
return (type.contains(QRegExp(validRegExpNum())));
|
||||
@@ -122,7 +124,7 @@ bool NumerotationContext::keyIsAcceptable(const QString &type) const {
|
||||
|
||||
/**
|
||||
@brief NumerotationContext::keyIsNumber
|
||||
@return true if @type represent a number
|
||||
@return true if type represent a number
|
||||
*/
|
||||
bool NumerotationContext::keyIsNumber(const QString &type) const {
|
||||
return (type.contains(QRegExp(validRegExpNumber())));
|
||||
@@ -130,7 +132,7 @@ bool NumerotationContext::keyIsNumber(const QString &type) const {
|
||||
|
||||
/**
|
||||
@brief NumerotationContext::toXml
|
||||
Save the numerotation context in a QDomElement under the element name @str
|
||||
Save the numerotation context in a QDomElement under the element name str
|
||||
*/
|
||||
QDomElement NumerotationContext::toXml(QDomDocument &d, const QString& str) {
|
||||
QDomElement num_auto = d.createElement(str);
|
||||
@@ -152,7 +154,7 @@ QDomElement NumerotationContext::toXml(QDomDocument &d, const QString& str) {
|
||||
|
||||
/**
|
||||
@brief NumerotationContext::fromXml
|
||||
load numerotation context from @e
|
||||
load numerotation context from e
|
||||
*/
|
||||
void NumerotationContext::fromXml(QDomElement &e) {
|
||||
clear();
|
||||
@@ -163,7 +165,7 @@ void NumerotationContext::fromXml(QDomElement &e) {
|
||||
@brief NumerotationContext::replaceValue
|
||||
This class replaces the current NC field value with content
|
||||
@param index of NC Item
|
||||
@param QString content to replace current value
|
||||
@param content to replace current value
|
||||
*/
|
||||
void NumerotationContext::replaceValue(int index, QString content) {
|
||||
QString sep = "|";
|
||||
|
||||
@@ -84,7 +84,7 @@ QString NumerotationContextCommands::toRepresentedString() {
|
||||
|
||||
/**
|
||||
@brief NumerotationContextCommands::setNumStrategy
|
||||
apply the good strategy relative to @str
|
||||
apply the good strategy relative to str
|
||||
*/
|
||||
void NumerotationContextCommands::setNumStrategy(const QString &str) {
|
||||
if (strategy_) delete strategy_;
|
||||
@@ -159,7 +159,7 @@ NumStrategy::~NumStrategy() {}
|
||||
|
||||
/**
|
||||
@brief NumStrategy::nextString
|
||||
@return the next value of @nc at position @i
|
||||
@return the next value of nc at position i
|
||||
*/
|
||||
NumerotationContext NumStrategy::nextString (const NumerotationContext &nc, const int i) const {
|
||||
QStringList strl = nc.itemAt(i);
|
||||
@@ -182,7 +182,7 @@ NumerotationContext NumStrategy::nextNumber (const NumerotationContext &nc, cons
|
||||
|
||||
/**
|
||||
@brief NumStrategy::previousNumber
|
||||
@return the previous value of @nc at position @i
|
||||
@return the previous value of nc at position i
|
||||
*/
|
||||
NumerotationContext NumStrategy::previousNumber(const NumerotationContext &nc, const int i) const {
|
||||
QStringList strl = nc.itemAt(i);
|
||||
|
||||
@@ -182,14 +182,14 @@ void AutoNumberingManagementW::on_m_apply_project_rb_clicked() {
|
||||
|
||||
/**
|
||||
@brief AutoNumberingManagementW::on_buttonBox_clicked
|
||||
Action on @buttonBox clicked
|
||||
Action on buttonBox clicked
|
||||
@param button
|
||||
*/
|
||||
void AutoNumberingManagementW::on_buttonBox_clicked(QAbstractButton *button) {
|
||||
//transform button to int
|
||||
int answer = ui -> buttonBox -> buttonRole(button);
|
||||
switch (answer) {
|
||||
//apply the context in the diagram displayed by @diagram_chooser.
|
||||
//apply the context in the diagram displayed by diagram_chooser.
|
||||
case QDialogButtonBox::ApplyRole:
|
||||
applyEnable(false);
|
||||
emit applyPressed();
|
||||
|
||||
Reference in New Issue
Block a user