Changes between Version 6 and Version 7 of HeaderDoc

Timestamp:

Nov 5, 2009, 6:21:04 AM (14 years ago)

Author:

becoulet

Comment:

--

HeaderDoc

@@ -77 +77 @@
  * Do not forget to '''insert reference tags''' for each identifier and macro name, so that !MkDoc can generate an hyperlink. Not having a direct link is really frustrating for the reader. 
  * Remember that you can not count on other declarations proximity to make things obvious, contiguous things in the header '''may not be contiguous in the document'''.
- * Try to '''mark all internal declarations as such''', this will help sorting list with relevant items first, using the right style, and make things clear.
- * Remember you are not writing plain documentation but only small piece of sentences inserted in a large document.
+ * Try to '''mark all internal declarations as such''', this will help sorting lists with relevant items first, using the right style, and make things clear.
  * Consider the '''warning messages''' from !MkDoc and '''read carefully the output document''' to double check previous rules and see if everything is easily understandable and make sens.