Change API's According to Coding Convention - Githubissues

ZA-YA / P-OS

MIT License

5 stars 0 forks source link

Change API's According to Coding Convention #54

Open p-os opened 8 years ago

p-os commented 8 years ago

Coding convention has not finalized yet but for public APIs we follow following rules.

P-OS suggests layered design. In that approach, each layer has own princibles. (Will be detailed later)

Function names should follow following rule

< LayerPrefix >< ModuleName >< Functionality >()

Layer Prefix :

OS_ : Operating System or Kernel.
Drv_ : Driver Layer
Midd_ : Middleware Layer
App_ : Application
No prefix -- Layer independent modules (like generic algorithms located under layerless directories) do not need a LayerPrefix.

Examples :

Drv_Timer_Init();
OS_Task_Create();
App_GUI_Start();
Stack_Push(); // Generic layer independent stack data structure