templates.macros.ftm Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kurento-client Show documentation

Kurento Client The Kurento Client project allows server applications to control media server resources.

There is a newer version: 7.1.0

<#macro comment doc params=[] return={}>
/**
 *
    <#t><#if doc??>
        <#t><#list doc?split("\n") as x><#assign line = sphinxLinks(x) ><#rt>
			<#lt><#if (line != "") > * ${line}
			<#lt><#rt>
        <#lt><#rt>
    <#t><#rt>
    <#lt><#if (params?? && params?size > 0) >
 *
    <#lt><#rt>
    <#t><#list params as param>
<#lt> * @param ${param.name}
<#if param.doc??><#list param.doc?split("\n") as x><#rt>
 *       ${sphinxLinks(x)}
<#rt>
<#if return.doc??> * @return ${sphinxLinks(return.doc)}<#rt>
 *
 **/


<#macro comment_set_get doc type>
/**
 *
    <#lt><#assign first = true><#rt>
    <#t><#if doc??>
        <#t><#list doc?split("\n") as x><#assign line = sphinxLinks(x) ><#rt>
			<#lt><#if (line != "") >
				<#lt><#if (first) >
					<#lt><#if (line != "@deprecated") >
						<#lt> * ${type} ${line}
						<#lt><#assign first = false><#rt>
					<#else>
						<#lt> * ${line}
					<#lt><#rt>
				<#lt><#else> * ${line}
				<#lt><#rt>
			<#lt><#rt>
        <#lt><#rt>
    <#t><#rt>
 *
 **/