Author: sebastien.lelong
Date: Sat Oct 11 01:27:20 2008
New Revision: 383
Modified:
wiki/JallibStyleGuide.wiki
Log:
pin name convention
Modified: wiki/JallibStyleGuide.wiki
==============================================================================
--- wiki/JallibStyleGuide.wiki (original)
+++ wiki/JallibStyleGuide.wiki Sat Oct 11 01:27:20 2008
@@ -113,6 +113,17 @@
Now, how do you know which to follow ? Ask, we'll discuss...
+=== Pin names ===
+
+The pins are named as:
+
+ * *`<device>_<external_pin_name>`* if you want to avoid namespace
collision
+ * *`<function>_<external_pin_name>`* if you want to have a common API
+
+This is almost the same as for variables, contants, ... except the
`<whatever>` part now corresponds the pin name of the external device
(usually found in datasheets). Using the `<function>_<external_pin_name>`
convention to build a common API may cause problems, if pin names aren't
named the same in all supported devices. In that case, the pin name should
be as explicit as possible...
+
+_See also the very important rules about pin names within a
library: "Don't use port and pin names"_
+
=== Why such a pain ?... ===
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---