• R/O
  • SSH
  • HTTPS

tortoisesvn: Commit


Commit MetaInfo

Revision4663 (tree)
Zeit2005-10-17 00:25:33
Autorstefankueng

Log Message

Document the revision graph classes a little bit.

Ändern Zusammenfassung

Diff

--- trunk/doc/TortoiseAPI.bat (revision 4662)
+++ trunk/doc/TortoiseAPI.bat (revision 4663)
@@ -8,4 +8,13 @@
88 del Doxyfile
99 del output\doxygen\SubversionAPI.chm
1010 copy output\doxygen\html\SubversionAPI.chm output\doxygen\SubversionAPI.chm
11+pause
1112 rmdir /s /q output\doxygen\html
13+
14+type API\Doxyfile > Doxyfile
15+echo HHC_LOCATION=%HHCLOC% >> Doxyfile
16+doxygen.exe Doxyfile
17+del Doxyfile
18+del output\doxygen\TortoiseAPI.chm
19+copy output\doxygen\html\TortoiseAPI.chm output\doxygen\TortoiseAPI.chm
20+rmdir /s /q output\doxygen\html
--- trunk/src/TortoiseProc/RevisionGraph.h (revision 4662)
+++ trunk/src/TortoiseProc/RevisionGraph.h (revision 4663)
@@ -18,44 +18,8 @@
1818 //
1919 #pragma once
2020
21-#if 0
22-// None of these are necessary in the normal build - are they being used in a stand-alone test build?
23-#include "atlsimpstr.h"
24-#include "afxtempl.h"
25-
26-#include "apr_general.h"
27-#include "apr_tables.h"
28-#include "apr_hash.h"
29-#include "svn_pools.h"
30-#include "svn_client.h"
31-#include "svn_sorts.h"
32-#include "svn_path.h"
33-#include "svn_wc.h"
34-#include "svn_utf.h"
35-#include "svn_repos.h"
36-#include "svn_string.h"
37-#include "svn_config.h"
38-#include "svn_time.h"
39-#include "svn_subst.h"
40-#include "svn_auth.h"
41-
42-#include "ProgressDlg.h"
4321 #include "SVNPrompt.h"
44-#include "SVNRev.h"
4522
46-#pragma warning (push,1)
47-typedef std::basic_string<wchar_t> wide_string;
48-#ifdef UNICODE
49-# define stdstring wide_string
50-#else
51-# define stdstring std::string
52-#endif
53-#pragma warning (pop)
54-
55-#endif // 0
56-
57-#include "SVNPrompt.h"
58-
5923 typedef int (__cdecl *GENERICCOMPAREFN)(const void * elem1, const void * elem2);
6024
6125 struct log_entry
@@ -73,6 +37,11 @@
7337 LONG revisionto;
7438 };
7539
40+/**
41+ * \ingroup TortoiseProc
42+ * Helper class, representing a revision with all the required information
43+ * which we need to draw a revision graph.
44+ */
7645 class CRevisionEntry
7746 {
7847 public:
@@ -117,6 +86,19 @@
11786 CRect drawrect;
11887 };
11988
89+/**
90+ * \ingroup TortoiseProc
91+ * Handles and analyzes log data to produce a revision graph.
92+ *
93+ * Since Subversion only stores information where each entry is copied \b from
94+ * and not where it is copied \b to, the first thing we do here is crawl all
95+ * revisions and create separate CRevisionEntry objects where we store the
96+ * information where those are copied \b to.
97+ *
98+ * In a next step, we go again through all the CRevisionEntry objects to find
99+ * out if they are related to the path we're looking at. If they are, we mark
100+ * them as \b in-use.
101+ */
120102 class CRevisionGraph
121103 {
122104 public:
--- trunk/src/TortoiseProc/RevisionGraphDlg.h (revision 4662)
+++ trunk/src/TortoiseProc/RevisionGraphDlg.h (revision 4663)
@@ -55,7 +55,13 @@
5555 #define ID_UNIDIFFREVS 3
5656 #define ID_UNIDIFFHEADS 4
5757
58-
58+/**
59+ * \ingroup TortoiseProc
60+ * A dialog showing a revision graph.
61+ *
62+ * The analyzation of the log data is done in the child class CRevisionGraph.
63+ * Here, we handle the drawing.
64+ */
5965 class CRevisionGraphDlg : public CResizableStandAloneDialog, public CRevisionGraph //CResizableStandAloneDialog
6066 {
6167 DECLARE_DYNAMIC(CRevisionGraphDlg)
Show on old repository browser