I'm developing a parser for UML and I'm using Astah API to parse a .asta file.
I want to parse classes diagrams, but I can't figure out how to extract the interfaces that a class implements.
I've read the API doc which can be found here API doc
but all these getClientDependencies(), getClientRealizations(), getSupplierDependencies(), getSupplierRealizations() don't work, they just return me an empty list.
Never mind, fellows,
The API doc provided was pretty correct. The UML diagram I was using to test was kinda wrong.
Thanks anyway
Related
Here's the API doc of Stripe: https://stripe.com/docs/api
They seem to be using a three-columns template.
I am wondering whether they use some API blueprint renderer (markdown-to-html type of script) to generate it, similarly to Aglio: https://github.com/danielgtaylor/aglio
If they don't use any renderer, what other types of API blueprint renderers exist out there?
Stripe uses an in house doc generation tool, but Slate (https://github.com/tripit/slate) is a tool modeled off of Stripe's documentation. It looks quite similar and may be what you're looking for. I haven't used it myself so unfortunately I can't tell you much more.
If you want to stick to API Blueprint markdown flavor then check out apiary (http://apiary.io) as an alternative to aglio. It's not the three column layout but it is nice looking.
I'm part of team working on SDK that is exposed with several programming languages - currently ObjC, C#, ActionScript, Java (Android) and later we'll have even more languages.
We want to have documentation which is made up of two parts:
Human readable documentation
API Reference
There are links between the two parts: from human readable docs we have links to specific classes or methods and from the API reference we may link to a document that explain the context in which the class or method is used.
We are currently use a combination of sphinx for human readable documentation and language specific tools for API such as doxygen or asdoc
I saw in LeapMotion they were able to generate a complete documentation for multiple programming-language (not human language) with cross links between programming-languages.
The Question
Does someone know how to accomplish such documentation system in a way we'll not have to duplicate each change in human readable docs to every language and have cross links between the languages?
I put together the Leap Motion documentation. I use Sphinx to create the package of docs and Breathe, a Sphinx plug-in, to basically import XML files generated by Doxygen into the Sphinx project for the doxygenated API references (C++, C#, Java, and Objective-C). For links from the so-called "human-readable" pages to the API references, I generate RST substitutions from the .tag files which Doxygen will generate for you. Links from the API reference to the "human-readable" pages are normal, relative hyperlinks (which I should add more of).
I use the conditional content features of Sphinx to generate a separate set of docs (both "human-readable" and API) for each programming language. Thus these articles can be customized for each programming language where needed and have the correct code examples for the current language. Because each doc set has the same structure, it isn't hard to switch from one language to another.
I did add some custom JavaScript to the page templates to help switch between languages.
tl;dr: Sphinx, Breathe, Doxygen and a small amount of custom JavaScript.
If you would like to discuss this further, you can post a question to our (Leap Motion) developer forum. I'll see it (Stackoverflow isn't the proper place for an ongoing discussion).
Hi Ido Ran,
Tools which you've specified are best in industry for documentation purpose,I am afraid there is no such tool yet which could provide both human and as well as API reference.Out of all my personal best is doxygen which is slighly of multi-use (human and API)..Hope this helps.
I was wondering if there were a way to extract information from an objective-c app, static or dynamic library and/or framework?
Information such as an array of class names without instantiating or running the target.
I've checked google and the apple developer documentation and haven't found anything.
Frank
F-script appears to be able to do what you want, but I'm no expert. Check out www.fscript.org.
If you want to extract classes from an application/dynamic library, there is a handy tool called ClassDump.
It can even generate the header files in order to get an overview of the classes, protocols, etc.
If you want to do it at runtime, then take a look at the source code to learn how to load and parse the different mach-o segments.
This is an excellent starting point for reverse-engineering Cocoa apps:
http://culater.net/wiki/moin.cgi/CocoaReverseEngineering
It mentions F-Script, class-dump, and a few others.
I need a purely text serialization of an object in VBScript.
Does VBScript provide any built-in support for serialization or is it up to me to enumerate the properties and put them in a string?
Thought this might be useful to someone who got here from Google.
You could use a JSON serializer. (for ASP) Though I've noticed it has issues with COM objects. (Solved w/ Hack) As long as you're mostly serializing basic VBScript classes you'll be good.
No, VBScript doesn't have any object serialization functionality built in. You will have to implement it yourself (or try finding some ready-made solutions).
Here's another
http://code.google.com/p/aspjson
And here is my shameless self promotion:
https://github.com/rcdmk/aspJSON
A fast classic ASP JSON parser and encoder for easy JSON manipulation to work with the new JavaScript MV* libraries and frameworks
I've recently started on a project to build out a RESTful API in WCF, and I'm going to need to expose documentation along with the API itself. I was hoping to leverage the XML code comments in my docs for this documentation.
But what I want to output is just the contracts that are exposed by the service: the endpoints and the JSON/XML object structures. Since I'm trying to create external documentation, I'm interested in any of the internals of my library, or how it ties into the .Net Framework (or even that it is .Net, for that matter).
What are my options for tools, to create these docs? I've heard that Sandcastle or Doxygen are good tools for generating docs from XML code comments, but can I filter away the classes and methods that I don't want to expose?
I understand this question was asked pre-.NET 4.0, but as of .NET 4.0, you can create a 'help page' as as described in WCF Web HTTP Service Help Page.
WCF 4.0 Example
[System.ComponentModel.Description("Triggers Method Name Behavior.")]
public void MethodName() {}
Sure, you can filter unwanted APIMembers with Sandcastle. This blogentry describes how. If you are new to Sandcastle, you might want to try out Sandcastle Help File Builder as well, which is basically a Sandcastle Frontend.
You could config doxygen to generate document from files speficied. Why not have a look a the documents of doxygen?