From bd2cf98e75c600e0c2f5ae95301df8745d65571a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 25 Nov 2017 19:27:15 +0100 Subject: Provide page brief in of XML output. Until now the brief description of pages was prepended to the element and the element was not present at all, which meant there was no easy way to extract the brief description for purposes of creating a page index, for example. With this patch, the brief description is included in both and , thus duplicated, to avoid backwards compatibility issues. --- src/xmlgen.cpp | 3 +++ testing/001/indexpage.xml | 2 ++ testing/002/indexpage.xml | 2 ++ testing/003/indexpage.xml | 2 ++ testing/004/indexpage.xml | 2 ++ testing/005/indexpage.xml | 2 ++ testing/006/indexpage.xml | 2 ++ testing/007/indexpage.xml | 2 ++ testing/009/bug.xml | 2 ++ testing/009/deprecated.xml | 2 ++ testing/009/reminders.xml | 2 ++ testing/009/test.xml | 2 ++ testing/009/todo.xml | 2 ++ testing/010/indexpage.xml | 2 ++ testing/012/citelist.xml | 2 ++ testing/012/indexpage.xml | 2 ++ testing/014/indexpage.xml | 2 ++ testing/017/indexpage.xml | 2 ++ testing/020/indexpage.xml | 2 ++ testing/021/indexpage.xml | 2 ++ testing/022/indexpage.xml | 2 ++ testing/023/indexpage.xml | 2 ++ testing/024/indexpage.xml | 2 ++ testing/025/example_test_8cpp-example.xml | 2 ++ testing/028/indexpage.xml | 2 ++ testing/030/indexpage.xml | 2 ++ testing/031/indexpage.xml | 2 ++ testing/032/indexpage.xml | 2 ++ testing/033/indexpage.xml | 2 ++ testing/034/indexpage.xml | 2 ++ testing/038/indexpage.xml | 2 ++ testing/043/another.xml | 2 ++ testing/043/mypage.xml | 4 ++++ testing/043_page.dox | 2 ++ testing/045/indexpage.xml | 2 ++ testing/049/indexpage.xml | 2 ++ testing/050/indexpage.xml | 2 ++ testing/051/indexpage.xml | 2 ++ testing/052/indexpage.xml | 2 ++ testing/053/indexpage.xml | 2 ++ testing/055/md_055_markdown.xml | 2 ++ testing/056/indexpage.xml | 2 ++ testing/065/indexpage.xml | 2 ++ 43 files changed, 89 insertions(+) diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp index 1b03c3b..81fba40 100644 --- a/src/xmlgen.cpp +++ b/src/xmlgen.cpp @@ -1825,6 +1825,9 @@ static void generateXMLForPage(PageDef *pd,FTextStream &ti,bool isExample) } } writeInnerPages(pd->getSubPages(),t); + t << " " << endl; + writeXMLDocBlock(t,pd->briefFile(),pd->briefLine(),pd,0,pd->briefDescription()); + t << " " << endl; t << " " << endl; if (isExample) { diff --git a/testing/001/indexpage.xml b/testing/001/indexpage.xml index 06d680b..0d567f5 100644 --- a/testing/001/indexpage.xml +++ b/testing/001/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Text argument more text. diff --git a/testing/002/indexpage.xml b/testing/002/indexpage.xml index 1eba9d5..25a731b 100644 --- a/testing/002/indexpage.xml +++ b/testing/002/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/003/indexpage.xml b/testing/003/indexpage.xml index a4f42e2..dbd1559 100644 --- a/testing/003/indexpage.xml +++ b/testing/003/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + See Anchor Some text. More text. diff --git a/testing/004/indexpage.xml b/testing/004/indexpage.xml index 3d0a713..fdaea0d 100644 --- a/testing/004/indexpage.xml +++ b/testing/004/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + AlignLeft left alignment. AlignCenter center alignment. AlignRight right alignment No other types of alignment are supported. diff --git a/testing/005/indexpage.xml b/testing/005/indexpage.xml index 5a2e6f9..4a12dfd 100644 --- a/testing/005/indexpage.xml +++ b/testing/005/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/006/indexpage.xml b/testing/006/indexpage.xml index 1afe69b..162aac0 100644 --- a/testing/006/indexpage.xml +++ b/testing/006/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/007/indexpage.xml b/testing/007/indexpage.xml index 9b22813..8e85063 100644 --- a/testing/007/indexpage.xml +++ b/testing/007/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Text bold normal text. diff --git a/testing/009/bug.xml b/testing/009/bug.xml index 1d80134..a6dfe88 100644 --- a/testing/009/bug.xml +++ b/testing/009/bug.xml @@ -3,6 +3,8 @@ bug Bug List + + diff --git a/testing/009/deprecated.xml b/testing/009/deprecated.xml index 0613b25..5db2acd 100644 --- a/testing/009/deprecated.xml +++ b/testing/009/deprecated.xml @@ -3,6 +3,8 @@ deprecated Deprecated List + + diff --git a/testing/009/reminders.xml b/testing/009/reminders.xml index e9983ed..a5c5560 100644 --- a/testing/009/reminders.xml +++ b/testing/009/reminders.xml @@ -3,6 +3,8 @@ reminders Reminders + + diff --git a/testing/009/test.xml b/testing/009/test.xml index 14395bf..e206440 100644 --- a/testing/009/test.xml +++ b/testing/009/test.xml @@ -3,6 +3,8 @@ test Test List + + diff --git a/testing/009/todo.xml b/testing/009/todo.xml index 4b731e3..88d050e 100644 --- a/testing/009/todo.xml +++ b/testing/009/todo.xml @@ -3,6 +3,8 @@ todo Todo List + + diff --git a/testing/010/indexpage.xml b/testing/010/indexpage.xml index 61f515c..05c297e 100644 --- a/testing/010/indexpage.xml +++ b/testing/010/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Text code normal text. Text code normal text. diff --git a/testing/012/citelist.xml b/testing/012/citelist.xml index 6b11c4f..96b94a3 100644 --- a/testing/012/citelist.xml +++ b/testing/012/citelist.xml @@ -3,6 +3,8 @@ citelist Bibliography + + diff --git a/testing/012/indexpage.xml b/testing/012/indexpage.xml index 926b53b..73fb669 100644 --- a/testing/012/indexpage.xml +++ b/testing/012/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + See [1] for more info. diff --git a/testing/014/indexpage.xml b/testing/014/indexpage.xml index e677e24..7cbc82f 100644 --- a/testing/014/indexpage.xml +++ b/testing/014/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/017/indexpage.xml b/testing/017/indexpage.xml index f1bfc5e..3326ee8 100644 --- a/testing/017/indexpage.xml +++ b/testing/017/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/020/indexpage.xml b/testing/020/indexpage.xml index f7cd444..3171e13 100644 --- a/testing/020/indexpage.xml +++ b/testing/020/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Text. XML diff --git a/testing/021/indexpage.xml b/testing/021/indexpage.xml index 9205dd6..7c93a78 100644 --- a/testing/021/indexpage.xml +++ b/testing/021/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Our main function starts like this: voidmain(){ First we create a object t of the Test class. Testt; Then we call the example member function t.example(); After that our little test routine ends. } diff --git a/testing/022/indexpage.xml b/testing/022/indexpage.xml index afcf23a..0fcee9c 100644 --- a/testing/022/indexpage.xml +++ b/testing/022/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Class relations expressed via an inline dot graph: digraph example { diff --git a/testing/023/indexpage.xml b/testing/023/indexpage.xml index b907db9..c87860c 100644 --- a/testing/023/indexpage.xml +++ b/testing/023/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Normal emphasis and more emphasis back to normal. diff --git a/testing/024/indexpage.xml b/testing/024/indexpage.xml index 11a385b..7396177 100644 --- a/testing/024/indexpage.xml +++ b/testing/024/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Unconditional (start) Enabled (if). Enabled (else). Unconditional (middle) Enabled (else). Unconditional (end) diff --git a/testing/025/example_test_8cpp-example.xml b/testing/025/example_test_8cpp-example.xml index 96a1cd7..9f5ae7c 100644 --- a/testing/025/example_test_8cpp-example.xml +++ b/testing/025/example_test_8cpp-example.xml @@ -2,6 +2,8 @@ example_test.cpp + + This is an example of how to use the Test class. More details about this example. voidmain(){Testt;t.example();} diff --git a/testing/028/indexpage.xml b/testing/028/indexpage.xml index d508adb..c13e1b2 100644 --- a/testing/028/indexpage.xml +++ b/testing/028/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Here are some formulas:The distance between $(x_1,y_1)$ and $(x_2,y_2)$ is $\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$.Unnumbered formula: \[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \]Formula in different environment \begin{eqnarray*} g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ &=& 9.82066032\,\mbox{m/s}^2 \end{eqnarray*} diff --git a/testing/030/indexpage.xml b/testing/030/indexpage.xml index 62046d4..6731890 100644 --- a/testing/030/indexpage.xml +++ b/testing/030/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. <h1>Hello world</h1> More text. diff --git a/testing/031/indexpage.xml b/testing/031/indexpage.xml index a0297fa..3b3a2e3 100644 --- a/testing/031/indexpage.xml +++ b/testing/031/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. Doxygen logo diff --git a/testing/032/indexpage.xml b/testing/032/indexpage.xml index 3a25272..cbb93df 100644 --- a/testing/032/indexpage.xml +++ b/testing/032/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. voidmain(){Testt;t.example();} More text. voidmain(){Testt;t.example();} End. diff --git a/testing/033/indexpage.xml b/testing/033/indexpage.xml index 4b2f47d..652e5de 100644 --- a/testing/033/indexpage.xml +++ b/testing/033/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. More visible text. diff --git a/testing/034/indexpage.xml b/testing/034/indexpage.xml index e994666..0252b3c 100644 --- a/testing/034/indexpage.xml +++ b/testing/034/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. diff --git a/testing/038/indexpage.xml b/testing/038/indexpage.xml index 3657034..2258113 100644 --- a/testing/038/indexpage.xml +++ b/testing/038/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Text New line diff --git a/testing/043/another.xml b/testing/043/another.xml index f403e8f..2c2e61b 100644 --- a/testing/043/another.xml +++ b/testing/043/another.xml @@ -3,6 +3,8 @@ another Another Page + + Another page's text. diff --git a/testing/043/mypage.xml b/testing/043/mypage.xml index efb09c7..589df5b 100644 --- a/testing/043/mypage.xml +++ b/testing/043/mypage.xml @@ -4,7 +4,11 @@ mypage Page Title Another Page + + Page brief description. + + Page brief description. Text at page level. See Section Title. for more. Section Title. diff --git a/testing/043_page.dox b/testing/043_page.dox index 784f58d..096f998 100644 --- a/testing/043_page.dox +++ b/testing/043_page.dox @@ -2,6 +2,8 @@ // check: mypage.xml // check: another.xml /** \page mypage Page Title + * \brief Page brief description. + * * Text at page level. See \ref mysect for more. * \section mysect Section Title. * Text at section level. See \ref mysubsect for more. diff --git a/testing/045/indexpage.xml b/testing/045/indexpage.xml index 75de4ab..294ceb8 100644 --- a/testing/045/indexpage.xml +++ b/testing/045/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + diff --git a/testing/049/indexpage.xml b/testing/049/indexpage.xml index 461a174..f7cb48c 100644 --- a/testing/049/indexpage.xml +++ b/testing/049/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + A bubble sort algorithm First get the inputs for(i=0;i<n;i++){printf("Array[%d]=",i);scanf("%d",&arr[i]);}Then do the bubbling for(i=0;i<n;i++){for(j=0;j<n-i-1;j++){if(arr[j]>arr[j+1])//SwappingConditionisChecked{temp=arr[j];arr[j]=arr[j+1];arr[j+1]=temp;}}}Then write the result for(i=0;i<n;i++){printf("%4d",arr[i]);} diff --git a/testing/050/indexpage.xml b/testing/050/indexpage.xml index 73b6d4f..2f183fe 100644 --- a/testing/050/indexpage.xml +++ b/testing/050/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some normal text. A verbatim section with a /* C comment */ in it Showing a file as verbatim @book{knuth79, diff --git a/testing/051/indexpage.xml b/testing/051/indexpage.xml index 82c58cc..776f525 100644 --- a/testing/051/indexpage.xml +++ b/testing/051/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Dollar $ At @ Backslash \ Amphasand & Less < Greater > Hash # Percent % Quote " Dot . Double colon :: Pipe | Plus + Minus - diff --git a/testing/052/indexpage.xml b/testing/052/indexpage.xml index 792bee4..d952781 100644 --- a/testing/052/indexpage.xml +++ b/testing/052/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + This is English. Output for all languages. diff --git a/testing/053/indexpage.xml b/testing/053/indexpage.xml index 828fe96..211bb9a 100644 --- a/testing/053/indexpage.xml +++ b/testing/053/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Dit is Nederlands. Output for all languages. diff --git a/testing/055/md_055_markdown.xml b/testing/055/md_055_markdown.xml index 18df45b..4bdd2e2 100644 --- a/testing/055/md_055_markdown.xml +++ b/testing/055/md_055_markdown.xml @@ -3,6 +3,8 @@ md_055_markdown 055_markdown + + Foo diff --git a/testing/056/indexpage.xml b/testing/056/indexpage.xml index 8376a74..55240e9 100644 --- a/testing/056/indexpage.xml +++ b/testing/056/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + Some text. \section{Hello world} More text. diff --git a/testing/065/indexpage.xml b/testing/065/indexpage.xml index e462e55..09c7f8c 100644 --- a/testing/065/indexpage.xml +++ b/testing/065/indexpage.xml @@ -3,6 +3,8 @@ index My Project + + これは日本語(en)です. Output for all languages. -- cgit v0.12