Skip to content
Snippets Groups Projects
Commit dd6e0454 authored by Gyorgy Rethy's avatar Gyorgy Rethy
Browse files

generated apidoc documentation added

parent 2f3b305c
No related branches found
Tags CNL113860_R1A
No related merge requests found
Showing
with 1035 additions and 0 deletions
File added
File added
1.52
TTCN3
/home/ETHGRY/Titan_FOSS/ApplicationLibraries/MQTT/src/EPTF_MQTT_Transport_Definitions.ttcn 1581695468 1 EPTF_MQTT_Transport_Definitions
/home/ETHGRY/Titan_FOSS/ApplicationLibraries/MQTT/src/EPTF_MQTT_LocalTransport_Definitions.ttcn 1581695468 1 EPTF_MQTT_LocalTransport_Definitions
/home/ETHGRY/Titan_FOSS/ApplicationLibraries/MQTT/src/EPTF_MQTT_LGen_Functions.ttcn 1581695468 1 EPTF_MQTT_LGen_Functions
/home/ETHGRY/Titan_FOSS/ApplicationLibraries/MQTT/src/EPTF_MQTT_LocalTransport_Functions.ttcn 1581695468 1 EPTF_MQTT_LocalTransport_Functions
/home/ETHGRY/Titan_FOSS/ApplicationLibraries/MQTT/src/EPTF_MQTT_LGen_Definitions.ttcn 1581695468 1 EPTF_MQTT_LGen_Definitions
File added
File added
File added
File added
File added
File added
Format: 1.52
# This is the Natural Docs languages file for this project. If you change
# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
# something for all your projects, edit the Languages.txt in Natural Docs'
# Config directory instead.
Ignore Extensions: cc c cpp hh h o sh csh txt pl pm py
#-------------------------------------------------------------------------------
# SYNTAX:
#
# Unlike other Natural Docs configuration files, in this file all comments
# MUST be alone on a line. Some languages deal with the # character, so you
# cannot put comments on the same line as content.
#
# Also, all lists are separated with spaces, not commas, again because some
# languages may need to use them.
#
# Language: [name]
# Alter Language: [name]
# Defines a new language or alters an existing one. Its name can use any
# characters. If any of the properties below have an add/replace form, you
# must use that when using Alter Language.
#
# The language Shebang Script is special. It's entry is only used for
# extensions, and files with those extensions have their shebang (#!) lines
# read to determine the real language of the file. Extensionless files are
# always treated this way.
#
# The language Text File is also special. It's treated as one big comment
# so you can put Natural Docs content in them without special symbols. Also,
# if you don't specify a package separator, ignored prefixes, or enum value
# behavior, it will copy those settings from the language that is used most
# in the source tree.
#
# Extensions: [extension] [extension] ...
# [Add/Replace] Extensions: [extension] [extension] ...
# Defines the file extensions of the language's source files. You can
# redefine extensions found in the main languages file. You can use * to
# mean any undefined extension.
#
# Shebang Strings: [string] [string] ...
# [Add/Replace] Shebang Strings: [string] [string] ...
# Defines a list of strings that can appear in the shebang (#!) line to
# designate that it's part of the language. You can redefine strings found
# in the main languages file.
#
# Ignore Prefixes in Index: [prefix] [prefix] ...
# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
#
# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
# Specifies prefixes that should be ignored when sorting symbols in an
# index. Can be specified in general or for a specific topic type.
#
#------------------------------------------------------------------------------
# For basic language support only:
#
# Line Comments: [symbol] [symbol] ...
# Defines a space-separated list of symbols that are used for line comments,
# if any.
#
# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
# Defines a space-separated list of symbol pairs that are used for block
# comments, if any.
#
# Package Separator: [symbol]
# Defines the default package separator symbol. The default is a dot.
#
# [Topic Type] Prototype Enders: [symbol] [symbol] ...
# When defined, Natural Docs will attempt to get a prototype from the code
# immediately following the topic type. It stops when it reaches one of
# these symbols. Use \n for line breaks.
#
# Line Extender: [symbol]
# Defines the symbol that allows a prototype to span multiple lines if
# normally a line break would end it.
#
# Enum Values: [global|under type|under parent]
# Defines how enum values are referenced. The default is global.
# global - Values are always global, referenced as 'value'.
# under type - Values are under the enum type, referenced as
# 'package.enum.value'.
# under parent - Values are under the enum's parent, referenced as
# 'package.value'.
#
# Perl Package: [perl package]
# Specifies the Perl package used to fine-tune the language behavior in ways
# too complex to do in this file.
#
#------------------------------------------------------------------------------
# For full language support only:
#
# Full Language Support: [perl package]
# Specifies the Perl package that has the parsing routines necessary for full
# language support.
#
#-------------------------------------------------------------------------------
# The following languages are defined in the main file, if you'd like to alter
# them:
#
# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
# ActionScript, ColdFusion, R, Fortran
# If you add a language that you think would be useful to other developers
# and should be included in Natural Docs by default, please e-mail it to
# languages [at] naturaldocs [dot] org.
Language: TTCN3
Extensions: ttcn ttcnin ttcnpp
Line Comment: //
Block Comment: /* */
Function Prototype Enders: ; {
Variable Prototype Enders: ; =
Type Prototype Enders: ; \n
Constant Prototype Enders: ; }
Component Prototype Enders: ; {
Template Prototype Enders: := {
Altstep Prototype Enders: ; {
Format: 1.52
Title: Massive IoT Test Tools
SubTitle: API Documentation
Footer: Copyright 2020 Test Competence Center
Timestamp: Generated on yyyy-mm-dd
# m - One or two digit month. January is "1"
# mm - Always two digit month. January is "01"
# mon - Short month word. January is "Jan"
# month - Long month word. January is "January"
# d - One or two digit day. 1 is "1"
# dd - Always two digit day. 1 is "01"
# day - Day with letter extension. 1 is "1st"
# yy - Two digit year. 2006 is "06"
# yyyy - Four digit year. 2006 is "2006"
# year - Four digit year. 2006 is "2006"
# --------------------------------------------------------------------------
#
# Cut and paste the lines below to change the order in which your files
# appear on the menu. Don't worry about adding or removing files, Natural
# Docs will take care of that.
#
# You can further organize the menu by grouping the entries. Add a
# "Group: [name] {" line to start a group, and add a "}" to end it.
#
# You can add text and web links to the menu by adding "Text: [text]" and
# "Link: [name] ([URL])" lines, respectively.
#
# The formatting and comments are auto-generated, so don't worry about
# neatness when editing the file. Natural Docs will clean it up the next
# time it is run. When working with groups, just deal with the braces and
# forget about the indentation and comments.
#
# --------------------------------------------------------------------------
File: EPTF_MQTT_LGen_Definitions (EPTF_MQTT_LGen_Definitions.ttcn)
File: EPTF_MQTT_LGen_Functions (EPTF_MQTT_LGen_Functions.ttcn)
File: EPTF_MQTT_LocalTransport_Definitions (EPTF_MQTT_LocalTransport_Definitions.ttcn)
File: EPTF_MQTT_LocalTransport_Functions (EPTF_MQTT_LocalTransport_Functions.ttcn)
File: EPTF_MQTT_Transport_Definitions (EPTF_MQTT_Transport_Definitions.ttcn)
Group: Index {
Constant Index: Constants
Index: Everything
File Index: Files
Function Index: Functions
Module Parameter Index: Module Parameters
Type Index: Types
} # Group: Index
Format: 1.52
# This is the Natural Docs topics file for this project. If you change anything
# here, it will apply to THIS PROJECT ONLY. If you'd like to change something
# for all your projects, edit the Topics.txt in Natural Docs' Config directory
# instead.
Ignore Keywords:
note, notes
#-------------------------------------------------------------------------------
# SYNTAX:
#
# Topic Type: [name]
# Alter Topic Type: [name]
# Creates a new topic type or alters one from the main file. Each type gets
# its own index and behavior settings. Its name can have letters, numbers,
# spaces, and these charaters: - / . '
#
# Plural: [name]
# Sets the plural name of the topic type, if different.
#
# Keywords:
# [keyword]
# [keyword], [plural keyword]
# ...
# Defines or adds to the list of keywords for the topic type. They may only
# contain letters, numbers, and spaces and are not case sensitive. Plural
# keywords are used for list topics. You can redefine keywords found in the
# main topics file.
#
# Index: [yes|no]
# Whether the topics get their own index. Defaults to yes. Everything is
# included in the general index regardless of this setting.
#
# Scope: [normal|start|end|always global]
# How the topics affects scope. Defaults to normal.
# normal - Topics stay within the current scope.
# start - Topics start a new scope for all the topics beneath it,
# like class topics.
# end - Topics reset the scope back to global for all the topics
# beneath it.
# always global - Topics are defined as global, but do not change the scope
# for any other topics.
#
# Class Hierarchy: [yes|no]
# Whether the topics are part of the class hierarchy. Defaults to no.
#
# Page Title If First: [yes|no]
# Whether the topic's title becomes the page title if it's the first one in
# a file. Defaults to no.
#
# Break Lists: [yes|no]
# Whether list topics should be broken into individual topics in the output.
# Defaults to no.
#
# Can Group With: [type], [type], ...
# Defines a list of topic types that this one can possibly be grouped with.
# Defaults to none.
#-------------------------------------------------------------------------------
# The following topics are defined in the main file, if you'd like to alter
# their behavior or add keywords:
#
# Generic, Class, Interface, Section, File, Group, Function, Variable,
# Property, Type, Constant, Enumeration, Event, Delegate, Macro,
# Database, Database Table, Database View, Database Index, Database
# Cursor, Database Trigger, Cookie, Build Target
# If you add something that you think would be useful to other developers
# and should be included in Natural Docs by default, please e-mail it to
# topics [at] naturaldocs [dot] org.
Alter Topic Type: Function
Index: Yes
Alter Topic Type: Constant
Index: Yes
Alter Topic Type: Type
Index: Yes
Topic Type: Module Parameter
Plural: Module Parameters
Index: Yes
Keywords:
module parameter, module parameters
Topic Type: Configuration Type
Plural: Configuration Types
Index: Yes
Can Group With: Types
Keywords:
configtype, configtypes
Topic Type: Testcase
Plural: Testcases
Index: No
Keywords:
testcase, testcases
Topic Type: Altstep
Plural: Altsteps
Index: No
Keywords:
altstep, altsteps
Topic Type: Template
Plural: Templates
Index: No
Keywords:
template, templates
Alter Topic Type: Group
Plural: Groups
Index: No
Add Keywords:
group
Alter Topic Type: Generic
Alter Topic Type: File
Index: Yes
Add Keywords:
module
Topic Type: Component
Plural: Components
Index: No
Keywords:
component, components
source diff could not be displayed: it is too large. Options to address this: view the blob.
source diff could not be displayed: it is too large. Options to address this: view the blob.
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_MQTT_LocalTransport_Definitions - Massive IoT Test Tools</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.52 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="EPTF_MQTT_LocalTransport_Definitions"></a>EPTF_MQTT_LocalTransport_Definitions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the definitions for the MQTT local transport component</p><h4 class=CHeading>Module depends on</h4><ul><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Definitions" class=LFile id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">EPTF_MQTT_Transport_Definitions</a></li><li>&lt;EPTF_CLL_Base_Definitions&gt;</li><li>&lt;EPTF_CLL_Logging_Definitions&gt;</li><li>&lt;EPTF_CLL_FBQ_Definitions&gt;</li><li>&lt;EPTF_CLL_TransportCommPortIPL4_Definitions&gt;</li><li>&lt;EPTF_CLL_RBTScheduler_Definitions&gt;</li><li>&lt;IPL4asp_Types&gt;</li></ul><h4 class=CHeading>Module Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>tsp_EPTF_MQTT_LocalTransport_debug</td><td class=CDLDescription><a href="#tsp_EPTF_MQTT_LocalTransport_debug" class=LModuleParameter id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">tsp_EPTF_MQTT_LocalTransport_debug</a> - <b>boolean</b> - Enabled/disable debug logging</td></tr><tr><td class=CDLEntry>tsp_EPTF_MQTT_LocalTransport_debugVerbose</td><td class=CDLDescription><a href="#tsp_EPTF_MQTT_LocalTransport_debugVerbose" class=LModuleParameter id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">tsp_EPTF_MQTT_LocalTransport_debugVerbose</a> - <b>boolean</b> - Enabled/disable verbosity of debug logging</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#EPTF_MQTT_LocalTransport_Definitions" >EPTF_MQTT_LocalTransport_Definitions</a></td><td class=SDescription>This module contains the definitions for the MQTT local transport component</td></tr><tr class="SModuleParameter SMarked"><td class=SEntry><a href="#tsp_EPTF_MQTT_LocalTransport_debug" >tsp_EPTF_MQTT_LocalTransport_debug</a></td><td class=SDescription>Enabled/disable debug logging</td></tr><tr class="SModuleParameter"><td class=SEntry><a href="#tsp_EPTF_MQTT_LocalTransport_debugVerbose" >tsp_EPTF_MQTT_LocalTransport_debugVerbose</a></td><td class=SDescription>Enabled/disable verbosity of debug logging</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_MQTT_LocalTransport_debug"></a>tsp_EPTF_MQTT_LocalTransport_debug</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Enabled/disable debug logging</p><h4 class=CHeading>Type</h4><p><b>boolean</b></p><h4 class=CHeading>Default value</h4><p><b>false</b></p></div></div></div>
<div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_MQTT_LocalTransport_debugVerbose"></a>tsp_EPTF_MQTT_LocalTransport_debugVerbose</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Enabled/disable verbosity of debug logging</p><h4 class=CHeading>Type</h4><p><b>boolean</b></p><h4 class=CHeading>Default value</h4><p><b>false</b></p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFile>This module contains the definitions of callback functions for the Applib user API</div></div><div class=CToolTip id="tt2"><div class=CModuleParameter>Enabled/disable debug logging</div></div><div class=CToolTip id="tt3"><div class=CModuleParameter>Enabled/disable verbosity of debug logging</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd"><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Massive IoT Test Tools</title></head>
<!-- Generated by Natural Docs, version 1.52 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<frameset cols="185,*"><frame name=Menu src="menu.html"><frame name=Content src="files/EPTF_MQTT_LGen_Definitions-ttcn.html"></frameset><noframes>This documentation was designed for use with frames. However, you can still use it by <a href="menu.html">starting from the menu page</a>.<script language=JavaScript><!--
location.href="menu.html";
// --></script></noframes></html>
\ No newline at end of file
This diff is collapsed.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Massive IoT Test Tools - File Index</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script></head><body class="FramedIndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.52 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Index><div class=IPageTitle>File Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; D &middot; <a href="#E">E</a> &middot; F &middot; G &middot; H &middot; I &middot; J &middot; K &middot; L &middot; M &middot; N &middot; O &middot; P &middot; Q &middot; R &middot; S &middot; T &middot; U &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="E"></a>E</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_Definitions" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=ISymbol>EPTF_MQTT_LGen_Definitions</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/EPTF_MQTT_LGen_Functions-ttcn.html#EPTF_MQTT_LGen_Functions" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')" class=ISymbol>EPTF_MQTT_LGen_Functions</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/EPTF_MQTT_LocalTransport_Definitions-ttcn.html#EPTF_MQTT_LocalTransport_Definitions" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')" class=ISymbol>EPTF_MQTT_LocalTransport_Definitions</a></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/EPTF_MQTT_LocalTransport_Functions-ttcn.html#EPTF_MQTT_LocalTransport_Functions" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')" class=ISymbol>EPTF_MQTT_LocalTransport_Functions</a></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Definitions" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')" class=ISymbol>EPTF_MQTT_Transport_Definitions</a></td></tr></table>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFile>This module contains the definitions for the MQTT load generator component</div></div><div class=CToolTip id="tt2"><div class=CFile>This module contains the functions of the MQTT load generator component</div></div><div class=CToolTip id="tt3"><div class=CFile>This module contains the definitions for the MQTT local transport component</div></div><div class=CToolTip id="tt4"><div class=CFile>This module contains the functions of the MQTT local transport component</div></div><div class=CToolTip id="tt5"><div class=CFile>This module contains the definitions of callback functions for the Applib user API</div></div><!--END_ND_TOOLTIPS-->
</div><!--Index-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment