Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation panel to the SWQL studio #185

Merged
merged 22 commits into from
Jul 23, 2019

Conversation

jirkapok
Copy link
Contributor

@jirkapok jirkapok commented Jul 3, 2019

Added new panel below Object explorer in SWQL studio to show complete metadata documentation.
Currently the panel shows the same information like ToolTips, but in another formatting. In the future i want to add other documentation (e.g. access control list).

}
}

public static void RebuildVerbArguments(TreeNode verbNode, IMetadataProvider provider)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be handled in AddVerbsToNode instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it was designed as lazyloading

if (data is SwisMetaDataProvider)
return ProviderDocumentation(provider);

if (data is string nameSpace)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have a class for namespaces? Is string sufficient?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no logic behind the namespace now, is string is still enough

return builder.ToString();
}

public static string ToNodeText(string name, int childsCount)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"children" instead of "childs"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Copy link
Contributor

@danjagnow danjagnow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! This should be a helpful feature. I added a few minor comments, but nothing critical.

@jirkapok jirkapok merged commit 56f9a18 into solarwinds:master Jul 23, 2019
@jirkapok jirkapok deleted the feature/PA-3360_AddDocumentation branch September 26, 2019 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants