Coding style - Revision history

Monica: /* PHP code */

2013-11-04T11:43:15Z

‎PHP code

2012-12-07T11:44:38Z

2012-12-03T16:07:36Z

‎Examples

2012-12-03T13:23:16Z

‎PHP code

2012-12-03T13:22:39Z

2012-12-03T13:10:55Z

2012-11-27T11:04:00Z

2012-11-26T09:22:16Z

‎Files organization

2012-11-26T09:19:47Z

‎Files organization

2012-11-26T09:16:45Z

‎Files organization

← Older revision		Revision as of 11:43, 4 November 2013
Line 105:		Line 105:
	* [http://yate.null.ro/docs/ Yate C++ API]		* [http://yate.null.ro/docs/ Yate C++ API]
	* [[Writing an IVR]]		* [[Writing an IVR]]
		+
		+	[[Category:Programmers]] [[Category:Coding]]

@@ Line 2: / Line 2: @@
 Bellow you can read about the coding style rules to preserve Yate's uniformity of the source code. You can find out about the files name conventions or comments style and a few tips for scripts written in PHP.<br>
 Yate's coding style (being enforced throughout the entire coding process) is clean and easy to understand. This will help you preserve the high standards of the code. <br>
-Yate is written in C++ and it supports scripting in other programming languages like PHP who is described bellow.
+Yate is written in C++ and supports scripting in other programming languages like PHP who is described bellow.
 <!--Software programmers are highly recommended to follow these guidelines to help improve the readability of their source code and make software maintenance easier.-->

@@ Line 81: / Line 81: @@
 Datacard module is a datacard channel driver for Huawei UMTS modem.<br>
 This is a module who uses Yate, but is not in the main branch of Yate. It's an external module written in C++ for Yate and will compile as a separate project.<br>
-You can read more about external modules that are not in the main branch of Yate in [[How to write an external module in C++ for Yate]].
+You can read more about external modules that are not in the main branch of Yate in [[How to compile an external module in C++ for Yate]].
 External modules can be written in other programming language like PHP, Python, Javascript.

@@ Line 89: / Line 89: @@
 ==PHP code==
-The style for writing external PHP modules and IVRs is very similar to the one for C++ code.
+The style for writing external PHP modules and IVRs is very similar to the one for C++ code.<br>
-These modules can be started from Yate and communicate through pipes to the [[External_Module| extmodule]].
+These modules can be started from Yate and communicate through pipes to the [[External_Module| extmodule]].<br>
 They can also be started from outside Yate and connect to a TCP or UNIX socket if a listener is configured in [[External_Module |extmodule]].

@@ Line 85: / Line 85: @@
 External modules can be written in other programming language like PHP, Python, Javascript.
-====PHP code====
+Bellow you can find some information about coding style in PHP that is similar the one for C++ code.
 The style for writing external PHP modules and IVRs is very similar to the one for C++ code.
-These modules can be started from Yate and communicate through pipes to the [[External_Module extmodule]].
+These modules can be started from Yate and communicate through pipes to the [[External_Module| extmodule]].
-They can also be started from outside Yate and connect to a TCP or UNIX socket if a listener is configured in [[External_Module extmodule]].
+They can also be started from outside Yate and connect to a TCP or UNIX socket if a listener is configured in [[External_Module |extmodule]].
 *    Always '''require_once("libyate.php")''' towards the start of any module or library

@@ Line 24: / Line 24: @@
 * tools - some useful bash scripts.
 * windows - project files for Yate's functionality in Windows.
 ===Files name conventions===
@@ Line 78: / Line 76: @@
 Depending on what you want to accomplish and if it involves performance use them wisely.
-==PHP code==
+===Examples===
 The style for writing external PHP modules and IVRs is very similar to the one for C++ code.
 *    Always '''require_once("libyate.php")''' towards the start of any module or library
 *    Never put anything outside the '''<?php ... ?>''' tags
 *    Properly declare static methods with the '''static''' keyword as required by PHP5 or higher
-*    Always the incoming message must be acknowledged
+*    The incoming message must be always acknowledged
 *    Use '''Yate::Output''' to send output to console or log file
 *    Use '''Yate::Debug''' to send debugging output to console or log file, this can be turned on or off by providing a boolean argument

@@ Line 11: / Line 11: @@
 The main parts of Yate are in directories:
-* clients - files for Yate's Client interface
+* clients - files for Yate's Client interface.
-* conf.d - the configuration files in Yate.
+* conf.d - the configuration files for Yate.
-* docs - documentation of Yate's API
+* docs - documentation of Yate's API.
-* engine - the Engine classes
+* engine - the Engine classes.
-* libs - the main libraries
+* libs - the main libraries.
 * modules:
 :* routing modules
@@ Line 21: / Line 21: @@
 :* script language bindings
 :* CDR modules
-* share - here you can find scripts directory that contain the most important library that communicates with Yate written in PHP and Python
+* share - here you can find scripts directory with important libraries that communicates with Yate, written in PHP and Python.
-* tools - some useful bash scripts
+* tools - some useful bash scripts.
-* windows - project files for Yate's functionality in Windows
+* windows - project files for Yate's functionality in Windows.
 You can write your own modules that can be included in the main branch of Yate or modules that are independent like this one: [[Datacard module for Yate]].