In Library Manager, when I select this function and go to the "Documentation" tab, I do get the comments, but they're all in one line with no line breaks.
(========== line 1 line 2 line 3 line 4 ==========)
I've looked at other compiled libraries, and they have the documentation on separate lines, but I can't see the source.
How do I insert a line break? This seems like I'm missing something very obvious
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I've read through all the help files on reStructuredText, added the property to the library, but nothing seems to make a difference. I wonder if it's something to do with Schneider Machine Expert.
This guy seemed to have the same problem, https://forge.codesys.com/forge/talk/Engineering/thread/cfdb933870/ but that was last updated in 2013. Machine Expert uses Codesys 3.5.12.80.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
It turns out I had to do a couple things:
I had added DocFormat: reStructuredText to Project Information/Properties, but I had to remove the library from my project and re-add it before it started generating documentation
"| " generates a new line, but it needs to have a space after it
👍
1
Last edit: tvm 2020-03-04
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I create a function block in a library, with some comments in the declaration header
In Library Manager, when I select this function and go to the "Documentation" tab, I do get the comments, but they're all in one line with no line breaks.
(========== line 1 line 2 line 3 line 4 ==========)
I've looked at other compiled libraries, and they have the documentation on separate lines, but I can't see the source.
How do I insert a line break? This seems like I'm missing something very obvious
more posts ...
Hi,
I think you should do something like this:
This is a nice online tool to test reStructured text:
http://rst.ninjs.org/
Ciao!
thanks for the reply, but this does not work
I think you're missing something...I did a test and it works!
https://help.codesys.com/webapp/checkli ... n=3.5.15.0
This is the checklist which has a check for "The Property “DocFormat” has been set to the value “reStructuredText”."
Among other things.
Then make sure you check POUs, then install to lib repository.
I've read through all the help files on reStructuredText, added the property to the library, but nothing seems to make a difference. I wonder if it's something to do with Schneider Machine Expert.
This guy seemed to have the same problem, https://forge.codesys.com/forge/talk/Engineering/thread/cfdb933870/ but that was last updated in 2013. Machine Expert uses Codesys 3.5.12.80.
Try placing a blank line between. Blank line is recognized in reST as a paragraph break.
It turns out I had to do a couple things:
I had added DocFormat: reStructuredText to Project Information/Properties, but I had to remove the library from my project and re-add it before it started generating documentation
"| " generates a new line, but it needs to have a space after it
Last edit: tvm 2020-03-04
Using < br > did it for me in CODESYS 3.5.19
shows up in Library Manager with line breaks.
Last edit: voffi 2023-12-07