development documentation thread

[scarf005]

The problem I see with CBN development is: it's hard to see how to do stuff.
for example, let's say one wants to move an item to another place. It's extreamly hard to figure out you have to write something like this until you ask several people,

    const auto move_item = [&]( map_stack & items, const tripoint & src, const tripoint & dest ) {
        for( auto it = items.begin(); it != items.end(); ) {
            here.add_item_or_charges( dest, *it );
            it = here.i_rem( src, it );
        }
    };

because

• you need to know what i_rem does
• you need to know that items are map_stack
• you need to know on moving items you need to use items iterator

also

• all these docstrings are scattered throughout codebase, so hard to figure out
• 90% of functions are undocumented

Proposal

1. need better documentation for developers
2. need better way to navigate documentation by 'tasks', such as:

• how to move an item (by z-level)
• how to move an vehicle (by z-level)
• how to move an creature
• how to draw a sprite

[scarf005]

closing as stale.