I am new to ND and I try to document Oracle PL/SQL code. As a testcase I documented one function with the ND-syntax. The result is that I get some documentation in which everythings seams global. I would like to group all objects of a function within that function. Is this possible with ND?
Thanks aforehand.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'm not sure how the Oracle system works, so bear with me.
Do you mean you want the objects in the function's scope, as in you link to them as FunctionName.ObjectName? If so, it depends on how you need to document the objects.
If you want to document them like classes, where you document each of their members with its own topic, there's nothing you can do other than documenting them as FunctionName.ObjectName instead of just ObjectName.
If you want to document them like variables, where there's only one entry for everything, that's different. By editing Topics.txt you can set "Scope: Start" for the Function topic type, which will cause everything after it to appear under its scope like how it works for classes. So:
-- Function: FunctionName
-- Object: ObjectName
will have ObjectName automatically interpreted as FunctionName.ObjectName. You can get details on editing Topics.txt here:
Dear Greg,
I am new to ND and I try to document Oracle PL/SQL code. As a testcase I documented one function with the ND-syntax. The result is that I get some documentation in which everythings seams global. I would like to group all objects of a function within that function. Is this possible with ND?
Thanks aforehand.
I'm not sure how the Oracle system works, so bear with me.
Do you mean you want the objects in the function's scope, as in you link to them as FunctionName.ObjectName? If so, it depends on how you need to document the objects.
If you want to document them like classes, where you document each of their members with its own topic, there's nothing you can do other than documenting them as FunctionName.ObjectName instead of just ObjectName.
If you want to document them like variables, where there's only one entry for everything, that's different. By editing Topics.txt you can set "Scope: Start" for the Function topic type, which will cause everything after it to appear under its scope like how it works for classes. So:
-- Function: FunctionName
-- Object: ObjectName
will have ObjectName automatically interpreted as FunctionName.ObjectName. You can get details on editing Topics.txt here:
http://www.naturaldocs.org/customizingtopics.html
Thanks for your reply. I'm going to try things out.
So, I wish you already a happy newyear!