Merge pull request #334 from hobyst/master

Improve .gitignore and LoadDocument and LoadFont documentation

.gitignore

@@ -13,11 +13,16 @@
 # Distribution target
 /Distribution/
 
-# Ignore MacOSX directory info
+# macOS directory info file
 .DS_Store
 
-# VS user project files
-.vs/
+# Hidden folders
+.*/
+
+# Not ignore .github/
+!.github/
+
+# Visual Studio project files
 *.suo
 *.user
 *.opensdf

Include/RmlUi/Core/Context.h

@@ -92,7 +92,8 @@ public:
 	/// @return The new document, or nullptr if no document could be created.
 	ElementDocument* CreateDocument(const String& instancer_name = "body");
 	/// Load a document into the context.
-	/// @param[in] document_path The path to the document to load.
+	/// @param[in] document_path The path to the document to load. The path is passed directly to the file interface which is used to load the file.
+	/// The default file interface accepts both absolute paths and paths relative to the working directory.
 	/// @return The loaded document, or nullptr if no document was loaded.
 	ElementDocument* LoadDocument(const String& document_path);
 	/// Load a document into the context.

Include/RmlUi/Core/Core.h

@@ -117,12 +117,13 @@ RMLUICORE_API Context* GetContext(int index);
 RMLUICORE_API int GetNumContexts();
 
 /// Adds a new font face to the font engine. The face's family, style and weight will be determined from the face itself.
-/// @param[in] file_name The file to load the face from.
+/// @param[in] file_path The path to the file to load the face from. The path is passed directly to the file interface which is used to load the file.
+/// The default file interface accepts both absolute paths and paths relative to the working directory.
 /// @param[in] fallback_face True to use this font face for unknown characters in other font faces.
 /// @param[in] weight The weight to load when the font face contains multiple weights, otherwise the weight to register the font as. By default it
 /// loads all found font weights.
 /// @return True if the face was loaded successfully, false otherwise.
-RMLUICORE_API bool LoadFontFace(const String& file_name, bool fallback_face = false, Style::FontWeight weight = Style::FontWeight::Auto);
+RMLUICORE_API bool LoadFontFace(const String& file_path, bool fallback_face = false, Style::FontWeight weight = Style::FontWeight::Auto);
 /// Adds a new font face from memory to the font engine. The face's family, style and weight is given by the parameters.
 /// @param[in] data A pointer to the data.
 /// @param[in] data_size Size of the data in bytes.

Source/Core/Core.cpp

@@ -332,9 +332,9 @@ int GetNumContexts()
 	return (int) contexts.size();
 }
 
-bool LoadFontFace(const String& file_name, bool fallback_face, Style::FontWeight weight)
+bool LoadFontFace(const String& file_path, bool fallback_face, Style::FontWeight weight)
 {
-	return font_interface->LoadFontFace(file_name, fallback_face, weight);
+	return font_interface->LoadFontFace(file_path, fallback_face, weight);
 }
 
 bool LoadFontFace(const byte* data, int data_size, const String& font_family, Style::FontStyle style, Style::FontWeight weight, bool fallback_face)

Source/Core/FontEngineInterface.cpp

@@ -34,7 +34,7 @@ FontEngineInterface::FontEngineInterface() {}
 
 FontEngineInterface::~FontEngineInterface() {}
 
-bool FontEngineInterface::LoadFontFace(const String& /*file_name*/, bool /*fallback_face*/, Style::FontWeight /*weight*/)
+bool FontEngineInterface::LoadFontFace(const String& /*file_path*/, bool /*fallback_face*/, Style::FontWeight /*weight*/)
 {
 	return false;
 }