The Battle for Wesnoth Forums

CrawlCycle

Thanks a lot for reading the long plan and providing feedback. I agree that the shim is unnecessary since the old and new preprocessor have the same public API and only a few source files #include the preprocessor. There is no need for a compatibility layer in this case. I have deleted the steps reg...

CrawlCycle

Since readability/understandability is a concern, is there a "coding style guide" that we would like to use to "proofread" the code? Like such Using an automatic formatter can be a good idea. We are currently using clang-format . The .clang-format file of Wesnoth is at here . Ot...

CrawlCycle

Background Motivation The preprocessor is a small header and a source file (1801 lines) that contains a large class (1402 lines) with a large method (607 lines). The internal workings of the preprocessor is unclear at a quick glance. The output of the preprocessor is in a format that is incompletel...

CrawlCycle

Two methods to describe the time complexity of an operation. Hint the speed of the operation with another set of verbs in the brief description: For example, create vs fabricate, get vs retrieve Document the time complexity as a new section in the Doxygen block. I think option 2 is better. Benchmark...

CrawlCycle

Even better:
The "list of children" is an implementation detail.

Code: Select all

/** Get the first child node with the key. ... */
/** Get a child node with the key. ... */
/**
 * Append an empty child node with @p key. The new child will be the last
 * one in the list of children with the @p key.
 */

CrawlCycle

I think I will settle with this one:

Code: Select all

// Work around a Boost<1.67 bug fixed in 1.67: Include test_case.hpp after
// unit_tests.hpp. https://svn.boost.org/trac10/ticket/13387

CrawlCycle

Workaround for Boost>=1.67 bug would represent a bug that has not been fixed since version 1.67. Is the grammar of the comment correct? I think it should have an extra "a": Workaround for a Boost>=1.67 bug . But sometimes people might forget to add the "a". In that case, searchi...

CrawlCycle

Commenting a workaround for an external dependency There are 13 usages of the noun "workaround" and 8 usages of the verb "work around" in the .cpp and .hpp files. /** * Default constructor, defined out of line to work around a warning in * gcc 4.5.2 */ /* Workaround for an SDL b...

CrawlCycle

egallager wrote: ↑November 25th, 2020, 5:28 am Well, if the generated HTML were hosted on the website, users wouldn't have to generate it themselves...

I think he meant most programmers.

CrawlCycle

I don't like long unreadable names. But why do people still use that? Until I know all of the reason, I probably would still use long names. Alternatively, maybe I can write a custom struct that replaces a long name: Fields for holding the properties of the test An implicit conversion to string.

CrawlCycle

How to name a unit test https://stackoverflow.com/questions/155436/unit-test-naming-best-practices https://dzone.com/articles/7-popular-unit-test-naming https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-best-practices No double underscore. I am thinking about method_name_StateOfThis...

CrawlCycle

Create a new file for unit tests Create a new file within wesnoth/src/test Add the path of the new file to the list at wesnoth/source_lists/boost_unit_tests I made a typo in wesnoth/source_lists/boost_unit_tests , but CMake didn't warn. Parametrized test Parametrized test has two advantages: It all...

CrawlCycle

I think this is good: /** * Get the first node in the list of children with the key. * Return the empty node singleton if we can't find such a node. * @see child(config_key_type, int) */ const config & child_or_empty(config_key_type key) const; /** * Get a node in the list of children with the k...

CrawlCycle

Fixed that one.

CrawlCycle

This makes sense for database and computer. But does this make sense to humans? /** Get a child by key and then by index. */ This should mean: /** Get all children with the key. Among those children, pick one by index. */ similar to: https://stackoverflow.com/questions/14941366 --♦-- Another issues ...

The Battle for Wesnoth Forums

Search found 27 matches

Re: Draft of the plan to refactor the preprocessor

Re: Draft of the plan to refactor the preprocessor

Draft of the plan to refactor the preprocessor

Re: Wording and style for Doxygen documentation

Re: Wording and style for Doxygen documentation

Re: Miscellaneous

Re: Miscellaneous

Miscellaneous

Re: Question about Doxygen documentation

Re: Testing puzzles

Re: Testing puzzles

Testing puzzles

Re: Wording and style for Doxygen documentation

Re: Wording and style for Doxygen documentation

Re: Wording and style for Doxygen documentation