Developer forums (C::B DEVELOPMENT STRICTLY!) > Plugins development

Doxygen plugin

<< < (29/53) > >>

Cryogen:

--- Quote from: stahta01 on April 03, 2010, 12:20:08 am ---You are an A because you are not able to think and read; my tone was not bad till after yours was a.

Edit: I am very sorry for assuming your were a programmer.

Tim S.


--- End quote ---

Deary me. If you refer to my first response, that was a perfectly civil request for an explanation. If you failed to detect that I'm afraid it's you who has the reading disability.
Shall we just move on now, then?

codeur:
Gary, here is your explanation:
The reason why using the %APPDATA% environment variable is preferable is that this location is often redirected (the environment variable reassigned) when launching Code::Blocks in a portable manner.

For example I use a CB launcher that reassigns %APPDATA% with:     SetEnvironmentVariable(_T("APPDATA"), currDir);
before executing codebocks.exe

edit: I know that Biplab does the same in his CBlauncher and loaden also does something similar, except that he modified the CB code to do it.

codeur:
Thanks for the fix for arguments with const modifiers. I'll soon give a good shake up to variations of argument types and return values and report to you.

Regarding the "settings template", it basically works, but I do not understand the purpose of the "Load settings template" entry.
Isn't the settings template if it exists supposed to be loaded automatically on startup?
Unless you are planning on adding the possibility of choosing between multiple templates in the future (which would be great!), I do not see the use of "Load settings".

codeur:
Testing the function banner comment generation:
The const parameter issue is fixed. Thanks.
A few other issues would really benefit if they are fixed before a release (like the first one and perhaps the second). Others we can live with for a while.

/** @brief Example 1: Return type issue
 *
 * @param param1 const int*
 * @param param2 const string&
 * @return string
 *
 */    
string &myFunc(const int * param1, const string &param2);

The parameters are now perfect! The return type should show it is a reference.
(Same problem when the return type is a pointer).

-----------------------------------------------------------
/** @brief Example 2: C-style string array (**) issue
 *
 * @param *param1 char*
 * @return char
 *
 */    
char *myFunc(char **param1)

The name contains one of the *. The return type illustrates the return type issue with pointers.

-----------------------------------------------------------
** @brief Example 3: array notation
 *
 * @param param1[] char*
 * @return char
 *
 */    
char *myFunc(char *param1[])

I imagine this would be specially hard to fix (and the output is understandable anyway).

-----------------------------------------------------------
/** @brief example 4: Operator not recognised as function
 *
 * @param
 * @param
 * @return
 *
 */    
Rational Rational::operator + (const Rational &other) const;

This would be an acceptable solution when the syntax is too complex for the parser.

-----------------------------------------------------------
/** @brief example 5: inline (and static) taken as return types
 *
 * @param num int
 * @param den int
 * @return inline
 *
 */    
inline Rational::Rational(int num, int den) : numerator(num), denominator(den){}

inline and static function modifiers are taken as return types.

Cryogen:

  Hey there,


--- Quote from: codeur on April 03, 2010, 01:11:18 am ---Gary, here is your explanation:
The reason why using the %APPDATA% environment variable is preferable is that this location is often redirected (the environment variable reassigned) when launching Code::Blocks in a portable manner.

For example I use a CB launcher that reassigns %APPDATA% with:     SetEnvironmentVariable(_T("APPDATA"), currDir);
before executing codebocks.exe

edit: I know that Biplab does the same in his CBlauncher and loaden also does something similar, except that he modified the CB code to do it.

--- End quote ---

OK, thanks. Didn't know any of that. Currently, I'm just using the sdk function to return the default prefs directory, as per some other plug-ins. Since I knew you'd come back asking for the ability to load files from elsewhere, I expected to add to it. Can you provide an example of a plug-in that does this, off hand?

Cheers.

Navigation

[0] Message Index

[#] Next page

[*] Previous page