Skip to content

Commit 05068bd

Browse files
author
Alice Pintus
committed
Updates reference terms with latest attributes, updated readme
1 parent aa09885 commit 05068bd

File tree

8 files changed

+74
-21
lines changed

8 files changed

+74
-21
lines changed

Language/Functions/Analog IO/analogWrite.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
:source-highlighter: pygments
2+
:pygments-style: arduino
3+
:ext-relative: adoc
4+
5+
16
= analogWrite()
27

38

@@ -21,8 +26,8 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
2126

2227
[float]
2328
=== Parameters
24-
`pin`: the pin to write to. +
25-
`value`: the duty cycle: between 0 (always off) and 255 (always on).
29+
`pin`: the pin to write to. Allowed data types: int. +
30+
`value`: the duty cycle: between 0 (always off) and 255 (always on). Allowed data types: int
2631

2732

2833
[float]
@@ -75,14 +80,14 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
7580
[float]
7681
=== See also
7782
[role="language"]
78-
* #LANGUAGE# http://arduino.cc/en/Reference/AnalogRead[analogRead()]
79-
* #LANGUAGE# http://arduino.cc/en/Reference/AnalogRead[analogRead()]
83+
* #LANGUAGE# link:analogRead{ext-relative}[analogRead()]
84+
* #LANGUAGE# link:analogWriteResolution{ext-relative}[analogWriteResolution()]
8085

8186
[role="definition"]
82-
* #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM]
87+
* #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM^]
8388

8489
[role="example"]
85-
* #EXAMPLE# http://arduino.cc/en/Tutorial/Blink[Blink]
90+
* #EXAMPLE# http://arduino.cc/en/Tutorial/Blink[Blink^]
8691

8792
--
8893
// HOW TO USE SECTION ENDS

Language/Functions/Communication/serial.adoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:source-highlighter: pygments
2+
:pygments-style: arduino
3+
:ext-relative: adoc
4+
15
= Serial()
26

37

@@ -59,15 +63,16 @@ http://arduino.cc[serialEvent()]
5963

6064
[float]
6165
=== See also
62-
[role="language"]
63-
* #LANGUAGE# http://arduino.cc/en/Reference/AnalogRead[analogRead()]
64-
* #LANGUAGE# http://arduino.cc/en/Reference/AnalogRead[analogRead()]
65-
66-
[role="definition"]
67-
* #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM]
6866

6967
[role="example"]
70-
* #EXAMPLE# http://arduino.cc/en/Tutorial/Blink[Blink]
68+
* #EXAMPLE# http://arduino.cc/en/Tutorial/ReadAsciiString[ReadAsciiString^]
69+
* #EXAMPLE# http://arduino.cc/en/Tutorial/ASCIITable[ASCII TAble^]
70+
* #EXAMPLE# http://arduino.cc/en/Tutorial/Dimmer[Dimmer^]
71+
* #EXAMPLE# http://arduino.cc/en/Tutorial/Graph[Graph^]
72+
* #EXAMPLE# http://arduino.cc/en/Tutorial/PhysicalPixel[Physical Pixel^]
73+
* #EXAMPLE# http://arduino.cc/en/Tutorial/SerialCallResponse[Serial Call Response^]
74+
* #EXAMPLE# http://arduino.cc/en/Tutorial/SerialCallResponseASCII[Serial Call Response ASCII^]
75+
7176

7277
--
7378
// SEEALSO SECTION ENDS

Language/Structure/Boolean Operators/&&.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:source-highlighter: pygments
2+
:pygments-style: arduino
3+
:ext-relative: adoc
4+
15
= && (and)
26

37

@@ -49,10 +53,10 @@ Make sure you don't mistake the boolean AND operator, && (double ampersand) for
4953
[float]
5054
=== See also
5155
[role="language"]
52-
* #LANGUAGE# http://arduino.cc/en/Reference/BitwiseAnd[&] (bitwise AND)
53-
* #LANGUAGE# http://arduino.cc/en/Reference/BitwiseAnd[|] (bitwise OR)
54-
* #LANGUAGE# http://arduino.cc/en/Reference/BitwiseXorNot[~] (bitwise NOT)
55-
* #LANGUAGE# http://arduino.cc/en/Reference/If[if]
56+
* #LANGUAGE# link:BitwiseAnd{ext-relative}[&^] (bitwise AND)
57+
* #LANGUAGE# link:BitwiseOr{ext-relative}[|^] (bitwise OR)
58+
* #LANGUAGE# link:BitwiseXorNot{ext-relative}[~^] (bitwise NOT)
59+
* #LANGUAGE# link:If{ext-relative}[if^]
5660

5761
--
5862
// HOW TO USE SECTION ENDS

Language/Structure/Further Syntax/CurlyBraces.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:source-highlighter: pygments
2+
:pygments-style: arduino
3+
:ext-relative: adoc
4+
15
= {} Curly Braces
26

37

@@ -95,5 +99,13 @@ else
9599
[%hardbreaks]
96100

97101

102+
[float]
103+
=== See also
104+
[role="language"]
105+
* #LANGUAGE# link:SemiColon{ext-relative}[;^] (semicolon)
106+
* #LANGUAGE# link:SingleComment{ext-relative}[//^] (single line comment)
107+
* #LANGUAGE# link:MultiComments{ext-relative}[/* */^] (multi-line comment)
108+
109+
98110
--
99111
// HOW TO USE SECTION ENDS

Language/Structure/Main/setup.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:source-highlighter: pygments
2+
:pygments-style: arduino
3+
:ext-relative: adoc
4+
15
= setup()
26

37

@@ -50,3 +54,8 @@ void loop()
5054

5155
--
5256
// HOW TO USE SECTION ENDS
57+
58+
[float]
59+
=== See also
60+
[role="language"]
61+
* #LANGUAGE# link:Loop{ext-relative}[loop^]

Language/Variables/Constants/high-low.adoc

Lines changed: 0 additions & 2 deletions
This file was deleted.

Language/Variables/Utilities/sizeof.adoc

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,25 @@ If you want to contribute to the Language Reference or edit existing content, yo
1616
Please note that every Reference file should include as least a Description, some Example Code, and links to other relevant infos (See Also section).
1717

1818
If you need to add images to the Asciidoc please create a folder called attachments in the same directory as the Asciidoc file. Images can be saved in SVG and PNG format, max size 200KB.
19+
20+
##Folder Structure
21+
```
22+
reference-en
23+
├─ AsciiDoc_sample
24+
│   ├── AsciiDoc_Dictionary
25+
│   │   ├── AsciiDoc_Template-Dictionary.adoc
26+
│   │   └── attachments
27+
│   └── Reference_Terms
28+
│   ├── AsciiDoc_Template-Parent_Of_Entities.adoc
29+
│     ├── AsciiDoc_Template-Single_Entity.adoc
30+
│     └── attachments
31+
├── Language
32+
│   ├── Functions
33+
│   ├── Structure
34+
│   └── Variables
35+
├── LICENCE.md
36+
└── README.md
37+
38+
```
39+
40+
Within the Language folder, the file tree follows the same structure as in the [Arduino Reference webpage](http://arduino.cc/en/Reference/HomePage).

0 commit comments

Comments
 (0)