diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2018-12-23 19:08:19 (GMT) |
---|---|---|
committer | Dimitri van Heesch <doxygen@gmail.com> | 2018-12-23 19:08:19 (GMT) |
commit | c3ee766d0ad5721c753581e7f87026614c0730e1 (patch) | |
tree | 7fa6ad9bbb5c3fcd8938bec8fea9b1b0a36e397f /doc/commands.doc | |
parent | 200353a0886f5ee20101b7af4b55af498adc495f (diff) | |
download | Doxygen-c3ee766d0ad5721c753581e7f87026614c0730e1.zip Doxygen-c3ee766d0ad5721c753581e7f87026614c0730e1.tar.gz Doxygen-c3ee766d0ad5721c753581e7f87026614c0730e1.tar.bz2 |
Improved robustness of the emoji feature
Changes:
- Use of `@emoji name` instead of `:name:`
- Support only GitHub emojis (i.e. without spaces or special characters in the name)
- Provided script to download images for LaTeX support.
- XML output now has <emoji> tag with name an unicode sequence.
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index e27cc00..c569e6c 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -75,6 +75,7 @@ documentation: \refitem cmdelse \\else \refitem cmdelseif \\elseif \refitem cmdem \\em +\refitem cmdemoji \\emoji \refitem cmdendcode \\endcode \refitem cmdendcond \\endcond \refitem cmdenddocbookonly \\enddocbookonly @@ -218,7 +219,6 @@ documentation: \refitem cmdperc \\\% \refitem cmdquot \\\" \refitem cmdchardot \\\. -\refitem cmdcolon \: \refitem cmddcolon \:: \refitem cmdpipe \\| \refitem cmdndash \\\-- @@ -2743,6 +2743,22 @@ class C {}; \endcode <hr> +\section cmdemoji \\emoji "name" + +This command will produce an emoji character given its name. + +The supported names are the ones also supported by GitHub and listed here +https://gist.github.com/rxaviers/7360908 + +You can use the name with or without colons, i.e. +`\emoji smile` is the same as writing `\emoji :smile:`. +When an emoji is not supported the name with by places in the +text with in between colons, i.e. `\emoji unsupported` will produce +`:unsupported:` in the output. Doxygen will also give a warning message. + +See also the \ref emojisup "emoji support page" for details. + +<hr> \section cmdmsc \\msc ["caption"] [<sizeindication>=<size>] \addindex \\msc @@ -3446,14 +3462,6 @@ class Receiver the start of a line. <hr> -\section cmdcolon \: - - \addindex \\: - This command writes a single colon (\c \:) to the output. This - character sequence has to be escaped in some cases, because it is used - to define `emoji` see also \ref emojisup "Emoji support". - -<hr> \section cmddcolon \\:: \addindex \\:: |