Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 383871 - [luadocumentor] @usage is not generated correctly
Summary: [luadocumentor] @usage is not generated correctly
Status: RESOLVED FIXED
Alias: None
Product: LDT
Classification: Tools
Component: LuaDevelopmentTools (show other bugs)
Version: 0.8   Edit
Hardware: PC Linux
: P3 normal
Target Milestone: 0.9 M1   Edit
Assignee: Marc Aubry CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-06-29 05:44 EDT by Marc Aubry CLA
Modified: 2012-07-13 10:25 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-29 05:44:40 EDT
The @usage doesn't have the same behavior in module, function and type.

For example the line :
@usage local code

Should generate:
<h3>Usage:</h3>
<pre class="example"><code>local code</code></pre>

And the two lines:
@usage local code
@usage other local code

Should generate:
<h3>Usages:</h3>
<ul>
    <li><pre class="example"><code>local code</code></pre></li>
    <li><pre class="example"><code>other local code</code></pre></li>
</ul>

But currently in a module the notation :
---
-- @function [parent=#modulename] functionname
-- @usage local code
return nil

generate :
<h3>Usage:</h3>
  <ul>
     <pre class="example">local code</pre>
  </ul>
Witch is not a valid HTML code.
Comment 1 Simon Bernard CLA 2012-07-13 10:25:01 EDT
Fixed in HEAD : b84f91c3dba6e0d1cffb6cd6b46668bdca2332cb