search

LabVIEW-DCAF / StandardEngine

The Standard Execution Engine plugin for DCAF.
http://forums.ni.com/t5/Distributed-Control-Automation/Standard-Engine-Documentation/gpm-p/3539201
7 stars 3 forks source link

Engine needs more documentation #36

Closed becega closed 8 years ago

becega commented 9 years ago

There is no documentation on the engine or in the VIs on the engine. WHne Chriss was trying to understand how the engine worked he mentioned there is no documentation on it. @Beazurt

Beazurt commented 9 years ago

I added VI documentation to the standard engine VI and most of its most important subVIs. I wouldn't say the documentation is excellent yet, so I will leave this issue open, but I think it is in a much better spot now.

smithed commented 9 years ago

now needs even more

smithed commented 9 years ago

@Beazurt "More comments in the engine code. We are recommending this to advanced users. Advanced users want to look at the code to understand what it does. Doesn't need to be perfect or super detailed, but just add some comments to help people navigate the engine."

Beazurt commented 9 years ago

Just made another pass. Most VIs now have their VI documentation updated to reflect the new behavior (no more wrong documentation!). I also added some breadcrumbs to help lead people from the open function to where most of the execution code actually occurs. Still not good enough to close this, but I feel better about it.

smithed commented 9 years ago

yay