View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0002829 | FSSCP | Build system | public | 2013-04-02 17:13 | 2013-05-04 04:53 |
| Reporter | chief1983 | Assigned To | CommanderDJ | ||
| Priority | normal | Severity | minor | Reproducibility | N/A |
| Status | resolved | Resolution | fixed | ||
| Summary | 0002829: Doxygen documentation warnings | ||||
| Description | Need to fix or check the documentation creating the following Doxygen warnings: Generating docs for file code/debugconsole/timerbar.cpp... /mnt/storage/fs2_open/code/debugconsole/timerbar.cpp:214: warning: argument 'int' of command @param is not found in the argument list of timerbar_set_draw_func(void(*new_draw_func_ptr)(int colour, float x, float y, float w, float h)) Generating docs for file code/debugconsole/timerbar.h... /mnt/storage/fs2_open/code/debugconsole/timerbar.cpp:214: warning: argument 'int' of command @param is not found in the argument list of timerbar_set_draw_func(void(*new_draw_func_ptr)(int colour, float x, float y, float w, float h)) Generating docs for file code/mission/missionparse.cpp... /mnt/storage/fs2_open/code/mission/missionparse.cpp:7222: warning: Unsupported xml/html tag <any> found /mnt/storage/fs2_open/code/mission/missionparse.cpp:7222: warning: Unsupported xml/html tag <any> found Generating docs for file code/network/chat_api.cpp... /mnt/storage/fs2_open/code/network/chat_api.cpp:302: warning: Unsupported xml/html tag <user> found Generating docs for file code/network/chat_api.h... /mnt/storage/fs2_open/code/network/chat_api.cpp:302: warning: Unsupported xml/html tag <user> found Generating docs for file code/parse/sexp.cpp... /mnt/storage/fs2_open/code/parse/sexp.cpp:21336: warning: Unsupported xml/html tag <all> found /mnt/storage/fs2_open/code/parse/sexp.cpp:21336: warning: Unsupported xml/html tag <all> found /mnt/storage/fs2_open/code/parse/sexp.cpp:6182: warning: Unsupported xml/html tag <team> found Generating docs for compound VoiceActingManager... /mnt/storage/fs2_open/code/fred2/voiceactingmanager.cpp:541: warning: Unsupported xml/html tag <none> found | ||||
| Tags | No tags attached. | ||||
|
|
Well the ones in sexp.cpp are valid comments on special strings like <all ships>. Probably the rest of those unsupported xml/html tag warnings are the same situation. |
|
|
We might be able to escape them somehow then, like \<allships\> or \verbatim<allships>\endverbatim, are a couple examples I found from Googling. http://permalink.gmane.org/gmane.text.doxygen.general/9357 http://comments.gmane.org/gmane.text.doxygen.general/9356 http://doxygen.10944.n7.nabble.com/How-to-prevent-warning-Unsupported-xml-html-tag-lt-myTagName-gt-found-td138.html |
|
|
Time_bar_set_draw_func() is also a tough one given the structure of a function pointer, it has been warning ever since we setup Doxygen. The one's in mission parse and main hall menu are valid errors though, probably due to changes in the new pilot code, and should be fixed. |
|
|
2829_part.patch (911 bytes)
Index: code/menuui/mainhallmenu.cpp
===================================================================
--- code/menuui/mainhallmenu.cpp (revision 9615)
+++ code/menuui/mainhallmenu.cpp (working copy)
@@ -388,7 +388,7 @@
/**
* Initialize the main hall proper
*
- * @param main_hall_num Main hall index
+ * @param main_hall_name Name of main hall to initialise.
*/
void main_hall_init(SCP_string main_hall_name)
{
Index: code/mission/missioncampaign.cpp
===================================================================
--- code/mission/missioncampaign.cpp (revision 9615)
+++ code/mission/missioncampaign.cpp (working copy)
@@ -809,7 +809,6 @@
* Just call cfile function which will delete multiple files
*
* @param pilot_name Name of pilot
- * @param is_multi Whether we are deleting single or multiplayer files
*/
void mission_campaign_delete_all_savefiles( char *pilot_name )
{
|
|
|
Thought I'd try to help. Just uploaded a patch for the ones in mainhallmenu.cpp and missioncampaign.cpp. |
|
|
That patch looks fine to commit. Thanks. |
|
|
Committed the partial resolution. Thanks CommanderDJ for the patch |
|
|
No problem! I don't have commit access to trunk yet, so I couldn't have done it anyway, heh. One of these days I'll ask Goober for it, lol. |
|
|
Fixed all the xml warnings, if there's no way we can fix the timerbar one then, I guess we could close this. We sure there's nothing to be done to modify it? |
|
|
Fix committed to trunk@9669. |
|
fs2open: trunk r9618 2013-04-04 01:22 Ported: N/A Details Diff |
Since the timerbar warning can't be fixed, this should fix the remaining parts of Mantis 0002829 by escaping things it confused with xml tags. |
Affected Issues 0002829 |
|
| mod - /trunk/fs2_open/code/fred2/voiceactingmanager.cpp | Diff File | ||
| mod - /trunk/fs2_open/code/mission/missionparse.cpp | Diff File | ||
| mod - /trunk/fs2_open/code/network/chat_api.cpp | Diff File | ||
| mod - /trunk/fs2_open/code/parse/sexp.cpp | Diff File | ||
|
fs2open: trunk r9669 2013-05-04 01:46 Ported: N/A Details Diff |
Fix for Mantis 2829: If it doesn't like trying to @param a double stuffed func, then don't. We have the @params defined in the original draw_func_ptr anyway. |
Affected Issues 0002829 |
|
| mod - /trunk/fs2_open/code/debugconsole/timerbar.cpp | Diff File | ||
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2013-04-02 17:13 | chief1983 | New Issue | |
| 2013-04-02 17:13 | chief1983 | Status | new => assigned |
| 2013-04-02 17:13 | chief1983 | Assigned To | => chief1983 |
| 2013-04-02 17:14 | chief1983 | Assigned To | chief1983 => |
| 2013-04-02 17:15 | chief1983 | Status | assigned => acknowledged |
| 2013-04-02 17:15 | chief1983 | Status | acknowledged => confirmed |
| 2013-04-02 18:19 | FUBAR-BDHR | Note Added: 0014867 | |
| 2013-04-02 18:24 | chief1983 | Note Added: 0014868 | |
| 2013-04-02 20:19 | Echelon9 | Note Added: 0014869 | |
| 2013-04-02 22:33 | CommanderDJ | File Added: 2829_part.patch | |
| 2013-04-02 22:35 | CommanderDJ | Note Added: 0014870 | |
| 2013-04-03 00:14 | Echelon9 | Note Added: 0014871 | |
| 2013-04-03 00:14 | Echelon9 | Assigned To | => CommanderDJ |
| 2013-04-03 00:14 | Echelon9 | Status | confirmed => code review |
| 2013-04-03 11:52 | Echelon9 | Description Updated | |
| 2013-04-03 11:52 | Echelon9 | Note Added: 0014878 | |
| 2013-04-03 12:42 | CommanderDJ | Note Added: 0014879 | |
| 2013-04-04 04:34 | chief1983 | Changeset attached | => fs2open trunk r9618 |
| 2013-04-04 04:45 | chief1983 | Note Added: 0014882 | |
| 2013-05-04 04:34 | Zacam | File Added: 2829-timerbar.cpp.patch | |
| 2013-05-04 04:51 | Zacam | File Deleted: 2829-timerbar.cpp.patch | |
| 2013-05-04 04:53 | Zacam | Changeset attached | => fs2open trunk r9669 |
| 2013-05-04 04:53 | Zacam | Note Added: 0015027 | |
| 2013-05-04 04:53 | Zacam | Status | code review => resolved |
| 2013-05-04 04:53 | Zacam | Resolution | open => fixed |
