Perl SDK : New documentation

Document created by Thomas GENTILHOMME on May 11, 2017
Version 1Show Document
  • View in full screen mode

Hi,

 

I'm working since few weeks on a new documentation for Nimsoft Perl SDK. Let me explain the goal of this new documentation : 

 

- Everybody can contribute easily. 

- Add documentation for some undocumented API (Most of them are present in API.pm, but with no concrete examples or any descriptions).

- Add new examples to the whole documentation.

- Proper design with cool perl code highlighting. 

 

Find the documentation here : https://uim-community.github.io/Perl-SDK/  

 

Some (new) API examples

 

nimFind : Search API 

nimGet : https://uim-community.github.io/Perl-SDK/nimGet.html

Complete doc for cfg : CFG ( C Way ) 

nimLog (with all methods ) : nimLog 

 

Two new examples (more planned)

 

Sending an Alarm Message (advanced) 

How to handle and parse nimRequest and nimNamedRequest PDS. 

 

etc... 

 

The global progression is around 70%. CI and QOS API are missing (and few API are not complete at all). Every contribution(s) are welcome.

 

Best Regards,

Thomas

Attachments

    Outcomes