README.md

   1 Any security related issues should be reported by following the instructions here:
   2 https://01.org/security
   3
   4 Please check the following Android documentation related to HWC2 API:
   5 https://android.googlesource.com/platform/hardware/libhardware/+/master/include/hardware/hwcomposer2.h
   6
   7 ## Contributing
   8
   9 Here are some guidelines to follow for contributing to IA-Hardware-Composer.
  10
  11 ### Documentation
  12
  13 In order to facilitate newcomers to this open source project, we encourage
  14 documentation on any newly added features, methods, and classes via doxygen.
  15
  16 To install doxygen on ubuntu simply run:
  17
  18 ```
  19 sudo apt install doxygen
  20 ```
  21
  22 Note: You may also need to install graphviz if you do not have it already.
  23
  24 ```
  25 sudo apt install graphviz
  26 ```
  27
  28 Once installed, you should provide documentation to any new features you add to
  29 the project or modify/create documentation for any big changes in methods,
  30 classes, etc that you change.
  31
  32 Here is a documentation example on a method.
  33 ```
  34 /**
  35 * Add two integers and return the result.
  36 *
  37 * @param a the first integer to be added.
  38 * @param b the second integer to be added.
  39 * @return The result of the addition of a and b.
  40 */
  41 int add(int a, int b){
  42   int add;
  43   add = a + b;
  44   return add;
  45 }
  46 ```
  47
  48 For more information please visit:
  49 https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
  50
  51 You may check your documentation change by running
  52
  53 ```
  54 doxygen Doxyfile
  55 ```
  56
  57 This will have generated an html folder with an index.html file inside.