Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
How do I Configuring DoxyGen to document ActionScript files?
I've included the *.as and *.asi files in doxygen's search pattern, but the classes, functions and variables don't show there.
Instead of doxygen you should use a documentation generator that specifically supports the language. For ActionScript 2, you have a couple choices:
NaturalDocs (example) (free)
ZenDoc (free)
AS2Doc Pro (example) (commercial)
If you are using ActionScript 3, Adobe includes a free documentation generator along with their open source compiler (the Flex SDK), called "ASDoc". If you are using FlashDevelop, the latest beta has a built in GUI for running ASDoc, so you don't have to dirty your hands with the commandline.
I've been able to produce SOME documentation with DoxyGen (What can I say - I like its features and capabilities) By doing the following:
Add *.as and *.asi to the list of file types to input.
Select:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
Another issue in AS3 is the package statement.
You need to tell DoxyGen to ignore the package definition. This is easy to do using cond.
So you'll change the line:
package myPackage {
into
/// #cond
package myPackage {
/// #endcond
Which will cause Doxygen to ignore the line(s) between cond and endcond.
Note that there seems to be no need to do the same for the closing curly bracket at the bottom of your .as file.
You can also use Ortelius. Its easier to use than ASDoc since it comes with a simple GUI, and its more forgiven to your code. Its free and opensource, but windows only.
ortelius.marten.dk
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
For example, jQuery Mobile uses Make to assemble their various js and css files into a single js and css file.
The idea is to separate parts of the file that will ultimately be built into smaller files that are responsible for their own thing.
You can do the same thing with a webpage. Add in images as Base64 strings and you can have an entire website as a single .htm file but all of the files which make up that built file exist independently of one another, like normal. The image below might drive home the concept a little better.
I made my own program to do this which you can read about here if you want. My question is if anyone else has caught onto this idea or if there is a more standard way of doing this?
There are quite a few that can be made to do that, like:
Grunt
Assemble
We use rake but have experimented with Grunt as a build tool. Your flavor preference should determine what tool you run with: Grunt is node.js based, rake ('ruby make') is Ruby based, and one of the common python build tools is scons. Build tools are particularly handy for compiling SASS, performing css and js minification, and generating sprite images. Good luck!
Nothing I would call a "standard" (not even a defacto one) but there are some language specific options. I use the Coldfusion language with Railo and a contributed extension called cfstylesheet/cfjavascript. It performs minification, merging and/or obsfucation on-the-fly (with caching) so you just setup your page with some extra tags as so:
<cfset src = ['/cfjs/test/js/A.js','/cfjs/test/js/B.js'] />
<cfjavascript src="#src#" path="/cfjs/test/jscompressed" filename="myJs"/>
PHP has a similar tool available called Minify that works in a similiar way.
A more generic tool is YUI Compressor which could be integrated into almost any build system as a batch script.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I've been working on a framework in AS3 that I want to release, but first I obviously need to prepare some documentation for it.
I've noticed that quite a few sites have the exact same layout, functionality etc as Adobe Livedocs, which has let me to believe that there's something open source out there for creating online documentation.
Here's some examples:
http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
http://papervision3d.googlecode.com/svn/trunk/as3/trunk/docs/index.html
http://www.fisixengine.com/api/
Would anyone be able to point me in the right direction for tools that I can use to prepare online documentation?
Ideally the system would be specifically suited for documentation in ActionScript 3. I don't have a requirement in terms of the documentation being automatically generated either - if there's something out there that looks/works nice I'm happy to manually create the documentation (provided it comes with tools for easily adding classes, arguments, etc).
Adobe has a free tool called ASDoc. It generates documentation which follows the official Adobe patter. Frankly, it isn't worth it though. The ASDoc tool is buggy and unreliable. If it has difficulty finding an import, if an import isn't used, a comment is not correctly formatted, or you have your source code spread out in any sort of unexpected way, it simply breaks.
My company has lost over 50 developer hours (a few people tried to get a couple of different projects to work and failed) in an attempt to get around these limitations and our solution? We used NaturalDocs (A JavaDoc compiler). Is it perfect? No. Is it comparable to ASDoc in output? Sort of, it isn't as neat, and it would be nice if it treated things a little differently, but it works to display the documentation.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
Do you know about any open source projects written in XQuery? The larger the better. I want to improve my XQuery skills by reading existing code.
xprocxq is/was an implementation of XProc in XQuery, and is the only significant XQuery open source project I know of.
For a less conventional example of XQuery, I would recommend a look at the XQSharp raytracer (caveat: I am a developer for XQSharp).
GIT Hub
Pomengrante ( XQuery deployment project )
MarkLogic CQ ( Browser Based Xquery Query tool )
XQuery-OAuth
Google code
XQMVC -- simple MVC framework for XQuery
http://developer.marklogic.com/
XQRunner
XQDebug ( browser based step by step debugging )
Semantic
and so on.
This is a self answer:
Google Search http://www.google.com/codesearch "for file:.xq$" gives about 1000 matches. Most of them small scripts.
We host and/or link to a good number of XQuery open source projects at http://developer.marklogic.com/code. There is plenty of code to read there for you.
See the XQuery Wikibook for a number of documented example XQuery applications
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
I'm using an in-house code generator in which we supply all the metadata regarding our objects, and it generates our database, and object model including validation logic. Once we load all the data in the database, we use classic ASP <% %> to build our templates. I would like to know what open-source frameworks similar to this that are out there.
Thanks!
You can also check openArchitectureWare (http://www.openarchitectureware.org/) which is Eclipse-based.
Have you looked at mygeneration? It's not exactly open source but it's free, and the scripts are totally open. The most common usage is to generate the data layer given a database schema, but you can be more creative than that.
There's also Cog, which allows you to run Python scripts inside of source files. The included Cog module allows printing into the file that it's currently working on. Cog is licensed under MIT.
Check out Star UML it's open source and has some decent code generation capabilities.
I'd also look into Eclipse Plug-in options, I'm sure they're available I just haven't worked with any.
MyGeneration Code Generator is now Open Source.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
This question does not appear to be about programming within the scope defined in the help center.
Closed 7 years ago.
Improve this question
What are the implications of including a set of visual components released under a Mozilla Public License in a commercial application.
Do I have any obligations?
I've found pretty good analysis on MPL (and others) by Frank Hecker here:
http://hecker.org/writings/setting-up-shop (search for "Mozilla Public License")
This pretty much sums it up:
For MozPL-ed source code considered as
a set of source files, modifications
of the original source files are
considered to also fall under the
MozPL, as are new source files
incorporating extracts from the
original source files. Such modified
or new files are required to be
licensed under the same terms as the
original files, and in particular must
be made freely and publicly available
in source form.
...
Thus an open-source product initially
released under the MozPL may be
extended with proprietary code to
create new proprietary products, as
long as the proprietary code is
separate (i.e., in separate files) and
interacts with the open-source code
using a defined API.
But as usual, read it carefully and consult your lawyers.
The only problem is if you modify the components you must release them under Mozilla Public License as well