docshelp wantedup for grabs
Description
A lot of the xmldoc is great, succinct and very informative. However there is still giant swathes of missing or bolierplate xmldoc that could be greatly improved. Most of the bolierplate comments look to be auto-generated from a tool like GhostDoc.
Not to pick on one class in particular, but if you take a look at for example src/core/Akka/Configuration/ConfigurationFactory.cs you'll notice some hilariously bad xmldoc.
/// <summary>
/// Gets the empty.
/// </summary>
/// <value>The empty.</value>
public static Config Empty
{
get { return ParseString(""); }
}
/// <summary>
/// Defaults this instance.
/// </summary>
/// <returns>Config.</returns>
public static Config Default()
{
return FromResource("Akka.Configuration.Pigeon.conf");
}
/// <summary>
/// Froms the resource.
/// </summary>
/// <param name="resourceName">Name of the resource.</param>
/// <returns>Config.</returns>
internal static Config FromResource(string resourceName)
{
Assembly assembly = Assembly.GetExecutingAssembly();
return FromResource(resourceName, assembly);
}
I know there are more pressing issues at hand, but it would be nice to have clean API docs :)