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
This commit is contained in:
Marshall Greenblatt 2011-05-31 17:47:44 +00:00
parent 2779179489
commit f80e8b297e
3 changed files with 13 additions and 0 deletions

View File

@ -568,6 +568,7 @@ public:
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool CanGoBack() =0; virtual bool CanGoBack() =0;
///
// Navigate backwards. // Navigate backwards.
/// ///
/*--cef()--*/ /*--cef()--*/
@ -611,6 +612,7 @@ public:
/*--cef()--*/ /*--cef()--*/
virtual CefWindowHandle GetWindowHandle() =0; virtual CefWindowHandle GetWindowHandle() =0;
///
// Returns true if the window is a popup window. // Returns true if the window is a popup window.
/// ///
/*--cef()--*/ /*--cef()--*/

View File

@ -409,6 +409,7 @@ typedef struct _cef_browser_t
/// ///
int (CEF_CALLBACK *can_go_back)(struct _cef_browser_t* self); int (CEF_CALLBACK *can_go_back)(struct _cef_browser_t* self);
///
// Navigate backwards. // Navigate backwards.
/// ///
void (CEF_CALLBACK *go_back)(struct _cef_browser_t* self); 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)( cef_window_handle_t (CEF_CALLBACK *get_window_handle)(
struct _cef_browser_t* self); struct _cef_browser_t* self);
///
// Returns true (1) if the window is a popup window. // Returns true (1) if the window is a popup window.
/// ///
int (CEF_CALLBACK *is_popup)(struct _cef_browser_t* self); int (CEF_CALLBACK *is_popup)(struct _cef_browser_t* self);

9
tools/make_cppdocs.bat Normal file
View File

@ -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="<center><a href="http://code.google.com/p/chromiumembedded" target="_top">Chromium Embedded Framework (CEF)</a> Copyright &copy 2011 Marshall A. Greenblatt</center>" -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"
)