Merge branch 'master' of github.com:openframeworks/openFrameworks

CONTRIBUTING.md

@@ -24,7 +24,7 @@ We love hearing about bugs! It's how we get them fixed.
   - Make sure you give it a good title! 
   A good title explains the core of the problem in about 5-10 words. (It's sometimes easier to write the title after you've written the description.)
     - Examples of bad titles: _problem with ofRectangle_ or _can't set color_
-    - Examples of good titles: _ofRectangle crashes if width is 0_ or _ofSetColor doesn't work with ofPath objects_.
+    - Examples of good titles: _ofRectangle crashes if the width is 0_ or _ofSetColor doesn't work with ofPath objects_.
   - In the description, include the following details:
     0. **relevant system information** such as which openFrameworks version, operating system, and IDE you are using,
     1. what you were doing when you noticed the bug,
@@ -43,7 +43,7 @@ We're simply a busy group of people, but you will hear back eventually.
 
 At the moment we don't have a formal roadmap for the project, rather we are a community of people who each contributes to sections that we feel are important for the project.
 Feature requests are therefore mostly a way of us discussing/feeling out together where we'd like the project to go. 
-This can sometimes involve a lot of discussion, as everyone uses openFrameworks differently.
+This can sometimes involves a lot of discussion, as everyone uses openFrameworks differently.
 
 Feature requests are created as Github Issues, just like bugs. 
 Feature requests are also where code that you or anyone else would like to include in a future pull request is **discussed before being implemented!**
@@ -53,8 +53,8 @@ But please make sure it's been discussed as a feature request _before_ you submi
 Before opening a feature request, please search the issue tracker and confirm an existing request touching the same topic doesn't already exist.
 
 - We are generally a friendly and open collection of people, but communication over the internet can be difficult, so please don't treat a lot of discussion as a negative point against your feature request. 
-Usually a lot of discussion just means that we haven't thought about what you're requesting before, which is a good thing!
-- On the other hand, we are also busy people, often professionally involved in making large scale projects ourselves, using openFrameworks. 
+Usually, a lot of discussions just means that we haven't thought about what you're requesting before, which is a good thing!
+- On the other hand, we are also busy people, often professionally involved in making large-scale projects ourselves, using openFrameworks. 
 If you feel like no-one is paying attention to your feature request, just be patient, it will be considered eventually.
 - And finally, a small reality check: please don't expect that a general agreement in the discussion that a feature request is a good idea means it will get made immediately! 
 As with most open source projects, the fastest way to get a feature made is to make it yourself, or if you are not a programmer, make friends with someone who is, introduce them to openFrameworks, and ask them to make it for you.
@@ -92,4 +92,3 @@ This granularity makes the code easier to deal with in cases where some things h
   - Reference any issues or bugs in the [oF issue tracker](github.com/openframeworks/openFrameworks/issues) that are relevant to your pull request using `#issue number` notation, eg to reference issue __1234__ write `#1234`.
   - Mention if the code has been tested and on what platform.
 - Your pull request will be evaluated via the [Pull Request Review Procedure](https://github.com/openframeworks/openFrameworks/wiki/Pull-Request-Review-Procedure)
-

libs/openFrameworks/graphics/ofPolyline.h

@@ -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){

libs/openFrameworks/utils/ofSystemUtils.h

@@ -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

libs/openFrameworks/utils/ofURLFileLoader.h

@@ -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;
 
@@ -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
@@ -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
@@ -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
@@ -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