Converted remaining C comments (rathena#3927)

* Converted remaining documentation that references .c or .h files.
vykimo · Feb 9, 2019 · c5a5c54 · c5a5c54
1 parent 35611e7
commit c5a5c54
Show file tree

Hide file tree

Showing 52 changed files with 94 additions and 95 deletions.
diff --git a/.gitignore b/.gitignore
@@ -71,7 +71,6 @@ Thumbs.db
 /src/common/Makefile
 /src/common/obj_all
 /src/common/obj_sql
-/src/common/svnversion.h
 
 # /src/custom/
 /src/custom
@@ -83,7 +82,7 @@ Thumbs.db
 # /src/map/
 /src/map/Makefile
 /src/map/obj_sql
-/src/map/pcre.h
+/src/map/pcre.hpp
 
 # /src/tool/
 /src/tool/Makefile

diff --git a/conf/battle/gm.conf b/conf/battle/gm.conf
@@ -24,7 +24,7 @@ partial_name_scan: yes
 // Duration of the ban, in minutes (default: 5). To disable the ban, set 0.
 ban_hack_trade: 5
 
-// requires RENEWAL_EXP or RENEWAL_DROP to be enabled (src/config/renewal.h)
+// requires RENEWAL_EXP or RENEWAL_DROP to be enabled (src/config/renewal.hpp)
 // modifies @mobinfo to display the users' real drop rate as per renewal_drop formula
 // modifies @iteminfo to not display the minimum item drop rate (since it can't tell the mob level)
 // modifies @whodrops to display the users' real drop rate as per renewal_drop formula

diff --git a/conf/battle/misc.conf b/conf/battle/misc.conf
@@ -99,7 +99,7 @@ duel_only_on_same_map: no
 // Set to 0 for no cell stacking checks and free movement.
 // Custom - This variation will make every full cell to be considered a wall.
 // NOTE: For the custom setting to take effect you have to use a server compiled
-// with Cell Stack Limit support (see src/map/map.h)
+// with Cell Stack Limit support (see src/map/map.hpp)
 official_cell_stack_limit: 1
 custom_cell_stack_limit: 1
 

diff --git a/conf/char_athena.conf b/conf/char_athena.conf
@@ -109,15 +109,15 @@ save_log: yes
 
 // Starting point for new characters
 // Format: <map_name>,<x>,<y>{:<map_name>,<x>,<y>...}
-// Max number of start points is MAX_STARTPOINT in char.h (default 5)
+// Max number of start points is MAX_STARTPOINT in char.hpp (default 5)
 // Location is randomly picked on character creation.
 // NOTE: For Doram, this requires client 20151001 or newer.
 start_point: iz_int,18,26:iz_int01,18,26:iz_int02,18,26:iz_int03,18,26:iz_int04,18,26
 start_point_pre: new_1-1,53,111:new_2-1,53,111:new_3-1,53,111:new_4-1,53,111:new_5-1,53,111
 start_point_doram: lasa_fild01,48,297
 
 // Starting items for new characters
-// Max number of items is MAX_STARTITEM in char.c (default 32)
+// Max number of items is MAX_STARTITEM in char.cpp (default 32)
 // Format: <id>,<amount>,<position>{:<id>,<amount>,<position>...}
 // To auto-equip an item, include the position where it will be equipped; otherwise, use zero.
 // NOTE: For Doram, this requires client 20151001 or newer.

diff --git a/conf/login_athena.conf b/conf/login_athena.conf
@@ -89,7 +89,7 @@ min_group_id_to_connect: -1
 vip_group: 5
 
 // How many characters are allowed per account?
-// You cannot exceed the limit of MAX_CHARS slots, defined in mmo.h, or chars_per_account
+// You cannot exceed the limit of MAX_CHARS slots, defined in mmo.hpp, or chars_per_account
 // will default to MAX_CHARS.
 // 0 will default to the value of MIN_CHARS. (default)
 chars_per_account: 0

diff --git a/conf/motd.txt b/conf/motd.txt
@@ -1,2 +1,2 @@
-// Internal default is limited to 128 lines.  If you need more, you will need to modify the MOTD_LINE_SIZE definition in pc.c
+// Internal default is limited to 128 lines.  If you need more, you will need to modify the MOTD_LINE_SIZE definition in pc.cpp
 Welcome to rAthena! Enjoy! Please report any bugs you find.
diff --git a/conf/msg_conf/map_msg.conf b/conf/msg_conf/map_msg.conf
@@ -1556,7 +1556,7 @@
 1391: You do not possess a cart to be removed
 1392: Cart Added.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: You can't use commands while dead.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_chn.conf b/conf/msg_conf/map_msg_chn.conf
@@ -1373,7 +1373,7 @@
 1391: You do not possess a cart to be removed
 1392: Cart Added.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: 角色死亡時不能使用指令。
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_frn.conf b/conf/msg_conf/map_msg_frn.conf
@@ -1386,7 +1386,7 @@
 1391: Vous ne poss�dez pas de chariot.
 1392: Chariot ajout�.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: Les morts ne pouvent pas utiliser de commande.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_idn.conf b/conf/msg_conf/map_msg_idn.conf
@@ -1477,7 +1477,7 @@
 1391: Kamu tidak memiliki keranjang yang akan dihapus.
 1392: Gerobak ditambahkan.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: Kamu tidak bisa menggunakan perintah ini ketika mati.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_por.conf b/conf/msg_conf/map_msg_por.conf
@@ -1556,7 +1556,7 @@
 1391: Você não possui um carrinho para remover
 1392: Carrinho Adicionado.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: Você não pode utilizar comandos caso esteja morto.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_rus.conf b/conf/msg_conf/map_msg_rus.conf
@@ -1386,7 +1386,7 @@
 1391: � ��� ��� ������.
 1392: ������ ���������.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: �� �� ������ ������������ ������� ����� ������.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_spn.conf b/conf/msg_conf/map_msg_spn.conf
@@ -1527,7 +1527,7 @@
 1391: No tienes ning�n carro.
 1392: Ahora tienes un carro.
 
-// atccomand.c::is_atcommand
+// atccomand.cpp::is_atcommand
 1393: No puedes utilizar ning�n comando porque est�s muerto.
 
 // @clearstorage

diff --git a/conf/msg_conf/map_msg_tha.conf b/conf/msg_conf/map_msg_tha.conf
@@ -1379,7 +1379,7 @@
 1391: �س�����ö�繷���ź�͡.
 1392: �Դ���ö�����º����.
 
-// atcommand.c::is_atcommand
+// atcommand.cpp::is_atcommand
 1393: �س�������ö��������㹢�е������.
 
 // @clearstorage

diff --git a/configure b/configure
@@ -1339,7 +1339,7 @@ Optional Features:
   --enable-FEATURE[=ARG]  include FEATURE [ARG=yes]
   --enable-manager=ARG    memory managers: no, builtin, memwatch, dmalloc,
                           gcollect, bcheck (defaults to builtin)
-  --enable-packetver=ARG  Sets the PACKETVER define. (see src/common/mmo.h)
+  --enable-packetver=ARG  Sets the PACKETVER define. (see src/common/mmo.hpp)
   --enable-epoll          use epoll(4) on Linux
   --enable-debug[=ARG]    Compiles extra debug code. (disabled by default)
                           (available options: yes, no, gdb)

diff --git a/db/mob_item_ratio.txt b/db/mob_item_ratio.txt
@@ -18,7 +18,7 @@
 //
 // Notes:
 // - By default you can list up to 10 MonsterIDs per ItemID.
-//   It can be changed in src/map/mob.c by adjusting MAX_ITEMRATIO_MOBS.
+//   It can be changed in src/map/mob.cpp by adjusting MAX_ITEMRATIO_MOBS.
 // - Only ItemIDs up to MAX_ITEMDB are supported (default: 32768).
 // - Does not override item_drop_*_min/max settings.
 // - Does not affect card/item-granted drops. To adjust card/item-granted

diff --git a/db/pre-re/item_delay.txt b/db/pre-re/item_delay.txt
@@ -16,7 +16,7 @@
 //        12659 cannot be used when this delay is active.
 //     Since this is optional, default is -1 will ignores the
 //     delay group and the delay will be stored in character's
-//     data that has limit set in src/map/itemdb.h as MAX_ITEMDELAYS.
+//     data that has limit set in src/map/itemdb.hpp as MAX_ITEMDELAYS.
 
 // SC_REUSE_LIMIT_A
 14538,300000,SC_REUSE_LIMIT_A	//Glass_Of_Illusion

diff --git a/db/pre-re/skill_require_db.txt b/db/pre-re/skill_require_db.txt
@@ -26,11 +26,11 @@
 // 'RequiredStatuses'
 //	Fill the value only with SC_STATUS (see db/const.txt for more details)
 //	Usage for multiple status requirements: SC_STATUS1:SC_STATUS2:SC_STATUS3
-//	Max. multiple value is 3 (skill.h: MAX_SKILL_STATUS_REQUIRE)
+//	Max. multiple value is 3 (skill.hpp: MAX_SKILL_STATUS_REQUIRE)
 //	Use any number or SC_ALL will disable status requirements
 // 'RequiredEquipment'
 //	Specified equipment to be equipped. For multiple values, use : as delimiter.
-//	Max. multiple value is 10 (skill.h: MAX_SKILL_EQUIP_REQUIRE)
+//	Max. multiple value is 10 (skill.hpp: MAX_SKILL_EQUIP_REQUIRE)
 
 //****
 // SM Swordman

diff --git a/db/re/item_delay.txt b/db/re/item_delay.txt
@@ -16,7 +16,7 @@
 //        12659 cannot be used when this delay is active.
 //     Since this is optional, default is -1 will ignores the
 //     delay group and the delay will be stored in character's
-//     data that has limit set in src/map/itemdb.h as MAX_ITEMDELAYS.
+//     data that has limit set in src/map/itemdb.hpp as MAX_ITEMDELAYS.
 
 // SC_REUSE_REFRESH
 12725,120000,SC_REUSE_REFRESH	//Runstone_Nosiege

diff --git a/db/re/skill_require_db.txt b/db/re/skill_require_db.txt
@@ -26,11 +26,11 @@
 // 'RequiredStatuses'
 //	Fill the value only with SC_STATUS (see db/const.txt for more details)
 //	Usage for multiple status requirements: SC_STATUS1:SC_STATUS2:SC_STATUS3
-//	Max. multiple value is 3 (skill.h: MAX_SKILL_STATUS_REQUIRE)
+//	Max. multiple value is 3 (skill.hpp: MAX_SKILL_STATUS_REQUIRE)
 //	Use any number or SC_ALL will disable status requirements
 // 'RequiredEquipment'
 //	Specified equipment to be equipped. For multiple values, use : as delimiter.
-//	Max. multiple value is 10 (skill.h: MAX_SKILL_EQUIP_REQUIRE)
+//	Max. multiple value is 10 (skill.hpp: MAX_SKILL_EQUIP_REQUIRE)
 
 //****
 // SM Swordman

diff --git a/db/spellbook_db.txt b/db/spellbook_db.txt
@@ -4,7 +4,7 @@
 // SkillID,PreservePoints,Required Book
 //
 // NOTE:
-// - To add more entries, increase MAX_SKILL_SPELLBOOK_DB in skill.h.
+// - To add more entries, increase MAX_SKILL_SPELLBOOK_DB in skill.hpp.
 // - To remove entry by importing, put 0 for 'PreservePoints'
 
 //Mage

diff --git a/doc/atcommands.txt b/doc/atcommands.txt
@@ -14,7 +14,7 @@ This file describes the usage of in-game commands and assumes that
 	charcommand_symbol: "#"
 
 Some commands cannot be used from console or script command to prevent map-server crashed.
-See atcommand.c::atcommand_basecommands for restricted commands. Please tell us if any
+See atcommand.cpp::atcommand_basecommands for restricted commands. Please tell us if any
 other atcommand that causes map-server crashed executed by console or script commands.
 
 To search for a command, write "@" before the command name (ex. @commands).
@@ -811,7 +811,7 @@ If no coordinates are entered, a random location will be chosen.
 
 Warps to predefined locations in major cities.
 If no ID is given, all available maps will be displayed in the chat window.
-Locations and coordinates are stored in '/src/map/atcommand.c'.
+Locations and coordinates are stored in '/src/map/atcommand.cpp'.
 
 Restriction:
 	- Used from console
@@ -1143,7 +1143,7 @@ Give or remove a cart to a player and also change the cart skin based on ID:
 
 Changes the language attached to the player's account (#langtype).
 If no parameter is given, a list of available languages is displayed.
-All languages are defined in '/src/common/msg_conf.h'.
+All languages are defined in '/src/common/msg_conf.hpp'.
 
 ---------------------------------------
 

diff --git a/doc/ea_job_system.txt b/doc/ea_job_system.txt
@@ -13,7 +13,7 @@ Preface:
 -------------------------------------------------------------------------------
 
 	Most scripters are aware of the class values used in RO and their constants
-	specified in src/map/script_constants.h. Each class has a number associated
+	specified in src/map/script_constants.hpp. Each class has a number associated
 	to it for referencing, so when someone's class is 9 that means they are a
 	wizard. However, this list of job numbers has no real order behind it, and
 	no logic behind it's assignation.

diff --git a/doc/item_group.txt b/doc/item_group.txt
@@ -38,7 +38,7 @@ The table below explains which fields are accessed in each.
 
 ---------------------------------------
 
-GroupID: See the "Item Group ID" section in 'src/map/itemdb.h' and the "item groups" section in 'src/map/script_constants.h'.
+GroupID: See the "Item Group ID" section in 'src/map/itemdb.hpp' and the "item groups" section in 'src/map/script_constants.hpp'.
          Supports IG_* constants.
 
 ---------------------------------------
@@ -65,7 +65,7 @@ Amount: Amount of item that will be obtained.
 
 Random: Set this to '0' and the item will always be obtained ("must" item).
 		Random value will allocates where the item will be stored at random group.
-		(max. random group is 4, defined as MAX_ITEMGROUP_RANDGROUP in 'src/map/itemdb.c'.)
+		(max. random group is 4, defined as MAX_ITEMGROUP_RANDGROUP in 'src/map/itemdb.cpp'.)
 
 	Item Group:
 		IG_MyItemGroup,Knife,0,1,0		//a "must" item

diff --git a/doc/packet_interserv.txt b/doc/packet_interserv.txt
@@ -24,7 +24,7 @@ The format of this file is as follows:
 ============
 | 1. Notes |
 ============
-Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.c').
+Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.cpp').
 
 =========================
 | 2. Login-Char Packets |
@@ -520,7 +520,7 @@ Currently the max packet size is 0xFFFF (see 'WFIFOSET()' in 'src/common/socket.
 	len: 7
 	parameter:
 		- cmd : packet identification (0x3002)
-		- id: whisper id, identifier to match current whisper session that store in inter.c::wis_db
+		- id: whisper id, identifier to match current whisper session that store in inter.cpp::wis_db
 		- flag: 0=success, 1=target not found, 2=ignored by target
 	desc:
 		- Inform the char-server of the result of the whisper