Skip to content

Commit c9ba0a2

Browse files
committed
refactor: remove debug console logs and add remarks to markdown conversion
Clean up debug console logs that were commented out and add 'remarks' section to the markdown conversion for XML docs to provide more comprehensive documentation.
1 parent 71ca89a commit c9ba0a2

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

src/csharpDocHoverProvider.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@ export class CSharpDocHoverProvider implements vscode.HoverProvider {
752752
path = await normalizePath(path);
753753
}
754754

755-
console.log(`CSharpDocHoverProvider: Requesting docs for symbol: ${symbolInfo.fullSymbolName}`);
755+
//console.log(`CSharpDocHoverProvider: Requesting docs for symbol: ${symbolInfo.fullSymbolName}`);
756756
const response = await this.unityBinaryManager.requestSymbolDocs(
757757
symbolInfo.fullSymbolName,
758758
symbolInfo.assemblyName,
@@ -767,7 +767,7 @@ export class CSharpDocHoverProvider implements vscode.HoverProvider {
767767
}
768768

769769
// Convert XML docs to Markdown format
770-
const markdownDocs = xmlToMarkdown(xmlDocsToUse!, isRequestedNativeBinary? []: ["summary", "returns", "param", "exception"]);
770+
const markdownDocs = xmlToMarkdown(xmlDocsToUse!, isRequestedNativeBinary? []: ["summary", "returns", "param", "exception", "remarks"]);
771771
// console.log(`abc Converted to markdown: ${markdownDocs}`);
772772
if(markdownDocs){
773773
hoverContent.appendMarkdown(markdownDocs);

src/languageServerUtils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export function isTypeSymbol(symbol: vscode.DocumentSymbol): boolean {
2727
*/
2828
export function getQualifiedTypeName(symbol: vscode.DocumentSymbol, constructedPath: string): string {
2929
// For Dot Rush, we build the qualified name by traversing the namespace hierarchy
30-
console.log(`Using constructed path for qualified name: ${constructedPath}`);
30+
//console.log(`Using constructed path for qualified name: ${constructedPath}`);
3131
return constructedPath;
3232
}
3333

src/unityBinaryManager.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,12 @@ export class UnityBinaryManager {
243243
SourceFilePath: sourceFilePath
244244
};
245245

246-
console.log(`UnityBinaryManager: Sending symbol docs request [ID: ${requestId}]:`, JSON.stringify(request));
246+
//console.log(`UnityBinaryManager: Sending symbol docs request [ID: ${requestId}]:`, JSON.stringify(request));
247247

248248
return new Promise<SymbolDocsResponse | null>((resolve) => {
249249
// Set up timeout
250250
const timeout = setTimeout(() => {
251-
console.log(`UnityBinaryManager: Symbol docs request timeout [ID: ${requestId}]`);
251+
//console.log(`UnityBinaryManager: Symbol docs request timeout [ID: ${requestId}]`);
252252
this.pendingSymbolDocsRequests.delete(requestId);
253253
resolve(null);
254254
}, timeoutMs);
@@ -603,7 +603,7 @@ export class UnityBinaryManager {
603603
private handleSymbolDocsMessage(payload: string, requestId: number): void {
604604
try {
605605
const response: SymbolDocsResponse = JSON.parse(payload);
606-
console.log(`UnityBinaryManager: Received symbol docs response [ID: ${requestId}]:`, JSON.stringify(response));
606+
//console.log(`UnityBinaryManager: Received symbol docs response [ID: ${requestId}]:`, JSON.stringify(response));
607607

608608
// If this is a response to a pending request, resolve it
609609
if (requestId > 0 && this.pendingSymbolDocsRequests.has(requestId)) {

0 commit comments

Comments
 (0)