Format files to unix format
This commit is contained in:
William S Fulton
parent
6bad5ca3a1
commit
caccb20491
2 changed files with 218 additions and 218 deletions
|
|
@ -1,94 +1,94 @@
|
|||
/*
|
||||
* This file contains comments which demonstrate details about Doxygen processing,
|
||||
* so they can be emulated in SWIG doxy comment translation
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/**This comment without space after '*' is valid in Doxygen.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidA()
|
||||
{}
|
||||
|
||||
/**.This comment without space after '*' is valid in Doxygen.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidB()
|
||||
{}
|
||||
|
||||
|
||||
/***This is not Doxygen comment.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidC()
|
||||
{}
|
||||
|
||||
|
||||
/**
|
||||
* Backslash following\c word is a valid doxygen command. Output contains
|
||||
* 'followingword' with 'word' in code font.
|
||||
*/
|
||||
void backslashA()
|
||||
{}
|
||||
|
||||
// Output of escaped symbols below in doxygen generated HTML:
|
||||
// Rendered: Escaped symbols: $ @ \ & < > # % " \. :: @text ::text
|
||||
// HTML source: Escaped symbols: $ @ \ & < > # % " \. :: @text ::text
|
||||
|
||||
|
||||
/**
|
||||
* Doxy command without trailing \cspace space is ignored - nothing appears
|
||||
* on output. Standalone \ and '\' get to output.
|
||||
* Standalone @ and '@' get to output.
|
||||
* Commands "in quoted \b strings are treated as plain text".
|
||||
* Commands not recognized by Doxygen \blah @blah are ignored.
|
||||
* Backslashes in DOS paths d:\xyz\qwe\myfile and words
|
||||
* following them do not appear on output, we must quote them with
|
||||
* double quotes: "d:\xyz\qwe\myfile", "@something". Single quotes do not help:
|
||||
* 'd:\xyz\qwe\myfile'. Escaping works: d:\\xyz\\qwe\\myfile. Unix
|
||||
* paths of course have no such problems: /xyz/qwe/myfile
|
||||
* Commands for escaped symbols:
|
||||
* \$ \@ \\ \& \~ \< \> \# \% \" \. \:: \@text \::text
|
||||
*/
|
||||
void backslashB()
|
||||
{}
|
||||
|
||||
/**
|
||||
* Backslash e at end of \e line froze SWIG \e
|
||||
* with old comment parser.
|
||||
*
|
||||
* @see MyClass::fun(char,
|
||||
* float)
|
||||
*/
|
||||
void backslashC()
|
||||
{}
|
||||
|
||||
/**
|
||||
* The next line contains expression:
|
||||
* <pre>
|
||||
* ['retVal < 10', 'g_counter == 23 && g_mode & 3']
|
||||
*</pre>
|
||||
*
|
||||
* Both words should be emphasized \b isystem.connect.
|
||||
* But not the last period. For \b example, comma should not be emphasized.
|
||||
* Similar \b for: double colon.
|
||||
*
|
||||
* Spaces at the start of line should be taken into account:
|
||||
* @param id used as prefix in log
|
||||
* statements. The default value is empty string, which is OK if
|
||||
* there is only one app. instance. Example:
|
||||
* <pre>
|
||||
* ctrl.setBP("func1");
|
||||
* </pre>
|
||||
* If we set the id to \c main_, we get:
|
||||
* <pre>
|
||||
* main_ctrl.setBP("func1");
|
||||
* </pre>
|
||||
*
|
||||
* @param fileName name of the log file
|
||||
*/
|
||||
void cycle(int id, char *fileName)
|
||||
{}
|
||||
|
||||
|
||||
/*
|
||||
* This file contains comments which demonstrate details about Doxygen processing,
|
||||
* so they can be emulated in SWIG doxy comment translation
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/**This comment without space after '*' is valid in Doxygen.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidA()
|
||||
{}
|
||||
|
||||
/**.This comment without space after '*' is valid in Doxygen.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidB()
|
||||
{}
|
||||
|
||||
|
||||
/***This is not Doxygen comment.
|
||||
*
|
||||
*/
|
||||
void isNoSpaceValidC()
|
||||
{}
|
||||
|
||||
|
||||
/**
|
||||
* Backslash following\c word is a valid doxygen command. Output contains
|
||||
* 'followingword' with 'word' in code font.
|
||||
*/
|
||||
void backslashA()
|
||||
{}
|
||||
|
||||
// Output of escaped symbols below in doxygen generated HTML:
|
||||
// Rendered: Escaped symbols: $ @ \ & < > # % " \. :: @text ::text
|
||||
// HTML source: Escaped symbols: $ @ \ & < > # % " \. :: @text ::text
|
||||
|
||||
|
||||
/**
|
||||
* Doxy command without trailing \cspace space is ignored - nothing appears
|
||||
* on output. Standalone \ and '\' get to output.
|
||||
* Standalone @ and '@' get to output.
|
||||
* Commands "in quoted \b strings are treated as plain text".
|
||||
* Commands not recognized by Doxygen \blah @blah are ignored.
|
||||
* Backslashes in DOS paths d:\xyz\qwe\myfile and words
|
||||
* following them do not appear on output, we must quote them with
|
||||
* double quotes: "d:\xyz\qwe\myfile", "@something". Single quotes do not help:
|
||||
* 'd:\xyz\qwe\myfile'. Escaping works: d:\\xyz\\qwe\\myfile. Unix
|
||||
* paths of course have no such problems: /xyz/qwe/myfile
|
||||
* Commands for escaped symbols:
|
||||
* \$ \@ \\ \& \~ \< \> \# \% \" \. \:: \@text \::text
|
||||
*/
|
||||
void backslashB()
|
||||
{}
|
||||
|
||||
/**
|
||||
* Backslash e at end of \e line froze SWIG \e
|
||||
* with old comment parser.
|
||||
*
|
||||
* @see MyClass::fun(char,
|
||||
* float)
|
||||
*/
|
||||
void backslashC()
|
||||
{}
|
||||
|
||||
/**
|
||||
* The next line contains expression:
|
||||
* <pre>
|
||||
* ['retVal < 10', 'g_counter == 23 && g_mode & 3']
|
||||
*</pre>
|
||||
*
|
||||
* Both words should be emphasized \b isystem.connect.
|
||||
* But not the last period. For \b example, comma should not be emphasized.
|
||||
* Similar \b for: double colon.
|
||||
*
|
||||
* Spaces at the start of line should be taken into account:
|
||||
* @param id used as prefix in log
|
||||
* statements. The default value is empty string, which is OK if
|
||||
* there is only one app. instance. Example:
|
||||
* <pre>
|
||||
* ctrl.setBP("func1");
|
||||
* </pre>
|
||||
* If we set the id to \c main_, we get:
|
||||
* <pre>
|
||||
* main_ctrl.setBP("func1");
|
||||
* </pre>
|
||||
*
|
||||
* @param fileName name of the log file
|
||||
*/
|
||||
void cycle(int id, char *fileName)
|
||||
{}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,124 +1,124 @@
|
|||
// This file contains tests for situations, which do not normally
|
||||
// appear in the code, but must nevertheless be handled correctly.
|
||||
|
||||
%module doxygen_misc_constructs
|
||||
|
||||
%warnfilter(SWIGWARN_DOXYGEN_UNKNOWN_COMMAND) backslashB;
|
||||
|
||||
%inline %{
|
||||
|
||||
// Tag '@endink' must be recognized even if it is not
|
||||
// followed by whitespace.
|
||||
|
||||
/** Tag endlink must be recognized also when followed by nonspace charater.
|
||||
*
|
||||
* @link Connection::getId() @endlink<br> */
|
||||
|
||||
char g_counter;
|
||||
|
||||
|
||||
/**
|
||||
Tag endlink must be recognized also when it is the last token
|
||||
in the commment.
|
||||
|
||||
@link Connection::getId() @endlink<br>
|
||||
@link debugIdeTraceProfilerCoverageSample.py Python example. @endlink
|
||||
*/
|
||||
int g_zipCode;
|
||||
|
||||
|
||||
// Paramter 'isReportSize' must appear in comment of the overload, which
|
||||
// has it. Empty line before link must be preserved.
|
||||
/**
|
||||
* Returns address of file line.
|
||||
*
|
||||
* @param fileName name of the file, where the source line is located
|
||||
* @param line line number
|
||||
* @param isGetSize if set, for every object location both address and size are returned
|
||||
*
|
||||
* @link Connection::getId() @endlink <br>
|
||||
*/
|
||||
void getAddress(int &fileName,
|
||||
int line,
|
||||
bool isGetSize = false) {}
|
||||
|
||||
// The first comment must be ignored.
|
||||
/**
|
||||
* \defgroup icFacade isystem.connect Facade
|
||||
*
|
||||
* This page shows the core classes, which can be used to control
|
||||
* all aspects of winIDEA, for example: debugging, analyzers, IO module, ...
|
||||
*/
|
||||
|
||||
/**
|
||||
* This class contains information for connection to winIDEA. Its methods
|
||||
* return reference to self, so we can use it like this:
|
||||
* <pre>
|
||||
* CConnectionConfig config = new CConnectionConfig();
|
||||
* config.discoveryPort(5534).dllPath("C:\\myWinIDEA\\connect.dll").id("main");
|
||||
* </pre>
|
||||
*
|
||||
* All parameters are optional. Set only what is required, default values are
|
||||
* used for unspecified parameters.
|
||||
* <p>
|
||||
*
|
||||
* @link advancedWinIDEALaunching.py Python example.@endlink <br>
|
||||
*/
|
||||
class CConnectionConfig
|
||||
{
|
||||
};
|
||||
|
||||
// Text after '\c' must be kept unchanged in Python.
|
||||
/**
|
||||
* Determines how long the \c isystem.connect should wait for running
|
||||
* instances to respond. Only one of \c lfWaitXXX flags from IConnect::ELaunchFlags
|
||||
* may be specified.
|
||||
*/
|
||||
int waitTime(long waitTime) {return 33;}
|
||||
|
||||
|
||||
// Line with tag \ingroup must not appear in translated comment:
|
||||
/** \ingroup icFacade
|
||||
*
|
||||
* This function returns connection id.
|
||||
*/
|
||||
int getConnection() {return 3;}
|
||||
|
||||
// the follwing must produce no comment in wrapper
|
||||
/*******************************************************************/
|
||||
char getFirstLetter() {return 'a';}
|
||||
|
||||
|
||||
/**
|
||||
* Class description.
|
||||
*/
|
||||
class ClassWithNestedEnum {
|
||||
public:
|
||||
/**
|
||||
* Enum description.
|
||||
*/
|
||||
typedef enum {ONE, ///< desc of one
|
||||
TWO, ///< desc of two
|
||||
THREE ///< desc of three
|
||||
} ENested;
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
An example of a list in a documentation comment.
|
||||
|
||||
- The first item of the list.
|
||||
- The second list item, on
|
||||
several indented lines,
|
||||
showing that the indentation
|
||||
is preserved.
|
||||
- And the final list item after it.
|
||||
|
||||
And this is not a list item any more.
|
||||
*/
|
||||
void showList() { }
|
||||
|
||||
#include "doxygen_misc_constructs.h"
|
||||
|
||||
%}
|
||||
%include "doxygen_misc_constructs.h"
|
||||
// This file contains tests for situations, which do not normally
|
||||
// appear in the code, but must nevertheless be handled correctly.
|
||||
|
||||
%module doxygen_misc_constructs
|
||||
|
||||
%warnfilter(SWIGWARN_DOXYGEN_UNKNOWN_COMMAND) backslashB;
|
||||
|
||||
%inline %{
|
||||
|
||||
// Tag '@endink' must be recognized even if it is not
|
||||
// followed by whitespace.
|
||||
|
||||
/** Tag endlink must be recognized also when followed by nonspace charater.
|
||||
*
|
||||
* @link Connection::getId() @endlink<br> */
|
||||
|
||||
char g_counter;
|
||||
|
||||
|
||||
/**
|
||||
Tag endlink must be recognized also when it is the last token
|
||||
in the commment.
|
||||
|
||||
@link Connection::getId() @endlink<br>
|
||||
@link debugIdeTraceProfilerCoverageSample.py Python example. @endlink
|
||||
*/
|
||||
int g_zipCode;
|
||||
|
||||
|
||||
// Paramter 'isReportSize' must appear in comment of the overload, which
|
||||
// has it. Empty line before link must be preserved.
|
||||
/**
|
||||
* Returns address of file line.
|
||||
*
|
||||
* @param fileName name of the file, where the source line is located
|
||||
* @param line line number
|
||||
* @param isGetSize if set, for every object location both address and size are returned
|
||||
*
|
||||
* @link Connection::getId() @endlink <br>
|
||||
*/
|
||||
void getAddress(int &fileName,
|
||||
int line,
|
||||
bool isGetSize = false) {}
|
||||
|
||||
// The first comment must be ignored.
|
||||
/**
|
||||
* \defgroup icFacade isystem.connect Facade
|
||||
*
|
||||
* This page shows the core classes, which can be used to control
|
||||
* all aspects of winIDEA, for example: debugging, analyzers, IO module, ...
|
||||
*/
|
||||
|
||||
/**
|
||||
* This class contains information for connection to winIDEA. Its methods
|
||||
* return reference to self, so we can use it like this:
|
||||
* <pre>
|
||||
* CConnectionConfig config = new CConnectionConfig();
|
||||
* config.discoveryPort(5534).dllPath("C:\\myWinIDEA\\connect.dll").id("main");
|
||||
* </pre>
|
||||
*
|
||||
* All parameters are optional. Set only what is required, default values are
|
||||
* used for unspecified parameters.
|
||||
* <p>
|
||||
*
|
||||
* @link advancedWinIDEALaunching.py Python example.@endlink <br>
|
||||
*/
|
||||
class CConnectionConfig
|
||||
{
|
||||
};
|
||||
|
||||
// Text after '\c' must be kept unchanged in Python.
|
||||
/**
|
||||
* Determines how long the \c isystem.connect should wait for running
|
||||
* instances to respond. Only one of \c lfWaitXXX flags from IConnect::ELaunchFlags
|
||||
* may be specified.
|
||||
*/
|
||||
int waitTime(long waitTime) {return 33;}
|
||||
|
||||
|
||||
// Line with tag \ingroup must not appear in translated comment:
|
||||
/** \ingroup icFacade
|
||||
*
|
||||
* This function returns connection id.
|
||||
*/
|
||||
int getConnection() {return 3;}
|
||||
|
||||
// the follwing must produce no comment in wrapper
|
||||
/*******************************************************************/
|
||||
char getFirstLetter() {return 'a';}
|
||||
|
||||
|
||||
/**
|
||||
* Class description.
|
||||
*/
|
||||
class ClassWithNestedEnum {
|
||||
public:
|
||||
/**
|
||||
* Enum description.
|
||||
*/
|
||||
typedef enum {ONE, ///< desc of one
|
||||
TWO, ///< desc of two
|
||||
THREE ///< desc of three
|
||||
} ENested;
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
An example of a list in a documentation comment.
|
||||
|
||||
- The first item of the list.
|
||||
- The second list item, on
|
||||
several indented lines,
|
||||
showing that the indentation
|
||||
is preserved.
|
||||
- And the final list item after it.
|
||||
|
||||
And this is not a list item any more.
|
||||
*/
|
||||
void showList() { }
|
||||
|
||||
#include "doxygen_misc_constructs.h"
|
||||
|
||||
%}
|
||||
%include "doxygen_misc_constructs.h"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue