Timeline for How to document a custom library in Arduino
Current License: CC BY-SA 4.0
16 events
when toggle format | what | by | license | comment | |
---|---|---|---|---|---|
Nov 13, 2019 at 13:19 | comment | added | Juraj♦ | I can't change how IDE works | |
Nov 13, 2019 at 13:04 | comment | added | LukasFun | I just found out something very interesting. When writing the keywords from my library in the IDE just by themselves or in the form something.keyword it works as intended. But if I write them in the form Library::keyword (as is done with static things from the library) the keyword is highlighted but the function to find it in the reference does no longer work. Why is this and how do you fix this? | |
Nov 11, 2019 at 18:29 | comment | added | Juraj♦ | github.com/jandrassy/lab/tree/master/Foo | |
Nov 11, 2019 at 17:34 | comment | added | LukasFun | This library works. What do I have to do for my own library to work like this? Could you please provide a minimal example for a custom library? | |
Nov 11, 2019 at 17:18 | comment | added | Juraj♦ | the library is WiFiEspAT (in Library Manager), but I published it without keywords.txt. To test this answer I copied keywords.txt from Arduino WiFi library and added a line for beginAP which doesn't exist in Arduino WiFi library. and I added the reference file to the Reference folder | |
Nov 11, 2019 at 17:03 | comment | added | Juraj♦ | here it works. as soon as I put the third field in keyword.txt the "Find in reference" is enabled even if the file name is not valid. Now I see, that the text cursor must be on the word too. | |
Nov 11, 2019 at 14:40 | comment | added | Juraj♦ | do you have the keywords.txt file in the library folder next to library.properties? does your library match the 1.5 library specification? | |
Nov 11, 2019 at 14:32 | history | edited | Juraj♦ | CC BY-SA 4.0 |
added 8 characters in body
|
Nov 11, 2019 at 14:30 | comment | added | Juraj♦ | sorry, the file must be in C:\Program Files (x86)\Arduino\reference\www.arduino.cc\en\Reference | |
Nov 11, 2019 at 14:17 | comment | added | Juraj♦ | the keywords.txt must use tabs to separate the fields. did you restart IDE? | |
Nov 11, 2019 at 13:23 | comment | added | Juraj♦ | the reference names in keyword.txt are names of html files located somewhere in reference folder | |
Nov 11, 2019 at 13:22 | history | edited | Juraj♦ | CC BY-SA 4.0 |
added 86 characters in body
|
Nov 11, 2019 at 12:51 | comment | added | Juraj♦ | I updated the answer | |
Nov 11, 2019 at 12:50 | history | edited | Juraj♦ | CC BY-SA 4.0 |
added 272 characters in body
|
Nov 11, 2019 at 11:05 | comment | added | Juraj♦ | the answer is that it is not possible | |
Nov 7, 2019 at 17:11 | history | answered | Juraj♦ | CC BY-SA 4.0 |