COMPGROUPS.NET | Search | Post Question | Groups | Stream | About | Register

### documentation generation libraries: which ones work?

• Email
• Follow

Hello,

cliki lists several libraries for automatic documentation generation.

looking for feedback regarding their current state: do they still
work, or are these abandoned projects.?

So if you are currently successfully using albert or clod or tinaa or

Thank you,

Mirko


 0
Reply mirko.vukovic (431) 2/19/2010 1:57:48 PM

See related articles to this posting

Mirko <mirko.vukovic@gmail.com> wrote:

> cliki lists several libraries for automatic documentation generation.
>
> looking for feedback regarding their current state: do they still
> work, or are these abandoned projects.?
>
> So if you are currently successfully using albert or clod or tinaa or

FWIW: recently I tried (rather quickly) tinaa and cldoc. They both
compiled with more or less pain wrt dependencies, and they seem to be
more or less equivalent. I couldn't run cldoc on one package of mine
(apparently because it uses a readtable of its own) but tinaa worked
fine. Tinaa and cldoc seem to do a bit more than some other candidates
(for instance, you give them an asdf system and they figure out package
definitions as well).

There's one thing I'm missing from all libraries I tried though: I would
like cross-references between systems, packages and *files* as well. For
instance, Tinaa will display an asdf system, show you a list of files
belonging to it but that's it. I would like those files to be clickable
and get the list of definitions (classes, functions etc.) from them,
just as for packages.

I understand this might not be as trivial as the other features, and
also probably implementation-dependent, but...

--
Resistance is futile. You will be jazzimilated.

Scientific site:   http://www.lrde.epita.fr/~didier
Music (Jazz) site: http://www.didierverna.com

 0
Reply didier1 (452) 2/19/2010 2:46:31 PM

On Feb 19, 10:46=A0am, Didier Verna <did...@lrde.epita.fr> wrote:
> Mirko<mirko.vuko...@gmail.com> wrote:
> > cliki lists several libraries for automatic documentation generation.
>
> > looking for feedback regarding their current state: do they still
> > work, or are these abandoned projects.?
>
> > So if you are currently successfully using albert or clod ortinaaor
>
> FWIW: recently I tried (rather quickly)tinaaand cldoc. They both
> compiled with more or less pain wrt dependencies, and they seem to be
> more or less equivalent. I couldn't run cldoc on one package of mine
> (apparently because it uses a readtable of its own) buttinaaworked
> fine.Tinaaand cldoc seem to do a bit more than some other candidates
> (for instance, you give them an asdf system and they figure out package
> definitions as well).
>
> There's one thing I'm missing from all libraries I tried though: I would
> like cross-references between systems, packages and *files* as well. For
> instance,Tinaawill display an asdf system, show you a list of files
> belonging to it but that's it. I would like those files to be clickable
> and get the list of definitions (classes, functions etc.) from them,
> just as for packages.
>
> I understand this might not be as trivial as the other features, and
> also probably implementation-dependent, but...
>
> --
> Resistance is futile. You will be jazzimilated.
>
> Scientific site: =A0http://www.lrde.epita.fr/~didier
> Music (Jazz) site:http://www.didierverna.com

FWIW, I was unable (so far) to cleanly compile tinaa on cygwin+clisp
(I will try on sbcl next)

I did get albert going on sbcl, but I had to do two things:

1) use the iso8859.1 encoding in order for sbcl to read albert's lisp
files
2) change all the declarations of simple-base-string' to simple-
string'.

I think 2 was a consequence of 1.

(Maybe I could have changed the files encoding to UTF-8, but I had no
idea how to go about that).

Mirko

 0
Reply mirko.vukovic (431) 3/16/2010 4:08:33 PM

On Feb 19, 3:46=A0pm, Didier Verna <did...@lrde.epita.fr> wrote:
> Mirko <mirko.vuko...@gmail.com> wrote:
> > cliki lists several libraries for automatic documentation generation.
>
> > looking for feedback regarding their current state: do they still
> > work, or are these abandoned projects.?
>
> > So if you are currently successfully using albert or clod or tinaa or
>
> FWIW: recently I tried (rather quickly) tinaa and cldoc. They both
> compiled with more or less pain wrt dependencies, and they seem to be
> more or less equivalent. I couldn't run cldoc on one package of mine
> (apparently because it uses a readtable of its own) but tinaa worked
> fine. Tinaa and cldoc seem to do a bit more than some other candidates
> (for instance, you give them an asdf system and they figure out package
> definitions as well).
+1 for Tinaa though it can't recognize the structure names as the
method parameters.
Anyway since you're working on windows settle down for anyone that you
could make work. Or install linux + sbcl somewhere, Virtual machines
are fine if you don't have a spare hardware and generate documentation
from there. Using lisp on windows is PITA.

Slobodan


 0
Reply slobodan.blazeski (1459) 3/16/2010 8:02:38 PM

3 Replies
47 Views

Similar Articles

12/13/2013 7:35:50 PM
[PageSpeed]

Similar Artilces:

What tools are used to write and generate Python Library documentation.
I have a module I'd like to document using the same style... Thanks, Ken Do you think of pydoc? Just make comments in your code this way: def add10(x): """this function adds ten to the given variable""" Then save this into add.py and now (in the same directory): pydoc add Voila, your documentation. Unfortunately, none of the documentation tools that use documentation strings are suitable for full, serious documentation. There are a number of reasons for this, and I'll touch on a few. The obvious one is that there is no standard format for ...

rdoc: how to generate rdoc & ri documentation of standard library?
Hi, how can I generate rdoc & ri documentation of the standard library? I tried "cd /usr/local/lib/ruby; rdoc", but had to cancel it because rdoc tried eating up all my RAM (120MB when I killed it). Is this normal, or am I doing something wrong? Andreas On Dec 31, 2003, at 6:11, Andreas Schwarz wrote: > how can I generate rdoc & ri documentation of the standard library? I > tried "cd /usr/local/lib/ruby; rdoc", but had to cancel it because rdoc > tried eating up all my RAM (120MB when I killed it). Is this normal, or > am I doing something wrong? I...

poster works one one machine but not on other
Hi I am somewhat clueless with respect to (at least ;-) ) the following problem: I did a poster w/ a0poster and everything works fine on my home PC but not on my office PC. Both have miktex 2.4 and missing packages on the latter can hardly be the issue (as evidenced by, for instance, the fact that previous posters worked fine on both). I don't see any pecularities in the current poster. The error message on the office PC is "not in outer par mode" before \begin{figure}, and a hopefully acceptably minimal example goes as follows: Thank you! \documentclass[a0klein,portrait]{a0p...

document.all[txtObj] works but document.getElementById[txtObj] fails
hi, in my code document.all[txtObj].value works but document.getElementById[txtObj].value fails. any ideas why? wk wrote: > in my code > document.all[txtObj].value works but > document.getElementById[txtObj].value fails. document.getElementById is a function you should call in the form document.getElementById('string-with-element-id') so throw out the square brackets you have and correctly call document.getElementById(). -- Martin Honnen http://JavaScript.FAQTs.com/ hi wk, getElementById() gets only one element that u specified with its id i think, so it m...

1 router 2 computers
Hello, I have a Linksys Wireless G router and 2 XP computers that were working fine. Now one get an error that is there is low network connectivity and cannot connect to anything. The other computer - fine. So X - no connection, Y - connected I tried swapping cables - same situation (different ends, new cable, the one from Y) - X no network, Y is fine. Switched router ports - same situation X-no, Y - yes Plugged in modem directly into X - works fine. I did check the security center in the control panels - in both cases the fire wall is on, but the windows firewall is off. I cannot dis...

Authentication: CRAM vs. Plain (one works; one does not)
I'm trying to set up a new mail server to replace an older one. The new platform is CentOS 4 running 8.13.1 and the old platform is an old RH 7.something running 8.12.10. This also involves a shift from SASL 1.5.28 to (at least according to the RPM) 2.1.19. The little mystery I'm chasing is that authentication is only partially working. I've created an "account" using saslpasswd2. Authentication using CRAM-MD5 works. Authentication using PLAIN, though, does not. The log of the failure (with some hopefully useful verbosity) is: Oct 17 19:43:13 10023 sendmail[1448...

Generating Documentation
Hello folks, I remember having looked for this before without having found a solution. How do I generate documentation =E0 la autodoc from code that is written in the same coding style than the tcllib? Thanks. Emmanuel Frecon wrote: > I remember having looked for this before without having found a > solution. How do I generate documentation � la autodoc from code that > is written in the same coding style than the tcllib? The tools that tcllib uses are in tcllib itself (doctools). -- Jeff Hobbs, The Tcl Guy http://www.ActiveState.com/, a division of Sophos ...

Dynamic Link Library Vs. External Library Module (Which One?)
Hello, I was wondering if anyone knew exactly when to declare a module as "Dynamic Link Library" or "External Library Module" in C5? I always use the first one when linking other CW dll apps in, but I have found a few of my CW apps using the other one. Can someone clarify the differences for me? TIA, Doug external lib gets linked into to your application and does not require ,external or dll(1) on prototypes/data external dll is not lilnked into your app - stays a dll and requires ,external and dll(1) - so one template adds them and one doesnt. If you use lib whe...

how to read parse data from two file to generate one one file
#!/usr/bin/ruby ARGF.each do |line| sunetid, tmp, uid, gid, name, homedir, shell = line.split(/\:/) puts " user { \"" + sunetid + "\":" puts " ensure => \"present\"," puts " uid => \"" + uid + "\"," puts " gid => \"" + gid + "\"," puts " comment => \"" + name + "\"," puts " home => \"" + homedir + "\"," puts " shell ...

Re: libref for "work" data sets (one level name): WORK vs USER vs User= option #4
Hey Tammie - With ODS and proc contents you directly get the "work" libref (active user= or work=) and both physical name and filename. The trick is to not specify the higher level name. If you try to put the results into the "work" library SAS complains a bit, but it still works. ods listing close; ods output Directory=mysasfolder.work_directory; proc contents data=_all_ ; run; ods output close; ods listing; About quoted name librefs - you can try them in widows, not just Unix and z/OS: data 'C:\test'; x=a; run; You'll see an automatically generated file...

more than one ITunes library
I have a library set up on my itunes that points to a directory on my mac with my mp3 files. I also have an external drive with another directory full of mp3's, but I don't want to combine them into a single library. Is there any way to have two separate libraries? Or at least load them separately so they don't combine with each other? Thanks! - JmD In article <00ca7b30-0805-4c36-863b-f439b49a0ac8@e10g2000prf.googlegroups.com>, JayDee <dopamine@mail.com> wrote: > I have a library set up on my itunes that points to a directory on my > mac with my mp3 files. I...

here document in one line
I have this: cat <<//// first second //// I need do have it in one line, something like this: sh "cat <<////\nfirst\nsecond\n////" For the newline to take effect I have tried various combinations of echo, \012, eval, backticks... No success. If I am required to explain why I need it in one line, I can do so. "trbosjek" <ivan.petrovski@t-mobile.hr> schrieb im Newsbeitrag news:d4a6157d-fc4e-4ef8-a34b-a4e6ad9d0071@l16g2000hsf.googlegroups.com... >I have this: > > cat <<//// > first > second > //// > > I need do have it in ...

Why does one regex and the other not work??
Here is the code to test. This code was generously provided (some changes by ME) by RobG from this list. Rob's RE is the one commented out, to have at least 1 to 5 digits before the decimal and two digits after the decimal, it allows a negative number. Same RE, uncommented, is mine, with an escaped \$ (dollar sign) so I could use it for evaluating currency entries. Why does the uncommented RE not work?? Thank you, Tom <html> <head> <title>Untitled</title> </head> <body> <script type="text/javascript"> function testNum(num, erId){ v...

How should one document an interface?
Does anyone have any best-practices advice on document interfaces? I'm writing JavaDocs for some interfaces in my project, and I realized that this documentation will be read by two distinct types of audiences, with completely different interests. Namely, people who are going to use objects that are instances of the interface (the clients), and people who wish to implement the functionality that the interface requires (the implementors). Now I know that in theory, I should just be able to say what it is each method in the interface is supposed to do, but in practice, it may ...

Generating core documentation
=46ollowing the discussion about the problems of the documentation for ruby= core=20 available on www.ruby-doc.org, I've tried to understand exactly which of th= e=20 files in the ruby source distribution contain classes/methods of the core.= =20 =46rom my investigation, these files are: numeric.c gc.c io.c re.c range.c variable.c dir.c signal.c marshal.c error.c compar.c enum.c file.c eval.c random.c hash.c math.c pack.c prec.c time.c process.c object.c sprintf.c parse.y array.c version.c string.c bignum.c struct.c class.c NOTE: the methods I used to select the files which belong to th...

Suggestions for documentation generation?
Hello, I have written a C++ library that I've then wrapped with Pyrex. Any suggestions to the best-in-class tool to create documentation for the libraries? I would love to document things in one spot (could be the code) and generate html and PDF from there. Doxygen (www.doxygen.org) looks to be about the best so far. Thanks, kpd wrote: > Hello, > > I have written a C++ library that I've then wrapped with Pyrex. > Any suggestions to the best-in-class tool to create documentation for > the libraries? > > I would love to document things in one spot (could be ...

Has any one worked with Rpyc
To All, Has anyone out there worked much with Rpyc? =20 Thanks, David This e-mail transmission contains information that is confidential and = may be=20 privileged. It is intended only for the addressee(s) named above. If you = receive=20 this e-mail in error, please do not read, copy or disseminate it in any = manner.=20 If you are not the intended recipient, any disclosure, copying, = distribution or=20 use of the contents of this information is prohibited. Please reply to = the=20 message immediately by informing the sender that the message was = misdirected.=20 After replying, pl...