Free c api documentation software for linux

IPSquad Documentation is an XML-based documentation system similar to DocBook.

IPSDoc is a documentation system which uses XML.

Its goal is to provide a system which is like DocBook, but is simpler and more customizable.

It is currently possible to convert IPSDoc documents into PostScript, PDF, or RTF by using the included XSL:FO style sheets.

ACT-RBOT + MRS is a cognitive agent-based social simulation toolkit (RBOT+MRS) and production system based on ACT-R for modelling single actor cognitive experiments (RBOT) and multiple actors in a simulated (semiotic) world (RBOT + MRS).

Domino Javadoc Generator project aims to create a documentation to the Lotus Notes API for Java in a standard format common in the Java comunity and accepted by the most IDEs for Java.

The Lotus Notes API is delivered as a Java archive together with the original documentation in the native format of a Domino database with the IBM Domino Designer. The documentation can be read only in the Lotus Notes. Java-oriented tools cannot use it to display a description of a Java class, to browse classes and their methods or to offer an automatic code insertion based on a Java object and its class.

The goal is to create a Javadoc documentation together with a pseudo-source code of the Lotus Notes API. The documentation can be viewed, indexed and integrated to IDEs. The pseudo-source code can be integrated to IDEs to support object browsing and automatic source code insertion.

Parrot::Docs::Section::C is a C source code documentation section.

SYNOPSIS

use Parrot::Docs::Section::C;

A documentation section describing all the C source code in Parrot.

Class Methods

header_item($text, @names)

Returns a C header files documentation item.

c_source_item($text, @names)

Returns a C source files documentation item.

c_pair_item($text, $name)

Returns a new C source and header file documentation item.

c_item($text, %contents)

Returns a new C source and/or header files documentation item. Recognized keys for %contents are pairs, sources, headers and contents.

new()

Returns a new section.

Amazon API Search is the beginnings of a perl script to search Amazon.

It interfaces with Amazons API interface and performs whatever search the user desires, it then parses the data returned and inserts it in to an MySQL table.

Currently the script only deals with basic returned data, and does not have a user interface. In future releases I hope to correct this.

The script is certainly worth a look for anyone interested in using Amazons API interface.

WWW::Facebook::API::REST::Client::Auth is a Perl module with authentication utilities for Client.

SYNOPSIS

use WWW::Facebook::API::REST::Client::Auth;

Methods for accessing auth with WWW::Facebook::API::REST::Client

SUBROUTINES/METHODS

create_token
auth.createToken of the Facebook API
get_session
auth.getSession of the Facebook API

INTERNAL METHODS AND FUNCTIONS

base

The WWW::Facebook::API::REST::Client::Base object to use to make calls to the REST server

_make_secure

Changes the server_uri to https for get_session.

_make_insecure

Changes the server_uri back to http at the end of get_session.

Device::Audiotron provides a tie-in into the API included in the latest firmware for Voyetra Turtle Beachs Audiotron.

SYNOPSIS

use Device::Audiotron; $at = new Device::Audiotron("Audiotron IP address","username","password"); if(!$at){die "Audiotron object failed to initialize.";}
my ($ref_status, $ref_shares, $ref_hosts) = $at->GlobalInfo(); my $firmware_version = $ref_status->{"Version"};

Device::Audiotron provides a tie-in into the API included in the latest firmware for Voyetra Turtle Beachs Audiotron.

I highly suggest reading through the API documentation located at http://www.turtlebeach.com/site/products/audiotron/api/dl_api.asp before attempting to implement this module.

The available methods for the Audiotron object and an example of usage for each are listed below. The native API call is listed in brackets below each method for informational purposes and for ease in referencing Voyetras API documentation.

GetInfo(Type,[Count],[Criteria])
[Apigetinfo.asp]

Returns a string containing the results from the command request.

$type = "Global";
$info = $at->GetInfo($type);

OR

$type = "artist";
$count = 4;
$criteria = "Staind";
$info = $at->GetInfo($type,$count,$criteria);


Qfile(Type,Criteria)
[Apiqfile.asp]

Returns a string containing the results from the command request.

$type = "File";
$file = q|LITHIUMMP3BushdeconstructedComedown.mp3|;
$cmd_result = $at->Qfile($type, $file);


AddFile(Full_File_Name)
[Apiaddfile.asp]

Returns a string containing the results from the command request.

$file = q|COBALTMP3new_song.mp3|;
$cmd_result = $at->AddFile($file);


Cmd(Command,[Arg])
[Apicmd.asp]

Returns a string containing the results from the command request.

$cmd_name = "play";
$cmd_result = $at->Cmd($cmd_name);

OR

$cmd_name = "goto";
$cmd_arg = "18";
$cmd_result = $at->Cmd($cmd_name, $cmd_arg);


GetStatus()
[Apigetstatus.asp]

Returns a hash containing element names equivalent to the field names returned by the Audiotron.

%status = $at->GetStatus();
print $status{State};


GlobalInfo()
[See GetInfo]

Returns references to a hash, an array, and an array of hashes.

This is simply a call to GetInfo with "Global" passed as the type but has been customized to pre-parse the results.

($ref_status, $ref_shares, $ref_hosts) = $at->GlobalInfo();

In the above example $ref_status is a reference to a hash containing element names equivalent to the field names returned from the "status" portion of the results. So for example, to get the version number of the firmware:

$firmware_version = $ref_status->{"Version"};

Next, $ref_shares is a reference to an array where each element contains the UNC name for the share as listed in the Audiotron.

Lastly, $ref_hosts is a reference to an array of hashes, one hash per host known by the Audiotron. Each hash in the array contains three elements named Host,IP, and State. So for example, to get the IP address of the first host in the array:

$ip_add = $ref_hosts->[0]->{"IP"};


Msg(Text_line1,[Text_line2],[Timeout])
[Apimsg.api]

Returns a string containing the results from the command request.

$line1 = "This is a test.";
$line2 = "Just Another Perl Hacker";
$time_out = "5";
$cmd_result = $at->Msg($line1, $line2, $time_out);


DumpToc(Share_name)
[Apidumptoc.asp]

Returns a (sometimes huge!) string containing the results from the command request.

$share = q|LITHIUMMP3|;
$toc = $at->DumpToc($share);

NOTE:

This is here just as a placeholder, newer versions will allow the output to be written to a file instead of be handed back as a string. Very inefficient in its current form.

WWW::Facebook::API::REST::Client::Wall is a Perl module with Wall methods for Client.

SYNOPSIS

use WWW::Facebook::API::REST::Client;

Methods for accessing wall with WWW::Facebook::API::REST::Client

SUBROUTINES/METHODS

base

The WWW::Facebook::API::REST::Client::Base object to use to make calls to the REST server

get_count

The wall.getCount method of the Facebook API

DIAGNOSTICS

This module is used by WWW::Facebook::API::REST::Client and right now does not have any unique error messages.

CONFIGURATION AND ENVIRONMENT

WWW::Facebook::API::REST::Client::Wall requires no configuration files or environment variables.