shekharpro / mb-unit

Automatically exported from code.google.com/p/mb-unit
0 stars 0 forks source link

Review and fix XML doc structure #467

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
It seems that the structure of the XML doc is not consistent across all 
the documented types:

- The "summary" element is sometines too long, or contains several 
paragraphs, or a code example, while it should only contain a short 
descriptive text. 
- The "remarks" element is sometimes included into the "summary" element, 
while it should be located at the same level.
- The example is not formatted consistently (<code> + CDATA)
etc.

I will try to review and fix some of the documented types (MbUnit first, 
as it is the most visible API, I guess)

Original issue reported on code.google.com by Yann.Tre...@gmail.com on 2 Jun 2009 at 6:34

GoogleCodeExporter commented 8 years ago
Thanks Yann!

Original comment by jeff.br...@gmail.com on 2 Jun 2009 at 8:06

GoogleCodeExporter commented 8 years ago

Original comment by jeff.br...@gmail.com on 29 Jun 2009 at 8:33

GoogleCodeExporter commented 8 years ago
The work in progress looks really good!

Is there any more work to be done here or can we close the issue?

Original comment by jeff.br...@gmail.com on 18 Jul 2009 at 5:17

GoogleCodeExporter commented 8 years ago
It's going to be completed before the end of the week.
I will close the item myself once done.

Original comment by Yann.Tre...@gmail.com on 20 Jul 2009 at 7:53

GoogleCodeExporter commented 8 years ago
Done and done.

Original comment by Yann.Tre...@gmail.com on 23 Jul 2009 at 8:16