Implemented automatic translation of links in doxygen comments, for example @see function(std::string) -> @see function(String) in java. Also included testcase for that
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13490 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
parent
d99fe121b8
commit
380b71eb56
4 changed files with 269 additions and 4 deletions
67
Examples/test-suite/doxygen_translate_links.i
Normal file
67
Examples/test-suite/doxygen_translate_links.i
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
|
||||
|
||||
%module doxygen_translate_links
|
||||
%include "std_string.i"
|
||||
|
||||
%inline %{
|
||||
|
||||
class Shape
|
||||
{
|
||||
public:
|
||||
typedef Shape* superType;
|
||||
};
|
||||
|
||||
/**
|
||||
* Testing typenames converting in \@ link
|
||||
*
|
||||
* \link superFunc(int,std::string)
|
||||
* Test for std_string member
|
||||
* \endlink
|
||||
*
|
||||
* \link superFunc(int,long,void*)
|
||||
* Test for simple types
|
||||
* \endlink
|
||||
*
|
||||
* \link superFunc(Shape::superType*)
|
||||
* Test for custom types
|
||||
* \endlink
|
||||
*
|
||||
* \link superFunc(int**[13])
|
||||
* Test for complex types
|
||||
* \endlink
|
||||
*
|
||||
* same works for 'See also:' links:
|
||||
*
|
||||
* \sa superFunc(int,std::string)
|
||||
* \sa superFunc(int,long,void*)
|
||||
* \sa superFunc(Shape::superType*)
|
||||
* \sa superFunc(int**[13])
|
||||
*
|
||||
* some failing params:
|
||||
*
|
||||
* \sa superFunc()
|
||||
* \sa superFunc()
|
||||
* \sa superFunc()
|
||||
*
|
||||
*/
|
||||
int function()
|
||||
{
|
||||
}
|
||||
|
||||
void superFunc(int, std::string)
|
||||
{
|
||||
}
|
||||
|
||||
void superFunc(int, long, void *)
|
||||
{
|
||||
}
|
||||
|
||||
void superFunc(Shape::superType *)
|
||||
{
|
||||
}
|
||||
|
||||
void superFunc(int **arr[13])
|
||||
{
|
||||
}
|
||||
|
||||
%}
|
||||
Loading…
Add table
Add a link
Reference in a new issue