From 432f43dd2f4f9ddd035ebbf6e3359c6c14acb24f Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 3 Mar 2017 07:17:28 -0500 Subject: [PATCH] Corrected description of pointer operator-macro order. --- README/API_AND_NAMESPACE.md | 2 +- README/CODESTYLE.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README/API_AND_NAMESPACE.md b/README/API_AND_NAMESPACE.md index 5acb5b9..60eebb5 100644 --- a/README/API_AND_NAMESPACE.md +++ b/README/API_AND_NAMESPACE.md @@ -36,7 +36,7 @@ The `TIDY_EXPORT` call clearly indicates that this function prototype is meant t Although this makes things obvious from the documentation perspective, the truth is a little murkier. In some environments one might define `TIDY_EXPORT` and `TIDY_CALL` differently in order to control compiler behavior, especially in environments that have special requirements for dynamic libraries. In general, though, you shouldn't have to worry about this. -Note that MSVC has issues with macros inserted before pointer operators, and so the preferred use of pointer operators when documenting with macros is this: +The preferred use of pointer operators when documenting with macros is this: ~~~ const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter ) diff --git a/README/CODESTYLE.md b/README/CODESTYLE.md index 23e974b..3debd14 100644 --- a/README/CODESTYLE.md +++ b/README/CODESTYLE.md @@ -18,7 +18,7 @@ From reading of the Tidy source, some things are self evident, in no particular - No C++ single line comments using `//`. - The openning `{` is indented on the next newline. - While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines. - - For compatibility with MSVC, pointer operators in declarations must precede any macro documentation, e.g, `const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )` instead of `const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )`. + - Pointer operators in declarations must precede any macro documentation, e.g, `const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )` instead of `const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )` in case `TIDY_CALL` is defined.