summaryrefslogtreecommitdiffstats
path: root/crawl-ref/source/items.cc
diff options
context:
space:
mode:
authorNeil Moore <neil@s-z.org>2014-05-29 14:36:40 -0400
committerNeil Moore <neil@s-z.org>2014-05-29 14:36:40 -0400
commita9e4b68620331b624e372ed3d27c3b1da633bac6 (patch)
treee2f7f4de9f6db27ec1f497314095b73a6c4aebe2 /crawl-ref/source/items.cc
parent08af173fcb0e80c6c7040de0487aa20becd89759 (diff)
downloadcrawl-ref-a9e4b68620331b624e372ed3d27c3b1da633bac6.tar.gz
crawl-ref-a9e4b68620331b624e372ed3d27c3b1da633bac6.zip
Correct some doxygen blocks.
Some of them were missing the /** (or /*!) that makes doxygen consider the comment in the first place.
Diffstat (limited to 'crawl-ref/source/items.cc')
-rw-r--r--crawl-ref/source/items.cc12
1 files changed, 6 insertions, 6 deletions
diff --git a/crawl-ref/source/items.cc b/crawl-ref/source/items.cc
index 779d32a0dd..dc92552887 100644
--- a/crawl-ref/source/items.cc
+++ b/crawl-ref/source/items.cc
@@ -310,7 +310,7 @@ stack_iterator stack_iterator::operator++(int dummy)
return copy;
}
-/*
+/**
* Reduce quantity of an inventory item, do cleanup if item goes away.
* @returns True if stack of items no longer exists, false otherwise.
*/
@@ -637,7 +637,7 @@ void lose_item_stack(const coord_def& where)
igrd(where) = NON_ITEM;
}
-/*
+/**
* How many movable items are there at a location?
*
* @param obj The item link for the location.
@@ -655,7 +655,7 @@ int count_movable_items(int obj)
return result;
}
-/*
+/**
* Fill the given vector with the items on the given location link.
*
* @param[out] items A vector to hold the item_defs of the item.
@@ -1168,7 +1168,7 @@ string origin_desc(const item_def &item)
return desc;
}
-/*
+/**
* Pickup a single item stack at the given location link
*
* @param link The location link
@@ -1243,7 +1243,7 @@ bool player_on_single_stack()
return mitm[o].link == NON_ITEM && mitm[o].quantity > 1;
}
-/*
+/**
* Do the pickup command.
*
* @param partial_quantity If true, prompt for a quantity to pick up when
@@ -1609,7 +1609,7 @@ void note_inscribe_item(item_def &item)
_check_note_item(item);
}
-/*
+/**
* Move the given item and quantity to the player's inventory.
*
* Returns 1 so pickup can continue if the pickup fails due to the item being