Documentation generation tool

I have been looking for a tool to keep track of function references, code documentation.... very much like PHP documentation site. The way you can have a function and show its parameters and return value, examples, changes over time and versions.
Does anybody know a tool to do this?
Last edited by KBM (2011-05-23 22:27:14)

Thank you very much ewaller... I had been there before but thought all they did was put some nice comments in the code to help you know what was there.... Now I see what the nice comments are for
So far I'm thinking about trying ROBODoc
You don't need to be dissapointed about the up-and-coming youngsters not planning on documenting things... I am looking for this because it is of GREAT help when the teams grow up and the project lives beyond a couple versions, so I guess we all like having things documented (or at least I like to think so). I just hope we all like (or at least spend time) documenting too ...
Again, thank you very much... I'll let you know (soon enough) what tool I found most useful

Similar Messages

  • Are report generation tools exclusively text-based?

    Hi,
    I'm using LabView 5.1.1, and have just explored the new (to me) report
    generation tools. Handy though they are (I added the facility to print
    results from my project in a nicely formatted report in just a couple of
    hours) it strikes me that it would be even better if I could add bitmaps
    to the report. This would let me add pretty logos, but obviously we
    could do far more using LabView pictures/graphs etc.
    There is no reference in the documentation or on the NI web site as far
    as I can tell, but I can't be the first programmer wanting to do this.
    Any hacks out there?
    Best wishes to you all,
    Allan Green
    Medical Physics and Clinical Engineering,
    Queen Elizabeth Hospital Edgbaston Birmingha
    m UK
    ==================================================================
    My views and opinions are seldom that of the institution for which
    I work. I take that to be a healthy sign.
    ==================================================================

    I too have tried to use the report functions. They work fine for text only.
    In the end I ended up scraping the idea and simply configured a vi (which i
    called report.vi) to print at completion. I set the vi up with tables and
    bitmaps the way i wanted it and called it as a sub vi (passing the data i
    wanted printed to it) whenever i wanted a report printed.
    It works really well. The only problem is that it must always be strictly
    to a given format as defined in your vi.
    I suppose you could hide some controls using attribute nodes (and maybe
    enable others) if you didn't want them printed.
    Cheers
    John
    Reinis Kanders wrote in message
    news:[email protected]...
    > On windows I have had success with using HiQ for report generation. I
    > would manually create a template for a
    > particular project, then send data using LV VI's to that template then
    save
    > it with different name or just print it.
    > Using HiQ (free with LV 5.1) I was able to have pictures, graphs, you name
    > it. Also since HiQ gets the actual data, then by saving HiQ file you do
    > data logging as well, those HiQ reports can also be stored in database.
    > I found HiQ approach to be more flexible than NI report generator,
    only
    > drawback is that it is not cross-platform portable. For cross-platform
    > report generation I have been looking into some sort of XML based
    approach.
    >
    > Hope it helps,
    >
    > Reinis Kanders
    >
    > "Allan Green" wrote in message
    > [email protected]...
    > > Hi,
    > >
    > > I'm using LabView 5.1.1, and have just explored the new (to me) report
    > > generation tools. Handy though they are (I added the facility to print
    > > results from my project in a nicely formatted report in just a couple of
    > > hours) it strikes me that it would be even better if I could add bitmaps
    > > to the report. This would let me add pretty logos, but obviously we
    > > could do far more using LabView pictures/graphs etc.
    > >
    > > There is no reference in the documentation or on the NI web site as far
    > > as I can tell, but I can't be the first programmer wanting to do this.
    > > Any hacks out there?
    > >
    > > Best wishes to you all,
    > >
    > > Allan Green
    > > Medical Physics and Clinical Engineering,
    > > Queen Elizabeth Hospital Edgbaston Birmingham UK
    > >
    > > ==================================================================
    > > My views and opinions are seldom that of the institution for which
    > > I work. I take that to be a healthy sign.
    > > ==================================================================
    > >
    > >
    >
    >
    >
    >
    > -----= Posted via Newsfeeds.Com, Uncensored Usenet News =-----
    > http://www.newsfeeds.com - The #1 Newsgroup Service in the World!
    > -----== Over 80,000 Newsgroups - 16 Different Servers! =-----

  • Help: MAM 3.0 UI Generation Tool (JSP Generation)

    Hi folks!
    I need your help. I'm getting started with developing in xMAM 3.0.
    I've read through OKP Learning Maps and MAM Enhancement Guides.
    I've found in every documentation that I've to use the MAM UI Generation Tool.
    Now i tried an get a lot of error codes.
    Can everyone help me? I didn't found any guide to this topic.
    I've to know the right usage of this tool.
    Thanks in advice.
    Best Regards
    Matthias

    Hi Matthias,
    MAM3.0 has two distinctive versions: PDA and laptop.
    If you project is to do enhancements for PDA version you don't need JSP Generator tool.
    If you need to enhance laptop version: you still have a choice - either to modify standard pages manually and/or write your own JSPs or use the tool to genearate modified or new pages.
    generation is obvioulsy easier so JSP Generator can be handy.
    There is a document which is called MBS_MAM_30_Generator_Guide.doc but I couldn't find links to it.
    I would advice you to open OSS message to MAM componnet and request this document.
    It has all the info.
    As for the errors that you get while using the tool - you need to give more details if you want people to help with localising them.
    Cheers,
    Larissa Limarova

  • Report generation tool kit for vista

    Where can we get report generation tool kit software(for vista Operating system) link .one of my friend has given me that software.He said he had got it from internet.can anyone give me the link so that I can download report generation toolkit software (for vista)
    Thanks
    kiranmayi

    Hi Kiranmayi,
    You can download Report generation toolkit from the following weblink:
    https://lumen.ni.com/nicif/us/evaltlktrepgen/content.xhtml
    or you can send a mail to [email protected] stating your full address and your requirement and we can send you  evaluation DVD for free.
    Thanx
    Gaurav

  • Report generation tool kit not printing

    I had the report generation tool kit version 1.01 for some time but never used it. I was comfortable with printing front panel vi 's.
    But now I installed it on my computer with a windows 2000 and LabView 6.02 .
    I created an application (executable) that will print (using the report
    genartion tool kit). The application works fine in my development computer
    (win 2000).
    When I installed it on another computer with a win 2000, it prints as
    expected
    but when I try to exit I get a message from windows that the application is not responding (I have to go to task manager and terminate the application).
    Both computers have word and Excell installed
    I installed the application on a third computer (win 2000), but this com
    puter does not have word or excell installed. The application does not print the
    portion of the software that uses the report generation tool kit, but it can print the front panel of vi's (set to print an end of excution).
    In all 3 computers, I have runtime engine 6.02 installed. My vi is simply
    the example vi ""Sample test report.vi"", but customized to my application, printing standard report.
    What is happening ?

    Based on what you sent, the version of Excel and Windows that are being used is a non issue since none of the code makes any calls to either one. They all refer to the older version of the report generation VIs that use NI's proprietary report generator.
    I can think of two explainations. First, you aren't using what you think you are. Second, NI retained the same VI names when they went to the Word/Excel version of the generator, and I am linked into the old version.
    Mike...
    Certified Professional Instructor
    Certified LabVIEW Architect
    LabVIEW Champion
    "... after all, He's not a tame lion..."
    Be thinking ahead and mark your dance card for NI Week 2015 now: TS 6139 - Object Oriented First Steps

  • Excel Graph Legend Formatting - Report Generation Tool

    Hi all,
    I'm currently using the Report Generation Tool for Labview '11 and cannot seem to figure out how to edit the font properties for a graph's legend. Attached is a screenshot of an example output.
    The Excel Graph Font.vi's Help file says that it should be able to modify the legend, yet I can't seem to figure out how to configure it to do so. If anyone can walk me through the steps or tell me what I am missing, I'd greatly appreciate it.
    Solved!
    Go to Solution.
    Attachments:
    excelLegend.png ‏33 KB

    ChaoyD wrote:
    Hello again,
    It seems my team has decided to change direction and use Word instead of Excel. As such, I've been attempting to convert the VI ben64 provided, but I'm stuck on the ActiveX references... I've attached what I've done so far, but could someone help me (or instruct me) on making this VI work with Word?
    Thanks.
    The Word object model is probably the most complicated of the Office suite and you are loosing the calculation ability of Excel.
     Attached is a vi to format the chart legend in a Word document.
    Ben64
    Attachments:
    Word Format Graph Legend.vi ‏26 KB

  • Pareto Chart using Report Generation Tool kit

    Hi,
    Please help me to get clarification for the following:
    I need to log data into MS Excel Report and generate Pareto Chart using LabVIEW for the Logged data.
    I have Report Generation Tool kit. but i couldnt find the an option to generate Pareto chart with it.
    Thanks,
    Thirumala.

    One way is to Create a Excel template in the predefined format with the rows/colums linked for the Chart.
    Use this template with report generation toolkit to populate data in the predefined cells.Based on that the chart will be automatically updated.

  • Oracle Forms: Technical Documentation Generator Tool (FoReDoclet, HTML)

    Dear Oracle Forms Developers,
    Nostran Computing has released FoReDoclet, our technical documentation generator tool for Oracle Forms:
    Technical features:
    - Generates HTML documentation about form, menu, PL/SQL library and object library source files similarly to JavaDoc.
    - Uses the Comment property of internal objects (blocks, parameters, alerts)
    - Parses pl/sql elements (procedures, functions, packages, triggers) as well as standard internal elements.
    - The generated HTML documentation is highly customizable by style sheets or direct template modification.
    - Accepts HTML codes in Comments property fields and PL/SQL comment blocks.
    Business benefits:
    - Eliminates the need of writing separate technical documentation, works directly from the source.
    - Provides a low-cost and efficient way of producing high-quality technical documentation for Oracle Forms based applications.
    For details, see: http://www.nostran.com/products/foredoclet

    HI Arun
    where can we get this forms documentation?
    Thankyou
    Sasi

  • Code generation tools

    Hello Xperts,
    Is there any code generation tool for hibernate & spring for java standalone application?
    Thanks!

    You may want to find useful DBScribe.
    ~ Madrid.

  • Report Generation Tool Kit

    Hi,
    I have LabView7.1 and Labview8.0 installed in my pc.Recently i installed Report generation tool kit(version 1.0.1.0)
    In the functions palette i couldnt able to see the Excel Specific VI sub palette and Word Specific VI sub palette.
    Can u tell me what is the problem
    Regards
    Meenatchi

    You can not see it in either version?  Or has it been installed to the wrong version?  There has been postings on this board regarding how to get it to install to multiple versions.  I have not found tha to work.  I go in a 'manually' copy the VIs from add-ons, examples, and help to the latest version of LabVIEW that I have.  But if you look here you should find the help you need.
    Paul <--Always Learning!!!
    sense and simplicity.
    Browse my sample VIs?

  • Test data generation tool?

    Hi folks:
    Can anyone suggest a test data generation tool? We need to load up and stress-test a product we're building. We need a tool that can generate an INSERT script for all tables with referentially intact data inserted in the right order to not violate constraints. I've used Quest's DataFactory before, and it's not very good. Is there a free/inexpensive (or at most, a reasonably priced) tool that anyone knows of?
    Regards,
    Dave

    Hi,
    on the search for another tool i found this one
    http://www.turbodata.ca/help/testdatageneratoroverview.htm
    Claudius

  • ABAP Documentation Generation, Javadoc-like

    Hello everyone,
    I've got one topic to discuss that I do not find very much information about on SCN. It's about documentation. and I don't mean SAP documentation like help.sap.com, but the documentation about the software we (=developers) are producing by writing ABAP-code. That thing that we tend to neglect.
    So is there any tool that is similar to [Javadoc|http://en.wikipedia.org/wiki/Javadoc], something like a ABAP Documentation Generator? A tool that generates a code-based documentation out of the source-code comments? As far as I know, there is no such functionality in the ABAP workbench. The only community project I found was ABAP Docs, but that seems to be inactive and is not even accessibly online.
    How do you document your software? Do you use external tools, anything that is integrated into the SAP system? Or is it a completely segregated solution like we use in my company (Word)? What strategies do you use to create Architecture Documentation, Technical Documentation and End User Documentation?
    It seems to me that there are lots of software solutions that can create modern documentation including different formats, layout templates, guidelines etc. But I haven't found anything related to ABAP development. Maybe the best example is Wikipedias [Comparison of documentation generators|http://en.wikipedia.org/wiki/Comparison_of_documentation_generators]. Just search for ABAP.
    I am looking forward to read about your experiences in documenting ABAP software!

    Surprisingly (more or less) the list has no entry for a tool that supports ABAP, that was my point.
    In the [Language support|http://en.wikipedia.org/wiki/Comparison_of_documentation_generators#Language_support] table there is an Any With Comments column. Looking at the examples for [Natural Docs|http://en.wikipedia.org/wiki/Natural_Docs] and [ROBODoc|http://en.wikipedia.org/wiki/ROBODoc], they might work for ABAP too. YMMV
    Hope this helps,
    Rossen

  • Documentation of tool.jar classes?

    Is there any documentation of the classes located in the JDK's tools.jar? I'm considering writing my own editor, and it'd be very useful to know exactly what I have to work with in terms of interacting with the JDK. I've looked around a bit, and I haven't been able to turn up anything.

    I did, well, two of them anyway. Too big. Too complex. Too long a learning curve. Not all the features I'd like. Not simple enough.
    I'm currently using Crimson Editor. I was using TextPad. My teacher last year told us to download the "free" version. Truth be told, it's an evaluation version, not free. When I got a new computer, I just didn't want to rip off the people who made TextPad. So I tried out NetBeans. Slow, extremely complex. Scrapped it. Tried jEdit. Less complex, but still not what I wanted. Mainly, I wanted easy project management which it just plain didn't provide, and I didn't feel like hunting down a good plug-in. I considered trying to write my own plug-in, but the code made very little sense. That may be because I'm used to very object oriented (as in I was brought up in programming by Java). Anyhow, thne I tried BlueJ. Crud. Scrapped it. Found Crimson, and am fairly satisfied with it, but...
    I'm interested in making a Java editor for dummies, so to speak. ^_^ I want to cut out dealing with the command line stuff. Setting the classpath every time I want to compile or run the program/leaving it permanently set inside a tool, an easy to deal with error system for compilation, a simple jar/zip maker, and other stuff. To do that, I need to know what I have to work with inside the JDK. Hence, the need for documentation. I was actually trying to make a program that would read and analyze all the classes but ran into rather annoying problems, and I'll probably just do that if there isn't any documentation on what's inside tools.jar.
    bangs head on wall Ooooohhhhh. You mean look inside those programs to see how they deal with calling javac. A good idea, but if Sun has something, I'd rather use that. Thanks. I appriciate the suggestion. I have a feeling that will come in handi.
    It occured to me that running javadoc would be easier than what I'm trying to do. Will javadoc work on pure class files, no source files?

  • ADF Faces TLD documentation generation

    What tool do you use to generate the TLD documentation for ADF Faces? I like the way the Faces are documented as a table as well as the tag's attributes. Would it be possible to open-source that generator or make it available?

    I should have said I like the way Facets are documented.

  • How can i build exe which includes report generation tools,in labview 2010

    I hv made exe.
    I hv appended template word file to NewReport.vi.
    when I m executing application,It is nt generating report.
    Tell me the solution...!

    Try this: http://forums.ni.com/t5/LabVIEW/get-doc-report-generation-working-in-build-does-work-in-LV/td-p/1790...
    Beginner? Try LabVIEW Basics
    Sharing bits of code? Try Snippets or LAVA Code Capture Tool
    Have you tried Quick Drop?, Visit QD Community.

Maybe you are looking for