Bug 383650 - [luadocumentor] The HTML result contains useless tags
Summary: [luadocumentor] The HTML result contains useless tags
Status: RESOLVED FIXED
Alias: None
Product: LDT
Classification: Tools
Component: LuaDevelopmentTools (show other bugs)
Version: 0.8   Edit
Hardware: PC Linux
: P3 minor
Target Milestone: 0.9 M1   Edit
Assignee: Marc Aubry CLA
QA Contact:
URL:
Whiteboard:
Keywords: bugday
Depends on:
Blocks:
 
Reported: 2012-06-27 10:21 EDT by Marc Aubry CLA
Modified: 2012-07-02 08:20 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Marc Aubry CLA 2012-06-27 10:21:20 EDT
For example the type description with any short or long description like this:
---
-- @type typename

The generated html will be:
			
<h2>Type <code>typename</code></h2>
<p>
</p>
<p>
</p>

The first <p> usually contains the short description and the second one the long description, but in this case, there are no descriptions at all.

The empty <p> tags are useless and can add blank space in the browser (depend of the browser). Theses p tags may be removed when empty.

It the same way, when a function is declared without any description the html generated is :
<h3>Field(s)</h3>
<dl class="function">
	<dt>
		<a id="#(modulename).functionname" >
			<strong>modulename.functionname()</strong>
		</a>
	</dt>
        <dd>

        <br />  

	</dd>
</dl>

Where the <br/> tag is useless and can be removed.
Comment 1 Marc Aubry CLA 2012-07-02 06:24:44 EDT
An useless <br/> tag can be seen when a module doesn't have a long description.
Useless <p> tags can be also seen when a function have more than one @return without type and description.
Comment 2 Simon Bernard CLA 2012-07-02 08:20:59 EDT
fixed in HEAD : a14d5303edc63353373af1e9c30538641f811232