Commit bb2f9052 authored by Friedrich W. H. Kossebau's avatar Friedrich W. H. Kossebau
Browse files

API dox: move @cond/@endcond to doxygen comment style, to unconfuse doxygen

Doxygen currently does not generate documentation for e.g. Akonadi::Item,
as it seems to fail to properly parse the code (not sure exactly, might
be the template methods) and starts to misinterpret things.
Then all the conditional section markers are put into non-doxygen comments
so at least recent doxygen versions ignore them (given most markers have
been added around a decade ago perhaps earlier doxygen processed them).
But with doxygen getting confused while parsing, it seems to suddenly
handle some of the @cond and €endcond markers, but missing out the
matching start @cond or ending @endcond, and with that to fail even harder
to parse the rest.

Moving the markers into doxygen-processed comment style improves the
doxygen handling, and e.g. Akonadi::Item now gets documented.
parent 7870ade0
Pipeline #53001 passed with stage
in 12 minutes and 59 seconds
......@@ -306,7 +306,7 @@ void AgentBase::ObserverV4::itemsRelationsChanged(const Akonadi::Item::List &ite
}
}
//@cond PRIVATE
/// @cond PRIVATE
AgentBasePrivate::AgentBasePrivate(AgentBase *parent)
: q_ptr(parent)
......@@ -924,7 +924,7 @@ QString AgentBase::parseArguments(int argc, char **argv)
return identifier;
}
// @endcond
/// @endcond
int AgentBase::init(AgentBase &r)
{
......
......@@ -739,13 +739,13 @@ protected:
*/
void setTemporaryOffline(int makeOnlineInSeconds = 300);
//@cond PRIVATE
/// @cond PRIVATE
static void debugAgent(int argc, char **argv);
AgentBasePrivate *d_ptr;
explicit AgentBase(AgentBasePrivate *d, const QString &id);
friend class ObserverV2;
//@endcond
/// @endcond
/**
* This method is called whenever the @p online status has changed.
......@@ -757,7 +757,7 @@ protected:
virtual KAboutData aboutData() const;
private:
//@cond PRIVATE
/// @cond PRIVATE
static QString parseArguments(int argc, char **argv);
static int init(AgentBase &r);
void setOnlineInternal(bool state);
......@@ -781,7 +781,7 @@ private:
Q_PRIVATE_SLOT(d_func(), void slotResumedFromSuspend())
Q_PRIVATE_SLOT(d_func(), void slotTemporaryOfflineTimeout())
//@endcond
/// @endcond
};
}
......
......@@ -71,9 +71,9 @@ public:
void searchFinished(const QVector<QByteArray> &result);
private:
//@cond PRIVATE
/// @cond PRIVATE
AgentSearchInterfacePrivate *const d;
//@endcond
/// @endcond
};
}
......
......@@ -153,9 +153,9 @@ protected:
~PreprocessorBase() override;
private:
//@cond PRIVATE
/// @cond PRIVATE
Q_DECLARE_PRIVATE(PreprocessorBase)
//@endcond
/// @endcond
}; // class PreprocessorBase
......
......@@ -21,7 +21,7 @@ using namespace Akonadi;
qint64 ResourceScheduler::Task::latestSerial = 0;
static QDBusAbstractInterface *s_resourcetracker = nullptr;
//@cond PRIVATE
/// @cond PRIVATE
ResourceScheduler::ResourceScheduler(QObject *parent)
: QObject(parent)
......@@ -693,6 +693,6 @@ QDebug Akonadi::operator<<(QDebug d, const ResourceScheduler::Task &task)
return d;
}
//@endcond
/// @endcond
#include "moc_resourcescheduler_p.cpp"
......@@ -19,7 +19,7 @@ namespace Akonadi
{
class RecursiveMover;
//@cond PRIVATE
/// @cond PRIVATE
/**
@internal
......@@ -292,7 +292,7 @@ private:
QDebug operator<<(QDebug, const ResourceScheduler::Task &task);
QTextStream &operator<<(QTextStream &, const ResourceScheduler::Task &task);
//@endcond
/// @endcond
}
......
......@@ -80,9 +80,9 @@ public:
void itemSent(const Akonadi::Item &item, TransportResult result, const QString &message = QString());
private:
//@cond PRIVATE
/// @cond PRIVATE
TransportResourceBasePrivate *const d;
//@endcond
/// @endcond
};
}
......
......@@ -190,10 +190,10 @@ public:
void restart() const;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
QSharedDataPointer<Private> d;
//@endcond
/// @endcond
};
}
......
......@@ -348,7 +348,7 @@ AgentManager::AgentManager()
});
}
// @endcond
/// @endcond
AgentManager::~AgentManager() = default;
......
......@@ -186,11 +186,11 @@ Q_SIGNALS:
void instanceOnline(const Akonadi::AgentInstance &instance, bool online);
private:
//@cond PRIVATE
/// @cond PRIVATE
explicit AgentManager();
std::unique_ptr<AgentManagerPrivate> const d;
//@endcond
/// @endcond
};
}
......
......@@ -125,10 +125,10 @@ public:
bool operator==(const AgentType &other) const;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
QSharedDataPointer<Private> d;
//@endcond
/// @endcond
};
}
......
......@@ -38,9 +38,9 @@ namespace Akonadi
class AKONADICORE_EXPORT AttributeFactory
{
public:
//@cond PRIVATE
/// @cond PRIVATE
~AttributeFactory();
//@endcond
/// @endcond
/**
* Registers a custom attribute of type T.
......@@ -61,7 +61,7 @@ public:
static Attribute *createAttribute(const QByteArray &type);
protected:
//@cond PRIVATE
/// @cond PRIVATE
explicit AttributeFactory();
private:
......@@ -71,7 +71,7 @@ private:
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -62,10 +62,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -88,10 +88,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -62,10 +62,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -79,10 +79,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class EntityDeletedAttributePrivate;
const std::unique_ptr<EntityDeletedAttributePrivate> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -103,10 +103,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -81,10 +81,10 @@ public:
void deserialize(const QByteArray &data) override;
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -46,18 +46,18 @@ public:
*/
void setIndexingEnabled(bool enable);
//@cond PRIVATE
/// @cond PRIVATE
QByteArray type() const override;
Attribute *clone() const override;
QByteArray serialized() const override;
void deserialize(const QByteArray &data) override;
//@endcond
/// @endcond
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
......@@ -149,18 +149,18 @@ public:
*/
bool isRecursive() const;
//@cond PRIVATE
/// @cond PRIVATE
QByteArray type() const override;
Attribute *clone() const override;
QByteArray serialized() const override;
void deserialize(const QByteArray &data) override;
//@endcond
/// @endcond
private:
//@cond PRIVATE
/// @cond PRIVATE
class Private;
const std::unique_ptr<Private> d;
//@endcond
/// @endcond
};
} // namespace Akonadi
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment