From 872d6ae16dada53aa883e573053c0720d68b5da3 Mon Sep 17 00:00:00 2001 From: Thomas Fussell Date: Sat, 31 Oct 2015 06:21:21 -0400 Subject: [PATCH] update docs --- docs/index.rst | 75 ++++++++++++++++------------ include/xlnt/common/string_table.hpp | 58 --------------------- include/xlnt/formula/translate.hpp | 33 ------------ include/xlnt/workbook/workbook.hpp | 10 ---- 4 files changed, 42 insertions(+), 134 deletions(-) delete mode 100644 include/xlnt/common/string_table.hpp delete mode 100644 include/xlnt/formula/translate.hpp diff --git a/docs/index.rst b/docs/index.rst index e9eb4a17..3a5220b2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,10 +9,7 @@ Welcome to xlnt's documentation! Contents: .. toctree:: - :maxdepth: 3 - -.. doxygenclass:: xlnt::cell - :members: + :maxdepth: 2 .. doxygenstruct:: xlnt::cell_reference_hash :members: @@ -20,6 +17,9 @@ Contents: .. doxygenclass:: xlnt::cell_reference :members: +.. doxygenclass:: xlnt::cell + :members: + .. doxygenclass:: xlnt::comment :members: @@ -38,12 +38,6 @@ Contents: .. doxygenclass:: xlnt::relationship :members: -.. doxygenclass:: xlnt::string_table - :members: - -.. doxygenclass:: xlnt::string_table_builder - :members: - .. doxygenstruct:: xlnt::zip_info :members: @@ -53,21 +47,12 @@ Contents: .. doxygenclass:: xlnt::drawing :members: +.. doxygenclass:: xlnt::tokenizer + :members: + .. doxygenclass:: xlnt::translator :members: -.. doxygenclass:: xlnt::comment_reader - :members: - -.. doxygenclass:: xlnt::excel_reader - :members: - -.. doxygenclass:: xlnt::shared_strings_reader - :members: - -.. doxygenclass:: xlnt::style_reader - :members: - .. doxygenclass:: xlnt::alignment :members: @@ -104,10 +89,13 @@ Contents: .. doxygenclass:: xlnt::document_security :members: +.. doxygenclass:: xlnt::manifest + :members: + .. doxygenclass:: xlnt::named_range :members: -.. doxygenstruct:: xlnt::content_type +.. doxygenclass:: xlnt::theme :members: .. doxygenclass:: xlnt::workbook @@ -119,6 +107,9 @@ Contents: .. doxygenclass:: xlnt::column_properties :members: +.. doxygenstruct:: xlnt::major_order + :members: + .. doxygenclass:: xlnt::page_margins :members: @@ -128,10 +119,13 @@ Contents: .. doxygenclass:: xlnt::pane :members: +.. doxygenclass:: xlnt::range_reference + :members: + .. doxygenclass:: xlnt::range :members: -.. doxygenclass:: xlnt::range_reference +.. doxygenclass:: xlnt::row_properties :members: .. doxygenclass:: xlnt::sheet_protection @@ -140,9 +134,6 @@ Contents: .. doxygenclass:: xlnt::sheet_view :members: -.. doxygenclass:: xlnt::row_properties - :members: - .. doxygenclass:: xlnt::header :members: @@ -158,22 +149,40 @@ Contents: .. doxygenclass:: xlnt::worksheet :members: -.. doxygenclass:: xlnt::chart_writer +.. doxygenclass:: xlnt::comment_serializer :members: -.. doxygenclass:: xlnt::chart_writer_factory +.. doxygenclass:: xlnt::excel_serializer :members: -.. doxygenclass:: xlnt::comment_writer +.. doxygenclass:: xlnt::manifest_serializer :members: -.. doxygenclass:: xlnt::excel_writer +.. doxygenclass:: xlnt::relationship_serializer :members: -.. doxygenclass:: xlnt::string_writer +.. doxygenclass:: xlnt::shared_strings_serializer :members: -.. doxygenclass:: xlnt::style_writer +.. doxygenclass:: xlnt::style_serializer + :members: + +.. doxygenclass:: xlnt::theme_serializer + :members: + +.. doxygenclass:: xlnt::workbook_serializer + :members: + +.. doxygenclass:: xlnt::worksheet_serializer + :members: + +.. doxygenclass:: xlnt::xml_document + :members: + +.. doxygenclass:: xlnt::xml_node + :members: + +.. doxygenclass:: xlnt::xml_serializer :members: Indices and tables diff --git a/include/xlnt/common/string_table.hpp b/include/xlnt/common/string_table.hpp deleted file mode 100644 index c093f488..00000000 --- a/include/xlnt/common/string_table.hpp +++ /dev/null @@ -1,58 +0,0 @@ -// Copyright (c) 2015 Thomas Fussell -// Copyright (c) 2010-2015 openpyxl -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in -// all copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, WRISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -// THE SOFTWARE -// -// @license: http://www.opensource.org/licenses/mit-license.php -// @author: see AUTHORS file -#pragma once - -#include -#include - -namespace xlnt { - -class string_table_builder; - -/// -/// Encapsulates a table of strings used for reading and writing sharedStrings.xml. -/// -class string_table -{ -public: - int operator[](const std::string &key) const; -private: - friend class string_table_builder; - std::vector strings_; -}; - -/// -/// Provides a simple interface for using string_table. -/// -class string_table_builder -{ -public: - void add(const std::string &string); - string_table &get_table() { return table_; } - const string_table &get_table() const { return table_; } -private: - string_table table_; -}; - -} // namespace xlnt diff --git a/include/xlnt/formula/translate.hpp b/include/xlnt/formula/translate.hpp deleted file mode 100644 index 78e40614..00000000 --- a/include/xlnt/formula/translate.hpp +++ /dev/null @@ -1,33 +0,0 @@ -#include -#include - -namespace xlnt { - -class cell_reference; -class tokenizer; - -class translator -{ - translator(const std::string &formula, const cell_reference &ref); - - std::vector get_tokens(); - - static std::string translate_row(const std::string &row_str, int row_delta); - static std::string translate_col(const std::string &col_str, col_delta); - - std::pair strip_ws_name(const std::string &range_str); - - void translate_range(const range_reference &range_ref); - void translate_formula(const cell_reference &dest); - -private: - const std::string ROW_RANGE_RE; - const std::string COL_RANGE_RE; - const std::string CELL_REF_RE; - - std::string formula_; - cell_reference reference_; - tokenizer tokenizer_; -}; - -} // namespace xlnt diff --git a/include/xlnt/workbook/workbook.hpp b/include/xlnt/workbook/workbook.hpp index 91035834..a9334a1f 100644 --- a/include/xlnt/workbook/workbook.hpp +++ b/include/xlnt/workbook/workbook.hpp @@ -59,14 +59,6 @@ namespace detail { struct workbook_impl; } // namespace detail -struct content_type -{ - bool is_default; - std::string extension; - std::string part_name; - std::string type; -}; - /// /// workbook is the container for all other parts of the document. /// @@ -195,8 +187,6 @@ public: { return !(*this == std::nullptr_t{}); } - - std::vector get_content_types() const; void create_relationship(const std::string &id, const std::string &target, relationship::type type); relationship get_relationship(const std::string &id) const;