MySQL_with_detailed_comment

This project aims to provide a detaied explaination on every function of MySQL's source code. It can both view using:

C/C++ IDE
Web brower acting like a Blog

How to Use This Project

We try to give every function a detailed explaination like: what's its main fucntionality, where/when it'll be invoked, cross referencing any other functions. All these information lies right before the implementation code as comment along with the default comment add by MySQL community developer. However the extra comment is not a plain text comment, it has its own syntac in order to be able to translate into markdown format and fancy web pages. Find more about the transform tool, see: mysql_source_code_explaination

How to Do My Own Source Code Reading

It's really easy! You can start up right now by just cloning this repositry using:

git clont https://github.com/cenalulu/MySQL_with_detailed_comment.git

Once cloned you can add your own thought into the comment part. If you find any error in the explaination, please fire a pull request. We'll merge your brilliant idea into the main trunk

About

This project aims to provide a detailed explaination on every function in MySQL's source code. It can both view using C/C++ IDE or parse into web browser compatible markdown format

Languages

Language:C++ 58.1%Language:C 32.7%Language:Java 3.8%Language:Perl 2.6%Language:Objective-C 0.7%Language:CMake 0.7%Language:Shell 0.6%Language:PLpgSQL 0.1%Language:Pascal 0.1%Language:GAP 0.1%Language:Groff 0.1%Language:Python 0.1%Language:SQLPL 0.1%Language:R 0.0%Language:Makefile 0.0%Language:Bison 0.0%Language:PLSQL 0.0%Language:HTML 0.0%Language:Scilab 0.0%Language:JavaScript 0.0%Language:Puppet 0.0%Language:Perl 6 0.0%Language:Awk 0.0%Language:Visual Basic 0.0%