[Doxygen-users] Better formatting of enum ?

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Hi again,

I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
(right now mostly with TeXlive 2018 for compatibility by default, TL 
2020 installed to).

my 2nd problem/question:
I try to get better formatting for this  enum:

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

typedef enum {
     BML_API_OK,
     BML_API_ERROR = BML_API_ERROR_BASE,
     BML_API_NOT_INITIALIZED,
     BML_API_CMD_WAIT_TIMEOUT ,
     BML_API_INV_INPUT_PARAM,
     BML_API_CANNOT_RESET_TO_BOOTLOADER,
     BML_API_CANNOT_RESET_TO_FIRMWARE,
     BML_API_BUFF_SIZE_TOO_SMALL,
     BML_API_CANNOT_PROGRAM_INTERNAL_FLASH,
     BML_API_CANNOT_PROGRAM_EXTERNAL_FLASH,
     BML_API_UNKNOWN_FIRMWARE,
     BML_API_INVALID_FIRMWARE_SIGNATURE,
     BML_API_VERSION_NOT_SUPPORTED
} bml_api_error_t;

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

right now the LaTeX code looks like this with few (random?) \newline
and some lines which stuck way out of the page because those long symbols
are locked in \mbox{} and can't be wrapped around.

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum 
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7}{bml\+\_\+api\+\_\+error\+\_\+t}} 
\{ \newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a8c291c31524139bc0eef11048dd19470}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+OK}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ab2d7e5f7217c8774f14ff0696fefcf1b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+OR}} 
= B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+O\+R\+\_\+\+B\+A\+SE,
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7af9f7835e33297a6934712aea894c07ad}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+N\+O\+T\+\_\+\+I\+N\+I\+T\+I\+A\+L\+I\+Z\+ED}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a536d3800d21e7f060fd496c8c58f6de9}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+M\+D\+\_\+\+W\+A\+I\+T\+\_\+\+T\+I\+M\+E\+O\+UT}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ad6b598bebe15ea96cb0356c72e2891e7}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+\_\+\+I\+N\+P\+U\+T\+\_\+\+P\+A\+R\+AM}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a44cd19214f24d7f60a110cda79c18026}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+B\+O\+O\+T\+L\+O\+A\+D\+ER}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7afda9bf3acf456e6bfaaab278af31e354}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ade5f2bdcc4ff538a9b829b3db5dd603b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+B\+U\+F\+F\+\_\+\+S\+I\+Z\+E\+\_\+\+T\+O\+O\+\_\+\+S\+M\+A\+LL}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a01fea661a7f72616ce4266c93e76b020}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+I\+N\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae08b5ebe3f22c6cce643d25befe66a5f}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+E\+X\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ac7db5b16f2547ab5b6ba5be26eca73fa}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+U\+N\+K\+N\+O\+W\+N\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a13999d3062b08173736d61aac7012536}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+F\+I\+R\+M\+W\+A\+R\+E\+\_\+\+S\+I\+G\+N\+A\+T\+U\+RE}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae6cc4a6cb870bd8fe2feaede323961c5}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+\+N\+O\+T\+\_\+\+S\+U\+P\+P\+O\+R\+T\+ED}}
  \}
\end{DoxyCompactItemize}

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

I've been looking in doxygen sources, but can't find  the place where 
these extra \newline are generated,
and how to get rid of the \mbox{} *only* around those hyperlinks in 
(only this?) enum, asuming that those
\mbox might be helpful and necessary in other places (it's output in 
LatexGenerator::writeObjectLink() which is a pretty generic function).

so right now I'm again using sed to change that TeX code which now looks 
*much* nicer in the PDF output (and nothing's chopped off anymore;)
without the \newline for every entry (just removing \mbox) it's not 
working good either:

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

sed -i -e '/^\\newline$/d' -e 's/\\newline//'  -e 
's/^\\mbox{\\hyperlink{/\\newline\\mbox{\\hyperlink{/' 
bml__api__error_8h.tex

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum 
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7}{bml\+\_\+api\+\_\+error\+\_\+t}} 
\{
\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a8c291c31524139bc0eef11048dd19470}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+OK}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ab2d7e5f7217c8774f14ff0696fefcf1b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+OR}} 
= B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+O\+R\+\_\+\+B\+A\+SE,
\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7af9f7835e33297a6934712aea894c07ad}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+N\+O\+T\+\_\+\+I\+N\+I\+T\+I\+A\+L\+I\+Z\+ED}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a536d3800d21e7f060fd496c8c58f6de9}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+M\+D\+\_\+\+W\+A\+I\+T\+\_\+\+T\+I\+M\+E\+O\+UT}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ad6b598bebe15ea96cb0356c72e2891e7}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+\_\+\+I\+N\+P\+U\+T\+\_\+\+P\+A\+R\+AM}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a44cd19214f24d7f60a110cda79c18026}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+B\+O\+O\+T\+L\+O\+A\+D\+ER}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7afda9bf3acf456e6bfaaab278af31e354}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ade5f2bdcc4ff538a9b829b3db5dd603b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+B\+U\+F\+F\+\_\+\+S\+I\+Z\+E\+\_\+\+T\+O\+O\+\_\+\+S\+M\+A\+LL}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a01fea661a7f72616ce4266c93e76b020}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+I\+N\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae08b5ebe3f22c6cce643d25befe66a5f}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+E\+X\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ac7db5b16f2547ab5b6ba5be26eca73fa}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+U\+N\+K\+N\+O\+W\+N\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a13999d3062b08173736d61aac7012536}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+F\+I\+R\+M\+W\+A\+R\+E\+\_\+\+S\+I\+G\+N\+A\+T\+U\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae6cc4a6cb870bd8fe2feaede323961c5}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+\+N\+O\+T\+\_\+\+S\+U\+P\+P\+O\+R\+T\+ED}}
  \}
\end{DoxyCompactItemize}

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

again: there must be a better (non-sed) "doxygen way" to achieve this??

thanks,

Harald

-- 
Mit freundlichen Grüßen / Best regards
*Harald König *
Engineering Optical Systems (BST/EOS2)
Bosch Sensortec GmbH | Gerhard-Kindler-Straße 9 | 72770 Reutlingen | 
GERMANY | _www.bosch-sensortec.com_ <http://www.bosch-sensortec.com>
Tel. +49 7121 35-38606 | Fax +49 711 8115140583 | 
_Harald.Koenig2@bosch-sensortec.com_ 
<mailto:Har...@bo...>
Sitz: Kusterdingen, Registergericht: Stuttgart HRB 382674,
Ust.IdNr. DE 183276693 - Steuer-Nr. 99012/08040
Geschäftsführung: Stefan Finkbeiner, Jens-Knut Fabrowsky