Documentation for the Qt Wallet GUI and Syncing #6324

pull penguin1333 wants to merge 4 commits into bitcoin:master from penguin1333:patch-3 changing 2 files +20 −3

penguin1333 commented at 4:06 AM on June 23, 2015: none

Just commented a little bit around the Qt Wallet GUI and Syncing.

It's always nice for new developers to know what everything means :)
Document the Qt Wallet GUI 83fca2cc1b
Document the Syncing d08e9d868a
laanwj commented at 6:51 AM on June 23, 2015: member
I'm a huge proponent of documentation, but I'd like to suggest that if e.g. variable or method names are self-documenting there is no need to add an explicit comment. For example
```
+ // Window title
windowTitle += " " + networkStyle->getTitleAddText();
```
This doesn't provide any information. Adding to a variable named windowTitle already implies this. Better would be:
```
+ // Add the network name to the window title
windowTitle += " " + networkStyle->getTitleAddText();
```
Comments, and documentation, should be on a higher level of abstractness than the source code.
penguin1333 commented at 7:12 AM on June 23, 2015: none

You're right!

I'll work on it tomorrow :D
Document the Qt Wallet GUI c79f158033
penguin1333 commented at 5:30 PM on June 23, 2015: none

@laanwj

I have fixed the Qt Wallet GUI and added more detailed documentation. I'll get to the Syncing now.
Document the Syncing e2c9fe10fb
penguin1333 commented at 5:33 PM on June 23, 2015: none

@laanwj Everything is now documented so it is not just saying what is already implied :)

I didn't fully document the sync.cpp but the GUI wallet file was. But either was, it is ready for merging :D
laanwj added the label Docs and Output on Jun 29, 2015
laanwj commented at 3:54 PM on August 10, 2015: member

Sorry - going to close this. The comments still don't add more information in most cases than is in the code itself, and are sometimes confusing.
laanwj closed this on Aug 10, 2015
DrahtBot locked this on Sep 8, 2021

Contributors

penguin1333

laanwj

Labels

Docs