Skip to content

Commit

Permalink
fixing points related to doxygen reported errors
Browse files Browse the repository at this point in the history
  • Loading branch information
Edrusb committed Jan 15, 2025
1 parent 195340d commit 28e98b9
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 119 deletions.
2 changes: 1 addition & 1 deletion build/configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.71])
AC_INIT([WEBDAR],[0.7.0],[[https://github.com/Edrusb/webdar/issues]])
AC_INIT([WEBDAR],[0.8.0],[[https://github.com/Edrusb/webdar/issues]])
AC_CONFIG_HEADERS([config.h])
AC_LANG([C++])
AC_CONFIG_SRCDIR([src/webdar.cpp])
Expand Down
53 changes: 0 additions & 53 deletions src/CLASS_TEMPLATE.cpp

This file was deleted.

55 changes: 0 additions & 55 deletions src/CLASS_TEMPLATE.hpp

This file was deleted.

8 changes: 7 additions & 1 deletion src/TEMPLATE.CPP → src/TEMPLATE.CPP.TMPLT
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,13 @@ extern "C"


//
#include "TEMPLATE.HPP"
#include "XXX.hpp"

using namespace std;

YYY::YYY()
{

}


17 changes: 15 additions & 2 deletions src/TEMPLATE.HPP → src/TEMPLATE.HPP.TMPLT
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
// to contact the author: [email protected]
/*********************************************************************/

#ifndef XXXXXX
#define XXXXXX
#ifndef XXX
#define XXX

// C system header files
extern "C"
Expand All @@ -36,7 +36,20 @@ extern "C"
// webdar headers


/// class YYY description

/// class YYY long description
///

class YYY
{
public:
YYY(const std::string & title);
YYY(const YYY & ref) = default;
YYY(YYY && ref) noexcept = default;
YYY & operator = (const YYY & ref) = default;
YYY & operator = (YYY && ref) noexcept = default;
~YYY() = default;
};

#endif
2 changes: 1 addition & 1 deletion src/html_form_dynamic_table.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ class html_form_dynamic_table : public html_div, public actor, public events
void del_line(const std::string & event_name);
void purge_to_delete();

friend html_form_dynamic_table::iterator;
friend class html_form_dynamic_table::iterator;
};

#endif
3 changes: 1 addition & 2 deletions src/html_over_guichet.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,8 @@ class html_over_guichet : public guichet,
/// mandatory call to provide the object to adopt and use to load/save json and get mask configurations

/// \param[in] ptr pointer to a bibliotheque where from to fetch configurations
/// \param[in] cat category in which to look for named in the bibliotheque
/// \param[in] to_give object of the type corresponding to the category be given to this html_over_guichet
/// \param[in] add_form_around whether a form around to_give is necessary for proper functionning
/// \param[in] cat category in which to look for named in the bibliotheque
/// \note to_give must also be a jsoner and a html_mask, it pass under the managment responsibility of the
/// html_over_guichet object.
void set_child(const std::shared_ptr<bibliotheque> & ptr,
Expand Down
4 changes: 2 additions & 2 deletions src/jsoner.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ class jsoner
/// - a json format version
/// - a json component identifier (name the class for example)
/// - an arbitrary configuration under
/// { "version": <num>, "id": "<class name>", "config": {...} }
/// { "version": num, "id": "class name", "config": {...} }
/// see the protected static methods that implement this.
virtual json save_json() const = 0;

Expand All @@ -113,7 +113,7 @@ class jsoner

/// from a given json global and common json structure split header parts and return the config part

/// \param[in] json the global json configuration to apply to the current object
/// \param[in] source the global json configuration to apply to the current object
/// \param[in] version the format and expected fields of the returned json configuration
/// \param[in] class_id should match the name of the class this static method is used by
/// \return inherited class specific data to apply to the current object following the format version 'version'
Expand Down
4 changes: 2 additions & 2 deletions src/request.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,13 @@ class request

/// \param[in] num the part number of the multipart in this request, first part is starting at index zero
/// \return a map of key/value pair corresponding to the key/values pair found in the
/// header the multipart number <num> found in the body
/// header the multipart number "num" found in the body
std::map<troncon,troncon> get_header_of_multipart(unsigned int num) const; ///< first part is starting at index zero

/// obtains the body of multiparts once get_multipart_number() has been executed

/// \param[in] num the part number of the multipart in this request, first part is starting at index zero
/// \return the document inclosed in the multipart number <num> of the body
/// \return the document inclosed in the multipart number "num" of the body
troncon get_body_of_multipart(unsigned int num) const;

private:
Expand Down

0 comments on commit 28e98b9

Please sign in to comment.