I want to generate javadocs through maven's site generation plugin and I want to have automatic UML diagrams created and embedded in the javadoc. The statsvn project uses yDoc to generate their UML documentation but I think they're using Maven1. yDoc is a commercial shareware product, so I'm unsure how the open source statsvn project in...
I've just started learning Python and would like to know if there is a searchable list of Python (3.1) functions available online, like there is for PHP (php.net)? Thanks. ...
Hey guys, I have written a pretty extensive REST API using Java Jersey (and JAXB). I have also written the documentation using a Wiki, but its been a totally manual process, which is very error-prone, especially when we need to make modifications, people tend to forget to update the wiki. From looking around, most other REST API's are ...
I need to draw a bunch of packet diagrams (basically concatenated rectangles annotated by lengths/contents with maybe arrows or braces outside the rectangles, see wikipedia or MSDN for some examples). Is there some decent software out there (NOT Visio please) that can help make it easy to draw these? ...
I have a rather odd problem with Doxygen (1.6.1 on Mac OS X Snow Leopard) in that it does not seem to document my enums no matter what I do. I am programming in C and have followed the instructions in the manual. Here is my code: /** * \enum dccp_pkt_type * \brief specifies the available DCCP packet types */ enum dccp_pkt_type { ...
class EXAMPLE{ public func1() private func2() func3() } I have checked for documented entities only. I have documentation for func1 and func3 but no documentation for func2. I have EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO ...
What would you recommend as a good markup language for writing technical design documentation? Ideally I'd like to have at least the following from it: Works well in source control - I'd like to be able to keep the documentation in the repository with the source that it designs Able to do UML-ey diagrams and other relevant techniques i...
I've a java project which needs some documentation, is Doxygen the only way to go ? I would like to document the code but also the architecture, the Makefiles, in 3 words, the whole project. Maybe I should orient myself to eclipsewiki or something like that. Any help would be appreciated. ...
I'm trying to improve the number and quality of tests in my Python projects. One of the the difficulties I've encountered as the number of tests increase is knowing what each test does and how it's supposed to help spot problems. I know that part of keeping track of tests is better unit test names (which has been addressed elsewhere), bu...
Where can I find a complete documentation for enyim and memcached? ...
Hello again. Am looking for a full and official Python standard lib reference. I can't seem to find proper documentation for Python's built-in library anywhere, similar to javadocs. Perhaps I'm not looking hard enough. Thanks ...
Can anyone recommend a free (or cheap) program out there which allows me to easily document what certain tables and fields are used for in our applications? Ideally, when we update a fields type, it would automagically update in this tool. Also, showing what fields are indexed etc would be beneficial. What solutions have you guys / gals...
I am a huge fan of GhostDoc and use it in all of my development projects. Knowing that it supports custom rules I'd like to ask what custom rules have you written? ...
I'm trying to get accurate download numbers for some files on a web server. I look at the user agents and some are clearly bots or web crawlers, but many for many I'm not sure, they may or may not be a web crawler and they are causing many downloads so it's important for me to know. Is there somewhere a list of know web crawlers with so...
I find R documentation to be important but also time-consuming to create/maintain. Has anyone used Roxygen yet, and if so, does it help in maintaining an R package? I've used Doxygen in the past, but those projects didn't have the man structure that R packages require. You can find the vignette here. ...
Is there a way to produce javadoc so that all methods accessible from the class are listed with their full description? Usually only the methods defined in that class are listed and the rest are only linked to in "methods inherited from" section. (Obviously it is tricky to show javadoc of super classes if they're thirdparty and there's...
I have been writing software for about 2 years and am now in charge of determining what documentation is to be produced for software projects in my department due to being the only developer at the company. I do not have any project management, design, or requirements gathering experience but am keen to do a good job my first time round...
Private methods documentation can only be seen by who has access to the source code. Is it worth the effort spent on it? ...
Say I have an ObjC category defined as @interface NSObject (L0SomeCategory) that defines a -doSomething method that I documented. How do I link to its docs from another Doxygen block? I tried unsuccessfully: NSObject::doSomething NSObject(L0SomeCategory)::doSomething L0SomeCategory::doSomething Any ideas? ...
I'm hoping that an extension of some kind is available that does this (although I suppose that my hope is foolishly optimistic). /** * <p> * Gets the {@link ResultObject} given the identifier. The following * fields are not available for some users and will contain a null value: * </p> * * <ul> * <...