documentation

Question: Where can I get a list of all UIDefaults properties that exist in Swing? I know of the possibility to write a small snippet of code that just extracts and displays them but I would like to know whether the list I get that way is really complete. When I do so, I get 636 properties for the Metal L&F, 613 for Windows L&F and 550 for the Motif one. Another source on the net puts a list of 795 entries although it has some incorrect additional entries. But perhaps even the metal l&f does not set all it actually could. I have difficulties to believe there really doesn't exist an official

In my code I have X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation'] and later def some_function(..., x=X_DEFAULT, ...): so that in my Sphinx documentation, using (e.g., using .. autofunction:: , etc.) I get the entire long and unwieldy value of X_DEFAULT expanded in the signature for some_function : some_function ( ..., x=['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every'

I'm trying to run PHPDocumentor on my WAMPServer setup. It runs fine, but I'd like to exclude certain directories, such as \sqlbuddy\ which don't contain my own code. Ironically, PHPDocumentor appears to be ignoring my --ignore switch. I've tried several ways of expressing the same thing, but with the same result. Below is the command I'm running it with: php.exe "C:\Users\username\Documents\PhpDocumentor\phpdoc" -t "C:\Program Files\wamp\www\docs" -o HTML:default:default -d "C:\Program Files\wamp\www" --ignore sqlbuddy\ --ignore docs\ Many thanks. Which version of phpDocumentor are you using?

I'm interested to know if it is possible to have some comments in a function (c, c++, java) in a way that doxygen could put them in the generated html file. for example: function(...) { do_1(); /** * Call do_2 function for doing specific stuff. */ do_2(); } Aaron Saarela No, doxygen does not support comments blocks inside function bodies. From the manual: Doxygen allows you to put your documentation blocks practically anywhere (the exception is inside the body of a function or inside a normal C style comment block). Section: Doxygen documenting the code mouviciel I don't know for C but I do it

When I'm typing up a Cocoa object and calling a selector on that object, I sometimes can see 'documentation' or 'help' information about that method. For instance, as I type [NSArray alloc] , I see two help hints. One for NSArray , and one for alloc . Both of these appear in the popup autocomplete suggestions listbox as I type the code. How do I produce similar method/class decorated help hints which will appear when I type? I want to see my comments as I type my custom class name and custom methods. How can I do this? For instance, C# provides this feature through XML documentation which can

I am developing a python library and I am using sphinx.autodoc to generate the documentation as I think that this is a good way to don`t repeat yourself and to have documentation and code in agreement. In a comment to Emit reStructuredText from sphinx autodoc? I learned that "The CPython docs build process doesn't have autodoc enabled (by deliberate choice)". I am wondering why CPython is not using it and what are the disadvantages of using sphinx.autodoc ? It's mostly a matter of history, but also a question of personal (and project) preference. These days, you can get quite usable docs by

I have to build Javadoc from myCode.jar that contains both sources and class files. Can I do it without extracting the jar? According to http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#classpath I should be able to do so this way: C:\>javadoc -d docs -classpath myCode.jar net\kem\jmx\CacheManagerMBean.java However, I get the following error: javadoc: error - File not found: "net\kem\jmx\CacheManagerMBean.java" [search path for source files: [myCode.jar]] [search path for class files: [C:\Program Files\Java\jdk1.5.0_17\jre\lib\rt.jar, C:\Program Files\Java\jdk1.5.0_17\jre\lib

I have Python classes with object attributes which are only declared as part of running the constructor, like so: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for run in os.listdir(self.basepath): if self.foo(run): temp.append(run) self.availableruns = tuple(sorted(temp)) If I now use either help(Foo) or attempt to document Foo in Sphinx, the self.basepath and self.availableruns attributes are not shown. That's a problem for users of our API. I've tried searching for a standard way to ensure that these "dynamically declared" attributes can be found (and