<p><a href="https://gerrit.osmocom.org/12384">View Change</a></p><p>1 comment:</p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0;"><p><a href="https://gerrit.osmocom.org/#/c/12384/1/include/osmocom/core/fsm.h">File include/osmocom/core/fsm.h:</a></p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.osmocom.org/#/c/12384/1/include/osmocom/core/fsm.h@123">Patch Set #1, Line 123:</a> <code style="font-family:monospace,monospace">osmo_fsm_inst</code></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">I still think as long as we use asciidoc, we should use it properly ;)</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">I checked and in fact I am using it properly. If you verify the generated doxygen HTML, you will see that with this doc text, there already is a working cross link to struct osmo_fsm_inst.</p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">- see doxygen doc for '\ref': "Creates a reference to a named section, subsection, page or anchor."<br>  \ref actually isn't about referencing documented data structures or functions!<br>  http://www.doxygen.nl/manual/commands.html#cmdref</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">- see doc for \a: "Displays the argument <word> in italics."<br>  \a is merely cosmetic, it doesn't affect cross referencing.<br>  http://www.doxygen.nl/manual/commands.html#cmda</pre><p style="white-space: pre-wrap; word-wrap: break-word;">(Notice also that there are misleading cross references. For example, the 'level' arg of this macro references the uint8_t level, member of struct gsmtap_osmocore_log_hdr.)</p><p style="white-space: pre-wrap; word-wrap: break-word;">The bottom line is that in my opinion we should remove all '\a' and '\ref' from cross references to functions and structs. Only references to pages or subsections should remain.</p></li></ul></li></ul><p>To view, visit <a href="https://gerrit.osmocom.org/12384">change 12384</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/12384"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: comment </div>
<div style="display:none"> Gerrit-Change-Id: I3bf6500889aa58195f50a726dec0876c0c2baec3 </div>
<div style="display:none"> Gerrit-Change-Number: 12384 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Vadim Yanitskiy <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Comment-Date: Wed, 02 Jan 2019 23:29:17 +0000 </div>
<div style="display:none"> Gerrit-HasComments: Yes </div>
<div style="display:none"> Gerrit-HasLabels: No </div>