Add documentation (1.5.4)

[annedrewhu]

There's a lot of internal documentation that needs to be added. How do we decide where to start?

I had an idea that before every release we could write down which areas of the code we had to dive into and that we felt needed more documentation. This is kind of like "add it when you see it isn't there", but in a more structured form.

So, for 1.5.4 actually most of the documentation would need to be added by me, since I did the transition to LLVM 6. Here are some of the files that need to be better documented:

EDIT: The list of things to document will be in my review of the PR

• LLVMModelGenerator.cpp
• ModelDataIRBuilder.cpp
• ModelGeneratorContext.h
• ModelGeneratorContext.cpp
• rrSparse.cpp

[hsauro]

To add to this, I have a google summer of code starting next week He has asked for any internal docs we have, this would be a good opportunity to create some. To begin with, a document giving a bird-eye view of the code would be useful to the google summer of code student. Doesn't have to be long. Herber

…

On Wed, May 8, 2019 at 10:52 PM Andrew Hu ***@***.***> wrote: There's a lot of internal documentation that needs to be added. How do we decide where to start? I had an idea that before every release we could write down which areas of the code we had to dive into and that we felt needed more documentation. This is kind of like "add it when you see it isn't there", but in a more structured form. So, for 1.5.4 actually most of the documentation would need to be added by me, since I did the transition to LLVM 6. Here are some of the files that need to be better documented: - LLVMModelGenerator.cpp - ModelDataIRBuilder.cpp - ModelGeneratorContext.h - ModelGeneratorContext.cpp - rrSparse.cpp — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#533>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAIBSDX2FMVRHRPXYDFXWADPUO3Y3ANCNFSM4HLXKZRQ> .

-- Herbert Sauro, Associate Professor University of Washington, Bioengineering 206-685-2119, www.sys-bio.org [email protected] Books: http://books.analogmachine.org/

[annedrewhu]

Great, the LLVM stuff may be quite challenging at the start, so I will probably write this documentation myself, but the bird's eye view documentation is much needed.

[annedrewhu]

I'm doing a review on the PR, so that will be where I list all the things that need to be documented.