some markdown doc
This commit is contained in:
parent
1001e84bc0
commit
3cd1eee4d3
|
@ -1549,7 +1549,7 @@ EXTRA_SEARCH_MAPPINGS =
|
||||||
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
|
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
|
||||||
# The default value is: YES.
|
# The default value is: YES.
|
||||||
|
|
||||||
GENERATE_LATEX = YES
|
GENERATE_LATEX = NO
|
||||||
|
|
||||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
||||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||||
|
|
12
README.md
12
README.md
|
@ -2,3 +2,15 @@ Snorenotify
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Snorenotify is a multi platform Qt based notification framework.
|
Snorenotify is a multi platform Qt based notification framework.
|
||||||
|
Using a plugin system it is possible to create notifications with many different notification systems on Windows, Unix and Mac.
|
||||||
|
|
||||||
|
## Supported Backends ##
|
||||||
|
- [Windows 8](https://github.com/TheOneRing/Snoretoast) [ ![Windows 8 Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/win8_high.jpg) ](http://winkde.org/~pvonreth/other/snore/img/win8.png)
|
||||||
|
|
||||||
|
- [Growl for Windows](http://www.growlforwindows.com/) [![Growl for Windows Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/growl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/growl.png)
|
||||||
|
|
||||||
|
- [Snarl](http://snarl.fullphat.net/) [![Snarl Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snarl_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/snarl.png)
|
||||||
|
|
||||||
|
- Integrated notifications [![Snore Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/snore_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/snore.png)
|
||||||
|
|
||||||
|
- System Tray [![System Tray Notification](http://winkde.org/~pvonreth/other/snore/img/Thumbnail%20Pictures/tray_high.jpg)](http://winkde.org/~pvonreth/other/snore/img/tray.png)
|
|
@ -94,10 +94,10 @@ public:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns application specific hints:
|
* Returns application specific hints:
|
||||||
* <table>
|
* Key | Value | Required
|
||||||
* <tr><td>desktop-entry</td><td>The name of the desktop enty associated with the application</td><td>Used for The freedesktop backend</td></tr>
|
* ------------- | ----------- | -----------
|
||||||
* <tr><td>windows-app-id</td><td>The app id associated with the application</td><td>Needed for the Windows 8 backend <a href="http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx">See MSDN</a></td></tr>
|
* desktop-entry | The name of the desktop enty associated with the application | Used for The freedesktop backend
|
||||||
* </table>
|
* windows-app-id | The app id associated with the application | Needed for the Windows 8 backend [See MSDN Documentation](http://msdn.microsoft.com/en-us/library/windows/apps/dd378459.aspx)
|
||||||
*/
|
*/
|
||||||
Hint &hints();
|
Hint &hints();
|
||||||
|
|
||||||
|
|
|
@ -37,13 +37,13 @@ class QSystemTrayIcon;
|
||||||
/**
|
/**
|
||||||
* Snore is a platform independent Qt notification framework.
|
* Snore is a platform independent Qt notification framework.
|
||||||
*
|
*
|
||||||
* Environment variables:
|
* Environment variable | Effect
|
||||||
* <table>
|
* ---------------------------------|-------------------------------
|
||||||
* <tr><td>LIBSNORE_DEBUG_LVL</td><td>Value betwene 0 and 3 @see SnoreDebugLevels</td></tr>
|
* LIBSNORE_DEBUG_LVL | Value betwene 0 and 3 @see SnoreDebugLevels
|
||||||
* <tr><td>LIBSNORE_LOG_TO_FILE</td><td>If 1 write to a logfile in tmp/libsnore/appname-log.txt</td></tr>
|
* LIBSNORE_LOG_TO_FILE | If 1 write to a logfile in tmp/libsnore/appname-log.txt
|
||||||
* <tr><td>LIBSNORE_LOGFILE</td><td>Use with LIBSNORE_LOG_TO_FILE, sets the file to log to</td></tr>
|
* LIBSNORE_LOGFILE | Use with LIBSNORE_LOG_TO_FILE, sets the file to log to
|
||||||
* <tr><td>LIBSNORE_FORCE_CHACHE_UPDATE</td><td>Always update the plugin cache</td></tr>
|
* LIBSNORE_FORCE_CHACHE_UPDATE | Always update the plugin cache
|
||||||
* </table>
|
*
|
||||||
*
|
*
|
||||||
* @author Patrick von Reth \<vonreth at kde.org\>
|
* @author Patrick von Reth \<vonreth at kde.org\>
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue