Add doc comments and a backup variable for the backup method

include/xeus-sqlite/xeus_sqlite_interpreter.hpp

@@ -48,20 +48,130 @@ class XEUS_SQLITE_API interpreter : public xeus::xinterpreter
     nl::json kernel_info_request_impl() override;
     void shutdown_request_impl() override;
 
+    /**
+     * Cleans the code from inputs that are acceptable in a jupyter notebook.
+     */
     std::string sanitize_string(const std::string& code);
+
+    /**
+     * Separetes the code on spaces so it's easier to execute the commands.
+     */
     std::vector<std::string> tokenizer(const std::string& code);
-    void parse_code(const std::vector<std::string>& tokenized_code);
+
+    /**
+     * Returns true if the code input is magic and false if isn't.
+     */
     bool is_magic(std::vector<std::string>& tokenized_code);
+
+    /**
+     * Parse magic and calls the correct function.
+     */
+    void parse_code(const std::vector<std::string>& tokenized_code);
+
+    /*! \brief load_db - loads a database.
+     *
+     * Receives three arguments: the command %LOAD, the path of the database
+     * location and a third optional parameter that might be RW or R to set the
+     * read and write or the read mode, respectively.
+     * If no third arguments are passed to this method, it will default to read
+     * and write mode.
+     *
+     * param accList std::vector<std::string>& tokenized_code
+     * return void
+     */
     void load_db(const std::vector<std::string> tokenized_code);
+
+    /*! \brief create_db - creates a database.
+     *
+     * Creates the a database in read and write mode.
+     * Receives three arguments: the command %CREATE, the path to where the
+     * database will be created and the name of the database.
+     *
+     * param accList std::vector<std::string>& tokenized_code
+     * return void
+     */
     void create_db(const std::vector<std::string> tokenized_code);
+
+    /*! \brief delete_db - deletes a database.
+     *
+     * Deletes the last database that was either loaded or created.
+     *
+     * param accList std::vector<std::string>& tokenized_code
+     * return void
+     */
     void delete_db();
+
+    /*! \brief table_exists - checks if a table exists in a database.
+     *
+     * Outputs a message in the Jupyter interface if the table exists in the
+     * latest created or loaded database.
+     *
+     * param accList const std::string table_name
+     * return void
+     */
     void table_exists(const std::string table_name);
+
+    /*! \brief set_key - set or create primary key.
+     *
+     * param accList const std::string& aKey
+     * return void
+     */
     void set_key(const std::string& aKey) const;
+
+    /*! \brief is_unencrypted - checks if a database is unencrypted.
+     *
+     * Outputs a message in the Jupyter interface if the latest database created
+     * or loaded is encrypted or not.
+     *
+     * return void
+     */
     void is_unencrypted();
+
+    /*! \brief get_header_info - returns information about the database.
+     *
+     * Outputs a message in the Jupyter interface containing information about
+     the database. This method outputs the following:
+     * Magic header string
+     * Page size bytes
+     * File format write version
+     * File format read version
+     * Reserved space bytes
+     * Max embedded payload fraction
+     * Min embedded payload fraction
+     * Leaf payload fraction
+     * File change counter
+     * Database size pages
+     * First freelist trunk page
+     * Total freelist trunk pages
+     * Schema cookie
+     * Schema format number
+     * Default page cache size bytes
+     * Largest B tree page number
+     * Database text encoding
+     * User version
+     * Incremental vaccum mode
+     * Application ID
+     * Version valid for
+     * SQLite version
+     *
+     * return void
+     */
     void get_header_info();
+
+    /*! \brief get_header_info - backups a database.
+     *
+     * This function is used to load the contents of a database file on disk
+     * into the "main" database of open database connection pInMemory, or
+     * to save the current contents of the database opened by pInMemory into
+     * a database file on disk.
+     *
+     * param accList std::string backup_type
+     * return void
+     */
     void backup(std::string backup_type);
 
     std::unique_ptr<SQLite::Database> m_db = nullptr;
+    std::unique_ptr<SQLite::Database> m_backup_db = nullptr;
     bool m_bd_is_loaded = false;
     std::string m_db_path;
 };