docs; warnings

Author: andiwand

src/odr/internal/cfb/README.md

@@ -7,14 +7,15 @@ CFB stands for _Microsoft Compound File Binary File Format_
 ## Features
 
 - [x] from memory
-- [ ] from file
+- [x] from file
 - [x] list entries
 - [x] read as stream
 - [x] write as stream
 
 ## References
 
-implementation relies on [microsoft/compoundfilereader](https://github.com/microsoft/compoundfilereader)
+- [[MS-CFB]: Compound File Binary File Format](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-cfb)
+- implementation relies on [microsoft/compoundfilereader](https://github.com/microsoft/compoundfilereader)
 
 ### Related work
 

src/odr/internal/oldms/README.md

@@ -3,10 +3,12 @@
 ## references
 
 - [Technical Documents](https://docs.microsoft.com/en-us/openspecs/office_file_formats/MS-OFFFFLP/6ae2fd93-51fc-4e75-a54a-1b175c627b51)
-- [[MS-DOC]: Word (.doc) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-doc/ccd7b486-7881-484c-a137-51170af7cc22)
-- [[MS-PPT]: PowerPoint (.ppt) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ppt/6be79dde-33c1-4c1b-8ccc-4b2301c08662)
-- [[MS-XLS]: Excel Binary File Format (.xls) Structure](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-xls/cd03cb5f-ca02-4934-a391-bb674cb8aa06)
-- [[MS-XLSB]: Excel (.xlsb) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb/acc8aa92-1f02-4167-99f5-84f9f676b95a)
+- [[MS-DOC]: Word (.doc) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-doc)
+- [[MS-PPT]: PowerPoint (.ppt) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ppt)
+- [[MS-XLS]: Excel Binary File Format (.xls) Structure](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-xls)
+- [[MS-XLSB]: Excel (.xlsb) Binary File Format](https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb)
+- [[MS-CFB]: Compound File Binary File Format](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-cfb)
+- [[MS-OFFCRYPTO]: Office Document Cryptography Structure](https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-offcrypto)
 
 ### related work
 

src/odr/internal/oldms/word/structs.hpp

@@ -5,7 +5,6 @@
 #include <memory>
 #include <stdexcept>
 #include <string>
-#include <vector>
 
 namespace odr::internal::oldms {
 
@@ -273,7 +272,7 @@ struct Sprm {
   std::uint16_t sgc : 3;
   std::uint16_t spra : 3;
 
-  int operand_size() const {
+  [[nodiscard]] int operand_size() const {
     switch (spra) {
     case 0:
     case 1:
@@ -351,23 +350,31 @@ template <typename Derived, typename Data> class PlcBase {
 public:
   static constexpr std::uint32_t cbData() { return sizeof(Data); }
 
-  std::uint32_t n() const { return (self().cbPlc() - 4) / (4 + sizeof(Data)); }
+  [[nodiscard]] std::uint32_t n() const {
+    return (self().cbPlc() - 4) / (4 + sizeof(Data));
+  }
 
-  const std::uint32_t *aCP_ptr() const {
+  [[nodiscard]] const std::uint32_t *aCP_ptr() const {
     return reinterpret_cast<const std::uint32_t *>(self().data());
   }
 
-  const Data *aData_ptr() const {
+  [[nodiscard]] const Data *aData_ptr() const {
     return reinterpret_cast<const Data *>(self().data() + (n() + 1) * 4);
   }
 
-  std::uint32_t aCP(const std::uint32_t i) const { return aCP_ptr()[i]; }
+  [[nodiscard]] std::uint32_t aCP(const std::uint32_t i) const {
+    return aCP_ptr()[i];
+  }
 
-  Data aData(const std::uint32_t i) const { return aData_ptr()[i]; }
+  [[nodiscard]] Data aData(const std::uint32_t i) const {
+    return aData_ptr()[i];
+  }
 
 private:
-  Derived &self() { return *static_cast<Derived *>(this); }
-  const Derived &self() const { return *static_cast<const Derived *>(this); }
+  [[nodiscard]] Derived &self() { return *static_cast<Derived *>(this); }
+  [[nodiscard]] const Derived &self() const {
+    return *static_cast<const Derived *>(this);
+  }
 };
 
 template <typename Derived> class PlcPcdBase : public PlcBase<Derived, Pcd> {};
@@ -377,8 +384,8 @@ class PlcPcdMap : public PlcPcdBase<PlcPcdMap> {
   PlcPcdMap(char *data, const std::size_t cbPlc)
       : m_data(data), m_cbPlc(cbPlc) {}
 
-  char *data() const { return m_data; }
-  std::size_t cbPlc() const { return m_cbPlc; }
+  [[nodiscard]] char *data() const { return m_data; }
+  [[nodiscard]] std::size_t cbPlc() const { return m_cbPlc; }
 
 private:
   char *m_data{nullptr};