Differences

This shows you the differences between two versions of the page.

--- arduino:code_completion [2015/10/29 13:51] – mithat
+++ arduino:code_completion [2017/04/22 01:30] (current) – [Directories to include by default] mithat
@@ Line 1: / Line 1: @@
 ====== Arduino Code Completion Directories ======
 ===== The directories =====
+==== How to use these lists ====
+  * If your IDE lets you configure custom toolsets and you've configured an Arduino toolset, you can add the directories to the Arduino toolset's list of directories checked for code completion if it lets you.((This is the approach I use with [[https://netbeans.org|NetBeans]].))
+  * If your IDE is organized around workspaces and you use separate workspaces for Arduino development, add these to the list of the workspace's additional directories to check for code completion.((This works well with [[http://codelite.org/|CodeLite]] for me.))
+  * If you use your IDE onlyfor Arduino development, you can add the list to your IDE's global list of of additional directories for code completion---which means the directories will be parsed for //every// project, not just Arduino ones.
+  * Most IDEs let you add a list of additional directories to check for code completion to the IDE's project. This is the approach you'll want to take for adding project-specific libraries. If you take this approach for default libraries (or if it's your only option), then you'll have to repeat this for every Arduino project you create.
 ==== Directories to include by default ====
-The following is a list of known directories to add to your IDE for effective code completion using AVR-based Arduinos (version 1.6.5).
+The following is a list of known directories to add to your IDE for effective code completion using AVR-based Arduinos (version 1.6.*).
 <code>
 {path-to-arduino}/hardware/arduino/avr/cores/arduino/
 {path-to-arduino}/hardware/arduino/avr/libraries/EEPROM/
+{path-to-arduino}/hardware/arduino/avr/libraries/HID/
 {path-to-arduino}/hardware/arduino/avr/libraries/SPI/
 {path-to-arduino}/hardware/arduino/avr/libraries/SoftwareSerial/
@@ Line 17: / Line 23: @@
 {path-to-arduino}/hardware/tools/avr/avr/include/compat/
 {path-to-arduino}/hardware/tools/avr/avr/include/util/
-{path-to-arduino}/hardware/tools/avr/lib/gcc/avr/4.8.1/include/
+{path-to-arduino}/hardware/tools/avr/lib/gcc/avr/4.*.*/include/
-{path-to-arduino}/hardware/tools/avr/lib/gcc/avr/4.8.1/include-fixed/
+{path-to-arduino}/hardware/tools/avr/lib/gcc/avr/4.*.*/include-fixed/
 </code>
-With this list, you'll want to do one of the following:
-  * If your IDE lets you configure custom toolsets and you've configured an Arduino toolset, add the directories to the Arduino toolset's list of directories checked for code completion if it lets you.((This is how I do it with [[https://netbeans.org|NetBeans]].))
-  * If your IDE is workspace based and you use separate workspaces for Arduino development, add these to the list of the workspace's additional directories to check for code completion.((This works well with [[http://codelite.org/|CodeLite]] for me.))
-  * Add the list to your IDE's global list of of additional directories for code completion---which means the directories will be parsed for //every// project, not just Arduino ones.
-  * Add the list to the IDE project's list of additional directories for code completion. If you take this approach (or if it's your only option), then you'll have to repeat this for every Arduino project you start.
 ==== Including official libraries ====
-You should add any of the following official libraries your project uses to the IDE project's list of additional directories for code completion:
+Add any of the following libraries that ship with Ardunio to your IDE project's list of additional directories for code completion only if your project uses the library:
 <code>
-/home/mithat/opt/arduino/libraries/Bridge/src/
 {path-to-arduino}/libraries/Bridge/src/
 {path-to-arduino}/libraries/Esplora/src/
@@ Line 54: / Line 53: @@
 ==== Including third-party libraries ====
-In addition to the above, you should add any libraries you've downloaded into your `{Arduino-install-directory}/libraries` and used by your project to the IDE project's list of additional directories for code completion. These will typically be of the form:
+In addition to the above, you should add any libraries you've downloaded into your ''{Arduino-install-directory}/libraries'' and used by your project to the IDE project's list of additional directories for code completion. These will typically be of the form:
 <code>
 ../libraries/{name-of-library}
 </code>