Author: sebastien.lelong
Date: Thu Oct  9 09:52:54 2008
New Revision: 378

Modified:
    wiki/JallibStyleGuide.wiki

Log:
How to create a new paragraph within a multiline field

Modified: wiki/JallibStyleGuide.wiki
==============================================================================
--- wiki/JallibStyleGuide.wiki  (original)
+++ wiki/JallibStyleGuide.wiki  Thu Oct  9 09:52:54 2008
@@ -1,5 +1,5 @@
  #summary jallib style guide, a recipe to write a standard jalv2 library
-#labels Phase-Implementation
+#labels Phase-Implementation,Featured

  The *jallib style guide* defines the standards used to write jalv2 code.

@@ -54,6 +54,7 @@
  -- because the baudrate depending registers are calculated by this unit.
  -- Baudrate is calculated, starting at the high baudrate flag,
  -- which will ensure the highest possible accuracy.
+-- --
  -- SPI routines are setup for more SPI-devices,
  -- in which case CS should be controled outside this unit.
  --
@@ -63,6 +64,8 @@
  --
  }}}

+Note: if you need to create a new paragraph within a multiline field, use  
the "--" special chars. See example in Description field: "SPI  
routines ..." is part of the Description field, but visually seperated from  
the beginning of the field content.
+
  In the `/tools` directory, you'll find a `jsg_validator.py`. You can  
(must) use it to make sure your jal files are JSG compliant. This script  
will help you to identify problems:

  Ex:
@@ -281,4 +284,4 @@
  == Comment your code ==

  It helps readers understand what's going on.
-The comment should describe *why* your code does its thing, not what is  
does. That should be obvious from the code itself.
+The comment should describe *why* your code does its thing, not what is  
does. That should be obvious from the code itself.
\ No newline at end of file

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"jallib" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/jallib?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to