Bug 383830 - [ast] The line break doesn't separate the short description and the long description in documentation
Summary: [ast] The line break doesn't separate the short description and the long desc...
Status: CLOSED INVALID
Alias: None
Product: LDT
Classification: Tools
Component: LuaDevelopmentTools (show other bugs)
Version: 0.8   Edit
Hardware: PC Linux
: P3 normal
Target Milestone: ---   Edit
Assignee: Kevin KIN-FOO CLA
QA Contact:
URL:
Whiteboard:
Keywords: bugday
Depends on:
Blocks:
 
Reported: 2012-06-28 13:15 EDT by Marc Aubry CLA
Modified: 2012-06-29 05:49 EDT (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Marc Aubry CLA 2012-06-28 13:15:39 EDT 
For example:
---
-- Field short description
-- Field long description
-- @module modulename

In the ast the short description is the string "Field short description\n Field long description" and the long description is empty.
The result expected is more like that: the short description should contains "Field short description" and the long description "Field long description".
Comment 1 Kevin KIN-FOO CLA 2012-06-29 05:49:36 EDT 
Hi,

Actually, it is normal that line break has no effect. The separators between short and long description are `.` and `?`.
Do not worry, we did not invent this convention on our own. It's from LDoc and LuaDoc before it.
	"All doc comments start with a summary sentence, that ends with a period or a question mark. An optional description may follow."
	https://github.com/stevedonovan/LDoc/blob/master/docs/doc.md#commenting-conventions .