Skip to content

Commit 75e0ac4

Browse files
author
jantje
committed
Added some documentation
1 parent 79ae921 commit 75e0ac4

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

io.sloeber.core/src/io/sloeber/core/api/BoardsManager.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,17 @@ public static boolean isReady() {
167167
return Manager.isReady();
168168
}
169169

170+
/**
171+
* find all examples for this type of board. That is the examples provided
172+
* by Arduino The examples provided by the common libraries The examples
173+
* provided by the private libraries The examples provided by the platform
174+
* the board belongs to
175+
*
176+
* If the boardID is null there will be no platform examples
177+
*
178+
* @param boardID
179+
* @return
180+
*/
170181
public static TreeMap<String, IPath> getAllExamples(BoardDescriptor boardID) {
171182
TreeMap<String, IPath> examples = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
172183
// Get the examples of the library manager installed libraries

0 commit comments

Comments
 (0)