Warning, /frameworks/syntax-highlighting/autotests/input/highlight.dox is written in an unsupported language. File is not indexed.

0001 This is a pseudo doxygen file to test Kate's doxygen syntax highlighting.
0002 
0003 Normal text, no HL.
0004 ===================
0005 a multiline comment may begin with a /*! */, too. That should work,
0006 because it is the same "entrance rule".
0007 
0008 popping tests:
0009 /** multiline */ end of doxygen HL mode
0010 /*! multiline */ end of doxygen HL mode
0011 //! singleline, where */ should be ignored! still doxygen HL mode
0012 /// singleline, where */ should be ignored! still doxygen HL mode
0013 ///< singleline, where */ should be ignored! still doxygen HL mode
0014 begin and end immediately:
0015 /********/ actually no doxygen comment - used for "info boxes" :)
0016 /**/ <-- it really works --- end of doxygen HL mode
0017 /*!*/ end of doxygen HL mode
0018 
0019 <tag> <normal comment HL>
0020 /** \code rest of line is normal comment HL */ end of doxygen HL mode
0021 /** \code rest of line is normal comment HL
0022  * comment HL mode
0023  */ end of doxygen HL mode
0024 
0025 <tag> <word> <normal comment HL>
0026 /** \file aword rest of line is normal comment HL */ end of doxygen HL mode
0027 /** \file */aword <-- pop! no doxygen HL mode
0028 /** \file aword rest of line is normal comment HL
0029  * comment HL mode
0030  */ end of doxygen HL mode
0031 
0032 <tag> <rest of line is string>
0033 /** \brief A short description */ end of doxygen HL mode
0034 /** \brief */A <-- pop! end of doxygen HL mode
0035 /** \brief A short description 
0036  * comment HL mode
0037  */ end of doxygen HL mode
0038 
0039 <tag> <word> <rest of line is string>
0040 /** \page aword rest of line is string */ end of doxygen HL mode
0041 /** \page */aword <-- pop! end of doxygen HL mode
0042 /** \page aword rest of line is string 
0043  * comment HL mode
0044  */ end of doxygen HL mode
0045 
0046 <tag> <word> <word> <normal comment HL>
0047 /** \image aword aword rest of line is normal HL */ end of doxygen HL mode
0048 /** \image aword */aword <-- pop! end of doxygen HL mode
0049 /** \image */aword aword <-- pop! end of doxygen HL mode
0050 /** \image aword aword rest of line is normal HL
0051  * comment HL mode
0052  */ end of doxygen HL mode
0053 
0054 Tests for HTML tags in doxygen HL mode:
0055 =======================================
0056 /** <a href="blubb" href='blubb'> */ end of doxygen HL mode
0057 /** <a href="blubb" href='blubb'*/> end of doxygen HL mode
0058 /** <a href="blubb" href='blubb*/'> end of doxygen HL mode
0059 /** <a href="blubb" href='blub*/b'> end of doxygen HL mode
0060 /** <a href="blubb" href='b*/lubb'> end of doxygen HL mode
0061 /** <a href="blubb" href='*/blubb'> end of doxygen HL mode
0062 /** <a href="blubb" href=*/'blubb'> end of doxygen HL mode
0063 /** <a href="blubb" href*/='blubb'> end of doxygen HL mode
0064 /** <a href="blubb" hre*/f='blubb'> end of doxygen HL mode
0065 /** <a href="blubb" */href='blubb'> end of doxygen HL mode
0066 /** <a href="blubb"> */ end of doxygen HL mode
0067 /** <a href="blubb"*/> end of doxygen HL mode
0068 /** <a href="blubb*/"> end of doxygen HL mode
0069 /** <a href="blub*/b"> end of doxygen HL mode
0070 /** <a href="*/blubb"> end of doxygen HL mode
0071 /** <a href=*/"blubb"> end of doxygen HL mode
0072 /** <a href*/="blubb"> end of doxygen HL mode
0073 /** <a h*/ref="blubb"> end of doxygen HL mode
0074 /** <a */href="blubb"> end of doxygen HL mode
0075 /** <a*/ href="blubb"> end of doxygen HL mode
0076 /** <*/a href="blubb"> end of doxygen HL mode
0077 
0078 //! <a href="blubb" href='blubb'> */ stay in doygen HL mode
0079 //! <a href="blubb" href='blubb'*/> stay in doygen HL mode
0080 //! <a href="blubb" href='blubb*/'> stay in doygen HL mode
0081 //! <a href="blubb" href='blu*/bb'> stay in doygen HL mode
0082 //! <a href="blubb" href='*/blubb'> stay in doygen HL mode
0083 //! <a href="blubb" href=*/'blubb'> stay in doygen HL mode
0084 //! <a href="blubb"> */ stay in doygen HL mode
0085 //! <a href="blubb"*/> stay in doygen HL mode
0086 //! <a href="blubb*/"> stay in doygen HL mode
0087 //! <a href="blub*/b"> stay in doygen HL mode
0088 //! <a href="*/blubb"> stay in doygen HL mode
0089 //! <a href=*/"blubb"> stay in doygen HL mode
0090 //! <a href*/="blubb"> stay in doygen HL mode
0091 //! <a h*/ref="blubb"> stay in doygen HL mode
0092 //! <a */href="blubb"> stay in doygen HL mode
0093 //! <a*/ href="blubb"> stay in doygen HL mode
0094 //! <*/a href="blubb">  stay in doygen HL mode
0095 //! <a href="blubb">  stay in doygen HL <mode
0096 here should be normal HL mode (no doxygen!)
0097 
0098 Tests for HTML tags in doxygen HL mode with tags:
0099 =================================================
0100 <tag> <normal comment HL>
0101 /** \code rest <a href="blubb"> of </a href='blubb'> line is normal comment HL */ end of doxygen HL mode
0102 /** \code rest <a href="blubb"> of </a href='blubb'*/> end of doxygen HL mode
0103 /** \code rest <a href="blubb"> of </a href='blubb*/'> end of doxygen HL mode
0104 /** \code rest <a href="blubb"> of </a href='*/blubb'> end of doxygen HL mode
0105 /** \code rest <a href="blubb"> of </a href=*/'blubb'> end of doxygen HL mode
0106 /** \code rest <a href="blubb*/"> of </a href=*/'blubb'> end of doxygen HL mode
0107 /** \code rest <a href=*/"blubb"> of </a href='blubb'> end of doxygen HL mode
0108 /** \code rest <a h*/ref="blubb"> of </a href='blubb'> end of doxygen HL mode
0109 /** \code rest <*/a href="blubb"> of </a href='blubb'> end of doxygen HL mode
0110 /** \code rest of line is normal comment HL
0111  * comment HL mode <html> text </html>
0112  */ end of doxygen HL mode
0113 
0114 <tag> <word> <normal comment HL>
0115 /** \file awo<html_should_be_ignored_here>rd rest of line is normal comment HL */ end of doxygen HL mode
0116 /** \file awo<html_should_be_ignored_here>*/rd end of doxygen HL mode
0117 /** \file awo<html_should_be_i*/gnored_here>rd end of doxygen HL mode
0118 /** \file awo<*/html_should_be_ignored_here>rd end of doxygen HL mode
0119 /** \file a*/wo<html_should_be_ignored_here>rd end of doxygen HL mode
0120 /** \file aword rest of line is normal co<code>mment HL
0121  * comment HL mode
0122  */ end of doxygen HL mode
0123 
0124 <tag> <rest of line is string>
0125 /** \brief A short <a href="blubb"> of </a href='blubb'> description */ end of doxygen HL mode
0126 /** \brief A short <a href="blubb"> of </a href='blubb'*/> end of doxygen HL mode
0127 /** \brief A short <a href="blubb"> of </a href='*/blubb'> end of doxygen HL mode
0128 /** \brief A short <a href="blubb"> of </a href=*/'blubb'> end of doxygen HL mode
0129 /** \brief A short <a href="blubb"> of </a href*/='blubb'> end of doxygen HL mode
0130 /** \brief A short <a href="blubb"> of </a */href='blubb'> end of doxygen HL mode
0131 /** \brief A short <a href="blubb"> of <*//a href='blubb'> end of doxygen HL mode
0132 /** \brief A short <a href="blubb"*/> of </a href='blubb'> end of doxygen HL mode
0133 /** \brief A short <a href="blubb*/"> of </a href='blubb'> end of doxygen HL mode
0134 /** \brief A short <a href="*/blubb"> of </a href='blubb'> end of doxygen HL mode
0135 /** \brief A short <a href=*/"blubb"> of </a href='blubb'> end of doxygen HL mode
0136 /** \brief A short <a href*/="blubb"> of </a href='blubb'> end of doxygen HL mode
0137 /** \brief A short <a h*/ref="blubb"> of </a href='blubb'> end of doxygen HL mode
0138 /** \brief A short <a href="blubb"> of </a href='blubb'> description 
0139  * comment HL mode
0140  */ end of doxygen HL mode
0141 
0142 <tag> <word> <rest of line is string>
0143 /** \page aword A short <a href="blubb"> of </a href='blubb'> description */ end of doxygen HL mode
0144 /** \page aword A short <a href="blubb"> of </a href='blubb'*/> end of doxygen HL mode
0145 /** \page aword A short <a href="blubb"> of </a href='*/blubb'> end of doxygen HL mode
0146 /** \page aword A short <a href="blubb"> of </a href=*/'blubb'> end of doxygen HL mode
0147 /** \page aword A short <a href="blubb"> of </a href*/='blubb'> end of doxygen HL mode
0148 /** \page aword A short <a href="blubb"> of </a */href='blubb'> end of doxygen HL mode
0149 /** \page aword A short <a href="blubb"> of <*//a href='blubb'> end of doxygen HL mode
0150 /** \page aword A short <a href="blubb"*/> of </a href='blubb'> end of doxygen HL mode
0151 /** \page aword A short <a href="blubb*/"> of </a href='blubb'> end of doxygen HL mode
0152 /** \page aword A short <a href="*/blubb"> of </a href='blubb'> end of doxygen HL mode
0153 /** \page aword A short <a href=*/"blubb"> of </a href='blubb'> end of doxygen HL mode
0154 /** \page aword A short <a href*/="blubb"> of </a href='blubb'> end of doxygen HL mode
0155 /** \page aword A short <a h*/ref="blubb"> of </a href='blubb'> end of doxygen HL mode
0156 /** \page aword A short <*/a href="blubb"> of </a href='blubb'> end of doxygen HL mode
0157 /** \page aword A shor*/t <a href="blubb"> of </a href='blubb'> end of doxygen HL mode
0158 /** \page awor*/d A short <a href="blubb"> of </a href='blubb'> end of doxygen HL mode
0159 /** \page */aword A short <a href="blubb"> of </a href='blubb'> end of doxygen HL mode
0160 /** \page aword A short <a href="blubb"> of </a href='blubb'> description 
0161  * comment HL mode
0162  */ end of doxygen HL mode
0163 
0164 <tag> <word> <word> <rest of line is string>
0165 /** \image aword aword rest of line is normal HL */ end of doxygen HL mode
0166 /** \image aword aword rest of line is*/ end of doxygen HL mode
0167 /** \image aword aword*/ end of doxygen HL mode
0168 /** \image aword aw*/ord end of doxygen HL mode
0169 /** \image aword */aword end of doxygen HL mode
0170 /** \image aword*/ end of doxygen HL mode
0171 /** \image awo*/rd end of doxygen HL mode
0172 /** \image */aword end of doxygen HL mode
0173 /** \ima*/ge end of doxygen HL mode
0174 /** \image aword aword rest of line is normal HL
0175  * comment HL mode
0176  */ end of doxygen HL mode
0177  
0178 Some further tests for singlelinecomments (* / should not pop!)
0179 ===============================================================
0180 /// a singlelinecommment blubb blubb  */. stay in doxygen HL mode
0181 /// \code a singlelinecommment blubb b*/lubb. stay in doxygen HL mode
0182 end of doxygen HL mode
0183 /// \endcode
0184 /// \code*/ a singlelinecommment blubb blubb. stay in doxygen HL mode
0185 end of doxygen HL mode
0186 /// \code a multilinecommment blubb blubb
0187 /// blubb blubb
0188 /// \endcode
0189 /// \brief a descriptive text (string) stay in doxygen HL mode
0190 /// \brief a descriptive text (string)*/ description should go on here
0191 /// \brief a descriptive text */(string) description should go on here
0192 /// \brief */a descriptive text (string) description should go on here
0193 /// \ref aword a descriptive text (string) */ description should go on here
0194 /// \ref aword a descriptive text (str*/ing) description should go on here
0195 /// \ref aword a des*/criptive text (string) description should go on here
0196 /// \ref aword*/ a descriptive text (string) description should go on here
0197 /// \ref aw*/ord a descriptive text (string) description should go on here
0198 /// \ref */aword a descriptive text (string) description should go on here
0199 
0200 HTML comment tests:
0201 ===================
0202 //! \ref word de<!--*/ -->scriptive text (string)
0203 normal HL mode.
0204 //! \ref w descriptive text (string)
0205 /** \ref word de<!--*/ -->scriptive text (string)
0206 normal HL mode.
0207 /** \ref w <!--
0208  * HTML comments
0209  * -->
0210  * normal doxygen HL mode.
0211  */
0212 
0213 
0214 And final tests for a word: a single char:
0215 ===========================================
0216 <tag> <word> <rest of line as string>
0217 //! \ref word descriptive text (string)
0218 //! \ref w descriptive text (string)
0219 
0220 <tag> <word> <word> <rest is normal HL>
0221 //! \image word1 word2 b descriptive text (string)
0222 //! \image a word b descriptive text (string)
0223 
0224 <tag> <rest of line is string>
0225 //! \brief A b c d e description should go on here
0226 
0227 <tag> <word> <rest of line is normal doxygen HL mode>
0228 //! \file word rest of line is normal comment HL
0229 //! \file a word rest of line is normal comment HL
0230 
0231 no doxygen HL mode here.
0232 == END OF TESTFILE ==