Skip to content

Commit

Permalink
A collection of fixes for invalid doxygen comments. (#5799)
Browse files Browse the repository at this point in the history
  • Loading branch information
bakercp authored and arturoc committed Mar 22, 2019
1 parent 2cee86a commit 27c513c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion libs/openFrameworks/graphics/ofPolyline.h
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ using ofPolyline = ofPolyline_<ofDefaultVertexType>;
/// \brief Determine if an (x,y) coordinate is within the polygon defined by a vector of glm::vec3s.
/// \param x The x dimension of the coordinate.
/// \param y The y dimension of the coordinate.
/// \param poly a vector of glm::vec3s defining a polygon.
/// \param polygon a vector of glm::vec3s defining a polygon.
/// \returns True if the point defined by the coordinates is enclosed, false otherwise.
template<class T>
bool ofInsidePoly(float x, float y, const std::vector<T>& polygon){
Expand Down
6 changes: 3 additions & 3 deletions libs/openFrameworks/utils/ofSystemUtils.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ class ofFileDialogResult{
/// \return the full path of the selected file or directory, if set
std::string getPath();

std::string filePath; //< full path to selected file or directory
std::string fileName; //< selected file or directory name
bool bSuccess; //< true if the dialog action was successful, aka file select not cancel
std::string filePath; ///< full path to selected file or directory
std::string fileName; ///< selected file or directory name
bool bSuccess; ///< true if the dialog action was successful, aka file select not cancel
};

/// \brief show an error message in an alert dialog box
Expand Down
32 changes: 16 additions & 16 deletions libs/openFrameworks/utils/ofURLFileLoader.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ class ofHttpRequest{
ofHttpRequest();
ofHttpRequest(const std::string& url, const std::string& name,bool saveTo=false);

std::string url; //< request url
std::string name; //< optional name key for sorting
bool saveTo; //< save to a file once the request is finised?
std::map<std::string,std::string> headers; //< HTTP header keys & values
std::string body; //< POST body data
std::string contentType; //< POST data mime type
std::string url; ///< request url
std::string name; ///< optional name key for sorting
bool saveTo; ///< save to a file once the request is finised?
std::map<std::string,std::string> headers; ///< HTTP header keys & values
std::string body; ///< POST body data
std::string contentType; ///< POST data mime type
std::function<void(const ofHttpResponse&)> done;
size_t timeoutSeconds = 0;

Expand All @@ -28,13 +28,13 @@ class ofHttpRequest{

/// HTTP request type
enum Method{
GET, //< request data from a specified resource (via url)
POST //< submit data to be processed to a specified resource (via url)
GET, ///< request data from a specified resource (via url)
POST ///< submit data to be processed to a specified resource (via url)
} method;

private:
int id; //< unique id for this request
static int nextID; //< global for computing next unique id
int id; ///< unique id for this request
static int nextID; ///< global for computing next unique id
};

/// \class ofHttpResponse
Expand All @@ -47,10 +47,10 @@ class ofHttpResponse{

operator ofBuffer&();

ofHttpRequest request; //< matching HTTP request for this response
ofBuffer data; //< response raw data
int status; //< HTTP response status (200: OK, 404: Not Found, etc)
std::string error; //< HTTP error string, if any (OK, Not Found, etc)
ofHttpRequest request; ///< matching HTTP request for this response
ofBuffer data; ///< response raw data
int status; ///< HTTP response status (200: OK, 404: Not Found, etc)
std::string error; ///< HTTP error string, if any (OK, Not Found, etc)
};

/// \brief make an HTTP GET request
Expand Down Expand Up @@ -84,7 +84,7 @@ ofHttpResponse ofSaveURLTo(const std::string& url, const std::filesystem::path&
int ofSaveURLAsync(const std::string& url, const std::filesystem::path& path);

/// \brief remove an active HTTP request from the queue
/// \param unique HTTP request id
/// \param id HTTP request id
void ofRemoveURLRequest(int id);

/// \brief remove all active HTTP requests from the queue
Expand Down Expand Up @@ -142,7 +142,7 @@ class ofURLFileLoader {
int saveAsync(const std::string& url, const std::filesystem::path& path);

/// \brief remove an active HTTP request from the queue
/// \param unique HTTP request id
/// \param id HTTP request id
void remove(int id);

/// \brief clear all active HTTP requests from the queue
Expand Down

0 comments on commit 27c513c

Please sign in to comment.