Add some basic documentation about Tox ID in source

Lets not make plaintext gods angry by linking to a dead html page.
2024-03-22 14:00:36 +08:00 · 2016-01-14 20:21:00 +00:00 · 2016-01-14 20:21:00 +00:00 · ccfb81b2e4
commit ccfb81b2e4
parent 05162a63b9
1 changed files with 12 additions and 3 deletions
--- a/src/core/toxid.h
+++ b/src/core/toxid.h
@ -23,9 +23,18 @@

 #include <QString>

-/*!
- * \brief This class represents a Tox ID as specified at:
- *        https://libtoxcore.so/core_concepts.html
+/*
+ * This class represents a Tox ID.
+ *  An ID is composed of 32 bytes long public key, 4 bytes long NoSpam
+ *  and 2 bytes long checksum.
+ *
+ *  e.g.
+ *
+ *  | C7719C6808C14B77348004956D1D98046CE09A34370E7608150EAD74C3815D30 | C8BA3AB9 | BEB9
+ *  |                                                                 /           |
+ *  |                                                                /    NoSpam  | Checksum
+ *  |           Public Key (PK), 32 bytes, 64 characters            /    4 bytes  |  2 bytes
+ *  |                                                              |  8 characters|  4 characters
 */
 class ToxId
 {