dotnet/roslyn

Xml doc comment for ManagedCompiler.GenerateResponseFileCommands is wrong

Open

#4597 aperta il 17 ago 2015

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C# (4257 fork)batch import
Area-CompilersBugDocumentationhelp wanted

Metriche repository

Star
 (20.414 star)
Metriche merge PR
 (Merge medio 6g 17h) (256 PR mergiate in 30 g)

Descrizione

From ManagedCompiler.cs:

/// <summary> 
/// Returns the command line switch used by the tool executable to specify the response file 
/// Will only be called if the task returned a non empty string from GetResponseFileCommands 
/// Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands 
/// </summary> 
protected override string GenerateResponseFileCommands() 
{ 
    CommandLineBuilderExtension commandLineBuilder = new CommandLineBuilderExtension(); 
    AddResponseFileCommands(commandLineBuilder); 
    return commandLineBuilder.ToString(); 
}

The summary comment claims the method returns the command line switch used to introduce a response file. But in fact it seems to return the contents of the response file. It also mentions a GetResponseFileCommands method that doesn't appear to be defined anywhere.

Guida contributor

Direzione di ricerca
Correggi il commento del documento XML per descrivere accuratamente che il metodo restituisce il contenuto del file di risposta, non l'opzione. Rimuovi anche il riferimento a GetResponseFileCommands o aggiornalo se esiste altrove.
Tech stack
csharp
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90