Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,9 @@ Dispatch `release.yml` against main, publish the draft that appears β€”
Detailed rationale belongs in the per-module `AGENTS.md`.
- **Doc-comment markers**: `///` for functions/classes/structs/enums; trailing
`///<` for the short note on the same line (enumerator/member). Keep terse.
**`@brief` only where there is a detail paragraph under it** β€” a lone
`@brief` marks nothing off from anything, so the tag is noise. Write the
description plainly; add `@brief` at the moment a second paragraph arrives.
- **Pull requests**: put the `πŸ€– Generated with [Claude Code](https://claude.com/claude-code)`
line **at the top** of the PR body. If the change is one a consumer would
notice, add its `CHANGELOG.md` entry in the same PR β€” see *Releasing*.
Expand Down
2 changes: 1 addition & 1 deletion src/odr/archive.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class Archive;
namespace odr {
class Filesystem;

/// @brief Represents an archive file.
/// Represents an archive file.
class Archive {
public:
explicit Archive(std::shared_ptr<internal::abstract::Archive>);
Expand Down
4 changes: 2 additions & 2 deletions src/odr/document.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Element;
class File;
class Filesystem;

/// @brief Represents a document.
/// Represents a document.
class Document final {
public:
explicit Document(std::shared_ptr<internal::abstract::Document>);
Expand All @@ -36,7 +36,7 @@ class Document final {
void save(std::ostream &out) const;
void save(std::ostream &out, const std::string &password) const;

/// @brief The saved document as a file in memory.
/// The saved document as a file in memory.
[[nodiscard]] File save_to_memory() const;
[[nodiscard]] File save_to_memory(const std::string &password) const;

Expand Down
60 changes: 30 additions & 30 deletions src/odr/document_element.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class TableCell;
class Frame;
class Image;

/// @brief Collection of element types.
/// Collection of element types.
enum class ElementType {
none,

Expand Down Expand Up @@ -112,7 +112,7 @@ enum class ElementType {
group,
};

/// @brief Collection of shapes a frame draws.
/// Collection of shapes a frame draws.
enum class ShapeType {
none, ///< a plain box, drawing no outline of its own
rect,
Expand All @@ -121,7 +121,7 @@ enum class ShapeType {
custom, ///< an outline of its own, read from @ref Frame::path
};

/// @brief Collection of anchor types.
/// Collection of anchor types.
enum class AnchorType {
as_char,
at_char,
Expand All @@ -130,20 +130,20 @@ enum class AnchorType {
at_paragraph,
};

/// @brief Collection of value types.
/// Collection of value types.
enum class ValueType {
unknown,
string,
float_number,
};

/// @brief Collection of list types.
/// Collection of list types.
enum class ListType {
unordered,
ordered,
};

/// @brief Represents an element in a document.
/// Represents an element in a document.
class Element {
public:
Element();
Expand Down Expand Up @@ -206,7 +206,7 @@ class Element {
[[nodiscard]] bool exists_() const;
};

/// @brief Represents an iterator for elements in a document.
/// Represents an iterator for elements in a document.
class ElementIterator {
public:
using value_type = Element;
Expand Down Expand Up @@ -243,7 +243,7 @@ class ElementIterator {
[[nodiscard]] bool exists_() const;
};

/// @brief Represents a range of elements in a document.
/// Represents a range of elements in a document.
class ElementRange {
public:
ElementRange();
Expand All @@ -258,7 +258,7 @@ class ElementRange {
ElementIterator m_end;
};

/// @brief Represents a typed element in a document.
/// Represents a typed element in a document.
template <typename T> class ElementBase : public Element {
public:
ElementBase() = default;
Expand All @@ -276,7 +276,7 @@ template <typename T> class ElementBase : public Element {
}
};

/// @brief Represents a root element in a document.
/// Represents a root element in a document.
class TextRoot final : public ElementBase<internal::abstract::TextRootAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -286,7 +286,7 @@ class TextRoot final : public ElementBase<internal::abstract::TextRootAdapter> {
[[nodiscard]] MasterPage first_master_page() const;
};

/// @brief Represents a slide element in a document.
/// Represents a slide element in a document.
class Slide final : public ElementBase<internal::abstract::SlideAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -298,7 +298,7 @@ class Slide final : public ElementBase<internal::abstract::SlideAdapter> {
[[nodiscard]] MasterPage master_page() const;
};

/// @brief Represents a sheet element in a document.
/// Represents a sheet element in a document.
class Sheet final : public ElementBase<internal::abstract::SheetAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -322,7 +322,7 @@ class Sheet final : public ElementBase<internal::abstract::SheetAdapter> {
std::uint32_t row) const;
};

/// @brief Represents a sheet cell element in a document.
/// Represents a sheet cell element in a document.
class SheetCell final
: public ElementBase<internal::abstract::SheetCellAdapter> {
public:
Expand All @@ -334,7 +334,7 @@ class SheetCell final
[[nodiscard]] ValueType value_type() const;
};

/// @brief Represents a page element in a document.
/// Represents a page element in a document.
class Page final : public ElementBase<internal::abstract::PageAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -346,7 +346,7 @@ class Page final : public ElementBase<internal::abstract::PageAdapter> {
[[nodiscard]] MasterPage master_page() const;
};

/// @brief Represents a master page element in a document.
/// Represents a master page element in a document.
class MasterPage final
: public ElementBase<internal::abstract::MasterPageAdapter> {
public:
Expand All @@ -355,7 +355,7 @@ class MasterPage final
[[nodiscard]] PageLayout page_layout() const;
};

/// @brief Represents a line break element in a document.
/// Represents a line break element in a document.
class LineBreak final
: public ElementBase<internal::abstract::LineBreakAdapter> {
public:
Expand All @@ -364,7 +364,7 @@ class LineBreak final
[[nodiscard]] TextStyle style() const;
};

/// @brief Represents a paragraph element in a document.
/// Represents a paragraph element in a document.
class Paragraph final
: public ElementBase<internal::abstract::ParagraphAdapter> {
public:
Expand All @@ -374,15 +374,15 @@ class Paragraph final
[[nodiscard]] TextStyle text_style() const;
};

/// @brief Represents a span element in a document.
/// Represents a span element in a document.
class Span final : public ElementBase<internal::abstract::SpanAdapter> {
public:
using ElementBase::ElementBase;

[[nodiscard]] TextStyle style() const;
};

/// @brief Represents a text element in a document.
/// Represents a text element in a document.
class Text final : public ElementBase<internal::abstract::TextAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -393,31 +393,31 @@ class Text final : public ElementBase<internal::abstract::TextAdapter> {
[[nodiscard]] TextStyle style() const;
};

/// @brief Represents a link element in a document.
/// Represents a link element in a document.
class Link final : public ElementBase<internal::abstract::LinkAdapter> {
public:
using ElementBase::ElementBase;

[[nodiscard]] std::string href() const;
};

/// @brief Represents a bookmark element in a document.
/// Represents a bookmark element in a document.
class Bookmark final : public ElementBase<internal::abstract::BookmarkAdapter> {
public:
using ElementBase::ElementBase;

[[nodiscard]] std::string name() const;
};

/// @brief Represents a list element in a document.
/// Represents a list element in a document.
class List final : public ElementBase<internal::abstract::ListAdapter> {
public:
using ElementBase::ElementBase;

[[nodiscard]] ListType type() const;
};

/// @brief Represents a list item element in a document.
/// Represents a list item element in a document.
class ListItem final : public ElementBase<internal::abstract::ListItemAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -432,7 +432,7 @@ class ListItem final : public ElementBase<internal::abstract::ListItemAdapter> {
[[nodiscard]] std::optional<std::uint32_t> number() const;
};

/// @brief Represents a table element in a document.
/// Represents a table element in a document.
class Table final : public ElementBase<internal::abstract::TableAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -448,7 +448,7 @@ class Table final : public ElementBase<internal::abstract::TableAdapter> {
[[nodiscard]] TableStyle style() const;
};

/// @brief Represents a table column element in a document.
/// Represents a table column element in a document.
class TableColumn final
: public ElementBase<internal::abstract::TableColumnAdapter> {
public:
Expand All @@ -457,15 +457,15 @@ class TableColumn final
[[nodiscard]] TableColumnStyle style() const;
};

/// @brief Represents a table row element in a document.
/// Represents a table row element in a document.
class TableRow final : public ElementBase<internal::abstract::TableRowAdapter> {
public:
using ElementBase::ElementBase;

[[nodiscard]] TableRowStyle style() const;
};

/// @brief Represents a table cell element in a document.
/// Represents a table cell element in a document.
class TableCell final
: public ElementBase<internal::abstract::TableCellAdapter> {
public:
Expand All @@ -490,7 +490,7 @@ struct DrawingPath final {
double height{0};
};

/// @brief Represents the two ends of a line shape, in the parent's space.
/// Represents the two ends of a line shape, in the parent's space.
struct DrawingLine final {
Measure x1{0, DynamicUnit()};
Measure y1{0, DynamicUnit()};
Expand All @@ -512,7 +512,7 @@ struct DrawingTransform final {
Measure f{0, DynamicUnit()};
};

/// @brief Represents a frame element in a document.
/// Represents a frame element in a document.
class Frame final : public ElementBase<internal::abstract::FrameAdapter> {
public:
using ElementBase::ElementBase;
Expand All @@ -533,7 +533,7 @@ class Frame final : public ElementBase<internal::abstract::FrameAdapter> {
[[nodiscard]] GraphicStyle style() const;
};

/// @brief Represents an image element in a document.
/// Represents an image element in a document.
class Image final : public ElementBase<internal::abstract::ImageAdapter> {
public:
using ElementBase::ElementBase;
Expand Down
2 changes: 1 addition & 1 deletion src/odr/document_path.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

namespace odr {

/// @brief A path to a specific element in a document.
/// A path to a specific element in a document.
class DocumentPath final {
public:
class Child final {
Expand Down
Loading
Loading