openshot/libopenshot
0
0
Fork 0
mirror of https://github.com/OpenShot/libopenshot.git synced 2026-03-02 08:53:52 -08:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for Qt(Text/Html)Reader

Browse Source 
- Some parameters were changed from documented list
- Hash signs need to be escaped if they're not references (links)
This commit is contained in:
FeRD (Frank Dana)
2019-11-17 01:44:57 -05:00
parent c2713520b9
commit 7bbec4c51c
2 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/QtTextReader.h
+3 -6
View File
@@ -114,15 +114,12 @@ namespace openshot
/// @param gravity The alignment / gravity of the text
/// @param text The text you want to generate / display
/// @param font The font of the text
/// @param font_size The size of the text
/// @param is_bold Set to true to make text bold
/// @param is_italic Set to true to make text italic
/// @param text_color The color of the text (valid values are a color string in #RRGGBB or #AARRGGBB notation or a CSS color name)
/// @param background_color The background color of the frame image (valid values are a color string in #RRGGBB or #AARRGGBB notation, a CSS color name, or 'transparent')
/// @param text_color The color of the text (valid values are a color string in \#RRGGBB or \#AARRGGBB notation or a CSS color name)
/// @param background_color The background color of the frame image (valid values are a color string in \#RRGGBB or \#AARRGGBB notation, a CSS color name, or 'transparent')
QtTextReader(int width, int height, int x_offset, int y_offset, GravityType gravity, std::string text, QFont font, std::string text_color, std::string background_color);
/// Draw a box under rendered text using the specified color.
/// @param color The background color behind the text (valid values are a color string in #RRGGBB or #AARRGGBB notation or a CSS color name)
/// @param color The background color behind the text (valid values are a color string in \#RRGGBB or \#AARRGGBB notation or a CSS color name)
void SetTextBackgroundColor(std::string color);
/// Close Reader