Documentation and comments are missing

[erizocosmico]

Documentation and comments are missing from the returned UAST.

Example:

using System.Net;
using System.Net.Http.Headers;
using System.Net.Sockets;
using Microsoft.AspNetCore.Http;

namespace ProxyKit
{
    public static class XForwardedExtensions
    {
        public const string XForwardedFor = "X-Forwarded-For";
        public const string XForwardedHost = "X-Forwarded-Host";
        public const string XForwardedProto = "X-Forwarded-Proto";
        public const string XForwardedPathBase = "X-Forwarded-PathBase";

        /// <summary>
        ///     Applies X-Forwarded.* headers to the outgoing
        ///     header collection.
        /// </summary>
        /// <param name="outgoingHeaders">The outgoing HTTP request
        /// headers.</param>
        /// <param name="for">The client IP address.</param>
        /// <param name="host">The host of the request.</param>
        /// <param name="proto">The protocol of the incoming request.</param>
        public static void ApplyXForwardedHeaders(
            this HttpRequestHeaders outgoingHeaders,
            IPAddress _for,
            HostString host,
            string proto) 
            => ApplyXForwardedHeaders(outgoingHeaders, _for, host, proto, string.Empty);

        /// <summary>
        ///     Applies X-Forwarded.* headers to the outgoing header collection
        ///     with an additional PathBase parameter.
        /// </summary>
        /// <param name="outgoingHeaders">The outgoing HTTP request
        /// headers.</param>
        /// <param name="for">The client IP address.</param>
        /// <param name="host">The host of the request.</param>
        /// <param name="proto">The protocol of the incoming request.</param>
        /// <param name="pathBase">The base path of the incoming
        /// request.</param>
        public static void ApplyXForwardedHeaders(
            this HttpRequestHeaders outgoingHeaders,
            IPAddress _for,
            HostString host,
            string proto,
            PathString pathBase)
        {
            if (_for != null)
            {
                var forString = _for.AddressFamily == AddressFamily.InterNetworkV6
                    ? $"\"[{_for}]\""
                    : _for.ToString();
                outgoingHeaders.Add(XForwardedFor, forString);
            }

            if (host.HasValue)
            {
                outgoingHeaders.Add(XForwardedHost, host.Value);
            }

            if (!string.IsNullOrWhiteSpace(proto))
            {
                outgoingHeaders.Add(XForwardedProto, proto);
            }

            if (!string.IsNullOrWhiteSpace(pathBase))
            {
                outgoingHeaders.Add(XForwardedPathBase, pathBase);
            }
        }
    }
}

Does not return any of the documentation comments in the code.

[dennwc]

@erizocosmico What version are you using? v1.0 should have fixed this issue.

[erizocosmico]

The one in the staging bblfsh playground: 1.0.0

[dennwc]

Okay, can confirm that it's a bug and the solution is not that simple (see discussion in #3).

For now, you can use Annotated mode to get comments, although they won't be normalized.

[erizocosmico]

Don't worry, I can move on to other tasks of the PoC and leave this for the end. If it's not fixed by then I will try with annotated mode. What do you mean exactly by "normalized" in this case?

[dennwc]

In Semantic, all comments will have a single type: uast:Comment. In Annotated you will have to deal with SingleLineCommentTrivia, SingleLineDocumentationCommentTrivia, MultiLineCommentTrivia and probably handle the differences between them.

[dennwc]

Also, note that comments are missing only on specific node types - if they were close to any Identifier.

If the comment is in the code block it should be visible.

[erizocosmico]

I'm targeting method docs, in particular.

[dennwc]

They won't be visible for now :(

[erizocosmico]

I just tried with annotated mode and turns out it's exactly what I need for the PoC.