From f80e8b297e58b8166fad528eaad880fbb14d4cbc Mon Sep 17 00:00:00 2001 From: Marshall Greenblatt Date: Tue, 31 May 2011 17:47:44 +0000 Subject: [PATCH] Change comment format to support automatic document generation using the CppDoc application. git-svn-id: https://chromiumembedded.googlecode.com/svn/trunk@250 5089003a-bbd8-11dd-ad1f-f1f9622dbc98 --- include/cef.h | 2 ++ include/cef_capi.h | 2 ++ tools/make_cppdocs.bat | 9 +++++++++ 3 files changed, 13 insertions(+) create mode 100644 tools/make_cppdocs.bat diff --git a/include/cef.h b/include/cef.h index 0fa3ec926..2640e98c4 100644 --- a/include/cef.h +++ b/include/cef.h @@ -568,6 +568,7 @@ public: /// /*--cef()--*/ virtual bool CanGoBack() =0; + /// // Navigate backwards. /// /*--cef()--*/ @@ -611,6 +612,7 @@ public: /*--cef()--*/ virtual CefWindowHandle GetWindowHandle() =0; + /// // Returns true if the window is a popup window. /// /*--cef()--*/ diff --git a/include/cef_capi.h b/include/cef_capi.h index 84a7f2fb0..99f2e58e5 100644 --- a/include/cef_capi.h +++ b/include/cef_capi.h @@ -409,6 +409,7 @@ typedef struct _cef_browser_t /// int (CEF_CALLBACK *can_go_back)(struct _cef_browser_t* self); + /// // Navigate backwards. /// void (CEF_CALLBACK *go_back)(struct _cef_browser_t* self); @@ -450,6 +451,7 @@ typedef struct _cef_browser_t cef_window_handle_t (CEF_CALLBACK *get_window_handle)( struct _cef_browser_t* self); + /// // Returns true (1) if the window is a popup window. /// int (CEF_CALLBACK *is_popup)(struct _cef_browser_t* self); diff --git a/tools/make_cppdocs.bat b/tools/make_cppdocs.bat new file mode 100644 index 000000000..048433129 --- /dev/null +++ b/tools/make_cppdocs.bat @@ -0,0 +1,9 @@ +@echo off +set CPPDOC_PATH="C:\Program Files (x86)\richfeit\CppDoc\CppDoc.exe" + +if not exist %CPPDOC_PATH% ( +echo Please install CppDoc from http://www.cppdoc.com/ +pause +) else ( +%CPPDOC_PATH% -title="CEF C++ API Docs - Revision XXX" -footer="
Chromium Embedded Framework (CEF) Copyright © 2011 Marshall A. Greenblatt
" -namespace-as-project -comment-format="///;//;///" -classdir=projects -module="cppdoc-standard" -extensions=h -languages="c=cpp,cc=cpp,cpp=cpp,cs=csharp,cxx=cpp,h=cpp,hpp=cpp,hxx=cpp,java=java" -D"OS_WIN" -D"USING_CEF_SHARED" -D"__cplusplus" -D"CEF_STRING_TYPE_UTF16" -enable-author=false -enable-deprecations=true -enable-since=true -enable-version=false -file-links-for-globals=false -generate-deprecations-list=false -generate-hierarchy=true -header-background-dark="#ccccff" -header-background-light="#eeeeff" -include-private=false -include-protected=true -index-file-base=index -overview-html=overview.html -reduce-summary-font=true -selected-text-background=navy -selected-text-foreground=white -separate-index-pages=false -show-cppdoc-version=false -show-timestamp=false -summary-html=project.html -suppress-details=false -suppress-frames-links=false -table-background=white -wrap-long-lines=false ..\include #cef_capi.h #cef_nplugin_capi.h #cef_runnable.h #cef_tuple.h "..\docs\index.html" +)