Update docs and doxygen config (#26)

Doxyfile

@@ -79,7 +79,7 @@ OUTPUT_DIRECTORY       = docs
 # control the number of sub-directories.
 # The default value is: NO.
 
-CREATE_SUBDIRS         = NO
+CREATE_SUBDIRS         = YES
 
 # Controls the number of sub-directories that will be created when
 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
@@ -901,7 +901,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO
 # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = FAIL_ON_WARNINGS
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
@@ -1742,7 +1742,7 @@ OBFUSCATE_EMAILS       = YES
 # The default value is: png.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FORMULA_FORMAT    = png
+HTML_FORMULA_FORMAT    = svg
 
 # Use this tag to change the font size of LaTeX formulas included as images in
 # the HTML documentation. When you change the font size after a successful

include/github_api/request.hpp

@@ -38,7 +38,7 @@ namespace GitHub
              * @param user GitHub user name
              * @return api response in json format
              *
-             * Request user information. Equivalent of fetching https://api.github.com/users/<user>
+             * Request user information. Equivalent of fetching https://api.github.com/users/\<user>
              */
             std::string getUserInfo(const std::string& user);
 
@@ -48,7 +48,7 @@ namespace GitHub
              * @param repo user's repository name
              * @return api response in json format
              *
-             * Request list of releases for repository. Equivalent of fetching https://api.github.com/repos/<user>/<repo>/releases
+             * Request list of releases for repository. Equivalent of fetching https://api.github.com/repos/\<user>/\<repo>/releases
              */
             std::string getReleases(const std::string& user, const std::string& repo);
 
@@ -59,7 +59,7 @@ namespace GitHub
              * @param id release id. Id is returned as a part of \ref getReleases
              * @return api response in json format
              *
-             * Request details of release. Equivalent of fetching https://api.github.com/repos/<user>/<repo>/releases/<id>
+             * Request details of release. Equivalent of fetching https://api.github.com/repos/\<user>/\<repo>/releases/\<id>
              */
             std::string getRelease(const std::string& user, const std::string& repo, int id);
 
@@ -76,7 +76,7 @@ namespace GitHub
              * @param user GitHub user name
              * @return api response in json format
              *
-             * Request list of repositories for user. Equivalent of fetching https://api.github.com/users/<user>/repos
+             * Request list of repositories for user. Equivalent of fetching https://api.github.com/users/\<user>/repos
              */
             std::string listUserRepo(const std::string& user);
 
@@ -102,7 +102,7 @@ namespace GitHub
              * @brief Provides publicly available information about
              * someone with a GitHub account.
              *
-             * @param user github user name
+             * @param username github user name
              * @return std::string
              */
             std::string getUser(const std::string& username);