Issues with nullable value types

[N-b-dy]

Hi rogerbarton,

first of all thanks for you great job improving/providing a Sphinx domain for C#. I'm using it currently with DoxyGen and Breathe in a project and getting some issues with the nullable value types of C# 8.0 (https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/nullable-value-types).

This is an example C# code for describing the problem.

    public class ExampleClass
    {
        /// <summary>
        /// Constructor of the class.
        /// </summary>
        public ExampleClass()
        {
        }

        /// <summary>
        /// A nullable bool value.
        /// </summary>
        public bool? BNullableBool { get; set; }

        /// <summary>
        /// A nullable int value.
        /// </summary>
        public int? NNullableInt { get; set; }

        /// <summary>
        /// A nullable function.
        /// </summary>
        /// <param name="bValue">A nullable bool.</param>
        /// <returns>A nullable int.</returns>
        public int? FooBar(bool? bValue)
        {
            return null;
        }
    }

In Sphinx I'm using the following Breathe directive to create the HTML output:

    .. doxygenclass:: WpfApp1::Models::ExampleClass
        :members:

During the build I'm getting the following warnings:

WARNING: Method signature invalid: int? FooBar (bool? bValue)
WARNING: Definition list ends without a blank line; unexpected unindent.

And the output looks like this:

The types of the properties are not getting parsed properly and also the "highlighting" of them differs from the other stuff in case of a method.

I'm not totally sure if this issue is completly solvable by this domain, but I hope you can help me.

[rogerbarton]

I will have a look at this tomorrow, but I think it should work will nullables (or I can hopefully make it work easily).

Thanks for the detailed description and example. This helps a lot!

[rogerbarton]

Ok the regex was not quite correct, but I think it should work now. I've added your example class as a test and it works for me.
Please pip install again.
Does this solve your problem?

[N-b-dy]

Yes, the ExampleClass looks fine now, thanks for that!

I just tried it also with an extension class in combination with the nullable variables. The same warnings are coming up for that one and the display doesn't fit yet either.

    /// <summary>
    /// A static extension class.
    /// </summary>
    public static class FooBarExtension
    {
        /// <summary>
        /// Just an extension method.
        /// </summary>
        /// <param name="nullableBool">A nullable bool.</param>
        /// <returns>A nullable int.</returns>
        public static int? Foo(this bool? nullableBool)
        {
            return null;
        }

        /// <summary>
        /// Another extension method.
        /// </summary>
        /// <param name="normalBool">A normal bool.</param>
        /// <returns>A normal int.</returns>
        public static int Bar(this bool normalBool)
        {
            if (normalBool)
                return 1;

            return 0;
        }
    }

Can you take a look at that one as well?

[rogerbarton]

I will have a look at it over the next few days.
Although it looks more complicated because the ? is no longer at the end of the type, maybe because of the doxygen output.

[rogerbarton]

It seems to only be an issue when the function is static and returns a nullable. Pointers work fine strangely:

Somehow the input to the package already has the ? before the type, despite the doxyen xml having the correct ordering.
Not sure why this is happening. Unfortunately, I don't have much time to look into this, so it will not be supported at the moment.