You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Feb 9, 2018. It is now read-only.
Currently, there are only two "Examples" on developer.getnightingale.com. The in-file comments generating the examples are incorrect.
For example, sbIMetadataHandler.idl is listed as having an example.
The comment generating this example is here. Now if I go to look up getImageData, which is the function the example is for, there isn't any documentation.
The code for the two examples listed is all on one line (wrapping the page, though) as well. The problem is that the comments are using \example.
It seems like we should use \code and \endcode, or \verbatim and \endverbatim.
However, (I think) the examples would then be listed in the documentation for the function and not in a separate "Examples" section.
The alternative would be to separate out the example code into a new file, so that the \example command could be used correctly, with the file name argument.
The text was updated successfully, but these errors were encountered:
Currently, there are only two "Examples" on developer.getnightingale.com. The in-file comments generating the examples are incorrect.
For example, sbIMetadataHandler.idl is listed as having an example.
The comment generating this example is here. Now if I go to look up
getImageData
, which is the function the example is for, there isn't any documentation.The code for the two examples listed is all on one line (wrapping the page, though) as well. The problem is that the comments are using
\example
.It seems like we should use
\code
and\endcode
, or\verbatim
and\endverbatim
.However, (I think) the examples would then be listed in the documentation for the function and not in a separate "Examples" section.
The alternative would be to separate out the example code into a new file, so that the
\example
command could be used correctly, with the file name argument.The text was updated successfully, but these errors were encountered: