StevensDeptECE / GrailGUI

GrailGUI is a prototype of a replacement for web programming (HTTP, HTML, CSS, JavaScript) and GUI programming. It includes a client graphical API, a browser implemented in C++ and OpenGL, a protocol to transmit metadata and data in binary, a language (XDL) to describe the binary data, and local storage to retain data on the client should that be necessary. Encrypted communications (equivalent of TLS) have not yet been implemented.
GNU General Public License v3.0
7 stars 14 forks source link

Document everything via Doxygen and READMEs #26

Open ahuston-0 opened 3 years ago

ahuston-0 commented 3 years ago

Pretty much every .cc and .hh file in the repository needs documentation. Doxygen document generation is pretty much good to go, we just need to write it.

As for README's, we need a better project description and should write documentation for each file in /proj (our error codes, generation scripts, code stats,etc.). Since there are multiple types of scripts and configs there, we should probably just do it in a unified README in /proj