使用HTML制作干净的Doxygen ALIAS

Question

我有一个使用HTML的Doxygen ALIAS代码（通过@htmlonly），为了显示youtube视频，允许我简单地写入（“。markdown”） - 文件：

Youtube链接：

https://www.youtube.com/watch?v=**CODE**

使用ALIAS：

@youtube{**CODE**}

没有ALIAS：

@htmlonly

<div align="center">
<iframe
    title="my title" width="560" height="349"
    src="http://www.youtube.com/embed/**CODE**?rel=0&loop=1"
    frameborder="0" allowfullscreen align="middle">
</iframe>
</div>

@endhtmlonly

通过将以下ALIAS添加到Doxyfile：

ALIASES               += youtube{1}="@htmlonly<div align='center'><iframe title='my title' width='560' height='349' src='http://www.youtube.com/embed/\1?rel=0&loop=1' frameborder='0' allowfullscreen align='middle'></iframe></div>@endhtmlonly"

我的问题是，从上面可以看到的宏是巨大的，看起来真的很混乱！

问题：

1. 有没有办法让它看起来干净？
2. 我应该怎么做更大的HTML原始代码？
3. 我应该使用ALIAS的任何其他Doxygen替代品吗？

Answer 1

我设法搞清楚了。

代替：

ALIASES               += youtube{1}="@htmlonly<div align='center'><iframe title='my title' width='560' height='349' src='http://www.youtube.com/embed/\1?rel=0&loop=1' frameborder='0' allowfullscreen align='middle'></iframe></div>@endhtmlonly"

我可以用：

@youtube {link}，包含：

ALIASES+=addyoutube{1}="@htmlonly</p><div class='addYoutube'>\1</div>@endhtmlonly"
ALIASES+=youtube{1}="@addyoutube{\1} @htmlinclude add_youtube.html"

EXAMPLE_PATH          += @CMAKE_CURRENT_SOURCE_DIR@/add_youtube.html

并在当前目录add_youtube.html中的文件中添加以下javascript代码：

<script type="text/javascript">

var $getDiv = $('div.addYoutube').last();

var filmId = $getDiv.html()
filmId = filmId.replace("https://","")
filmId = filmId.replace("www.","")
filmId = filmId.replace("youtube.com/watch?v=","")

document.write("<div align='center'><iframe title='my title' width='560' height='349' src='http://www.youtube.com/embed/"+filmId+"?rel=0&loop=1' frameborder='0' allowfullscreen align='middle'> </iframe> </div>");
$getDiv.remove()
</script>

Answer 2

派对有点迟到，但在Doxygen 1.8.12中，可以创建一些doxygen标签@brief和HTML元素的组合。 当您为HTML元素定义属性时，可以使用撇号class='someClass'，或者也可以使用带有反斜杠class=\"someClass\"的引号。 要缩进html，请使用带有反斜杠符号\的字符串concantenation。

ALIASES +=               "briefWithImage{3} = @brief \
                            @htmlonly \
                                <span><img class='imgBriefImage' src='\1' alt='\1'></span> \
                                </span><span class='spanBriefText'>\2(<b>\3</b>)</span> \
                            @endhtmlonly"  

我不确定别名的替代品。一种方法是为每个页面定义自定义HTML标头，并在加载页面时 - 使用自定义JS函数替换您自己的占位符。