We are trying to create a .NET application that feeds data from an Asterisk server. Asterisk.NET seems to be a widely used .NET library for talking to the Asterisk manager interface, but I cannot find any tutorials or documentation describing how to use it. I've found the Asterisk-Java documentation which seems to be what this library ...
I installed jcraft, but don't know how to use. is there any documentation available?. I googled, checked their site with no help. ...
Perhaps I'm missing this functionality out of the box, but I can't seem to find it. So I'm looking for a JIRA plugin that would allow for adding notes attached directly to the project summary page. This would be for keeping track of odds and ends about a project that are important to document, but don't fit as bugs, code comments, spec ...
Hi just as the title suggests i am looking for the best way to document groups of requires or includes in a php class file. Should each require be documented and are there any phpdoc tags that should be used specifically. ...
I was writing some error/warning messages a while ago, for an application I am developing, and I was thinking - what "voice" do you write software text in, in general? There's several different categories of text that is included with software packages, including: Interface text - very small amounts of text like "OK", "Cancel", "Title...
Can someone point me to a document where the formatting rules for a MT message field are described? For example I want to know what the following snippet means. :4!c//3!a/3!a/15d ...
Hi, I am using PHPDoc and JSDoc for my source code. I know that there are tools to build an API out of those docs. However, what I am wondering is that how is one supposed to explain complex code? Do I just use multiline comments inside functions rather than explaining in the PHPDoc/JSDoc? For example, consider this code: /** * Lorem...
At the moment, I am writing a JavaFX tutorial targeted at programmers with a solid grasp on Java. The idea is to give them an as-short-as-possible intro to JavaFX, focussing on the differences between Java and the JavaFX Scripting Language while at the same time skipping things which are identical in both languages. The problem is: it's...
Anyone know of documentation for Pylons that is similar to the Ruby on Rails API documentation (http://api.rubyonrails.org)? ...
I have some large, mostly procedural codes that need to be well documented. This generally involves repeated use of a number of functions that must be executed in a certain order. Doxygen is a great product, but it seems very oriented towards documenting OOP codes. Does anyone have any tips on how to use doxygen in a natural way to docu...
The documentation for QStringList QCoreApplication::arguments() (Qt) states that: Usually arguments().at(0) is the program name, arguments().at(1) is the first argument, and arguments().last() is the last argument. See the note below about Windows. It further elaborates: On Windows, [...] the arguments() are construct...
Of all the annoying buzzwords, "functionality" is the worst when I am in the middle of writing a specification (as I am now): "these requirements define the functionality to be included in version 2"..."as part of the download functionality, we need to capture blah blah blah" (Don't get me started on "capture") "Functionality" is too cu...
I have been looking for a list of HTML elements that are valid targets for touch events on the iPad but haven't found it in the online Apple documentation for handling touch events. I know that a span element can be turned into a touch target by adding a dummy onclick handler, but that trick doesn't work for all elements. I would be ve...
I am working on some documentation and need to reference the .Net Framework Class Library. Does anyone know the best way to do this? I was thinking something like the following: .Net Framework Class Library, http://msdn.microsoft.com/en-us/library/ms229335.aspx Wasn't sure if I should include a date or something. I couldn't find ...
I'm programming with Apple's Bonjour SDK for Windows, that contains dns_sd.h. This file is full of documentation that seems to follow a fixed format. Some excerpts follow. This is apparently Emacs syntax: /* -*- Mode: C; tab-width: 4 -*- * * Copyright (c) 2003-2004, Apple Computer, Inc. All rights reserved. ... This appears near th...
There are many escape functions in the Python module mysqldb whose documentation I don't understand, and my efforts at looking them up have revealed nothing. >>> print _mysql.escape.__doc__ escape(obj, dict) -- escape any special characters in object obj using mapping dict to provide quoting functions for each type. Returns a SQL litera...
For some time now I've been enjoying jQAPI, Rails API and RubyBrain. Do you know of any more documentation packs like these? For anything, really. Thanks. ...
I just installed xcode 3.2.3 the latest build IOS 4.0.1 then I manually download the documentation .xar files then extracted them n move them into the docsets folder but it seems nothing is working in the Documentation window. I tried various steps found in this forum but still stuck and new docsets wont show up, even in the home button ...
Is there a customizable documentation generator for C#? As opposed to native xml documentation which provides documentations for classes, methods, properties, the documentation I am referring to here is more lower-level, ie it documents the flow of a method. for example in the given code void SomeMethod(){ ///doc:Do X SomeCodeToDoX /...
Howdy, I want to write a reference manual for a project, and I want to make it available both online as a HTML one-page-per-chapter manual (optionally single-monolithic-page would be nice as well) and as PDF version. Prime examples: The Gentoo Handbook (html one page per chapter, html monolithic) Netty's user guide (html one page per...