Fix docs "not placed on a valid language element"

This commit is contained in:
YoshiRulz 2019-05-29 21:04:12 +10:00
parent 268ed1a69d
commit ceb490828f
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
14 changed files with 67 additions and 71 deletions
BizHawk.Client.EmuHawk/AVOut
BizHawk.Emulation.Cores
BizHawk.Emulation.DiscSystem

View File

@ -94,19 +94,19 @@ namespace BizHawk.Client.EmuHawk
/// <param name="rerecords">Number of rerecords on movie file</param>
void SetMetaData(string gameName, string authors, UInt64 lengthMS, UInt64 rerecords);
/// <summary>
/// short description of this IVideoWriter
/// </summary>
// string WriterDescription();
// /// <summary>
// /// short description of this IVideoWriter
// /// </summary>
// string WriterDescription();
/// <summary>
/// what default extension this writer would like to put on its output
/// </summary>
string DesiredExtension();
/// <summary>
/// name that command line parameters can refer to
/// </summary>
/// <returns></returns>
// string ShortName();
// /// <summary>
// /// name that command line parameters can refer to
// /// </summary>
// /// <returns></returns>
// string ShortName();
}
public static class VideoWriterExtensions

View File

@ -47,8 +47,8 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
// keyboard
List<string> keys = new List<string>
{
/// http://www.cpcwiki.eu/index.php/Programming:Keyboard_scanning
/// http://www.cpcwiki.eu/index.php/File:Grimware_cpc464_version3_case_top.jpg
// http://www.cpcwiki.eu/index.php/Programming:Keyboard_scanning
// http://www.cpcwiki.eu/index.php/File:Grimware_cpc464_version3_case_top.jpg
// Keyboard - row 1
"Key ESC", "Key 1", "Key 2", "Key 3", "Key 4", "Key 5", "Key 6", "Key 7", "Key 8", "Key 9", "Key 0", "Key Dash", "Key Hat", "Key CLR", "Key DEL",

View File

@ -692,10 +692,10 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
/// </summary>
private class Command
{
/// <summary>
/// Mask to remove potential parameter bits (5,6, and or 7) in order to identify the command
/// </summary>
//public int BitMask { get; set; }
// /// <summary>
// /// Mask to remove potential parameter bits (5,6, and or 7) in order to identify the command
// /// </summary>
// public int BitMask { get; set; }
/// <summary>
/// The command code after bitmask has been applied
/// </summary>

View File

@ -375,12 +375,12 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
/// </summary>
private bool HSYNC;
/// <summary>
/// Is set when an initial HSYNC is seen from the CRCT
/// On real hardware interrupt generation is based on the falling edge of the HSYNC signal
/// So in this emulation, once the falling edge is detected, interrupt processing happens
/// </summary>
//private bool HSYNC_falling;
// /// <summary>
// /// Is set when an initial HSYNC is seen from the CRCT
// /// On real hardware interrupt generation is based on the falling edge of the HSYNC signal
// /// So in this emulation, once the falling edge is detected, interrupt processing happens
// /// </summary>
// private bool HSYNC_falling;
/// <summary>
/// Used to count HSYNCs during a VSYNC

View File

@ -147,6 +147,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
/// <summary>
/// This 16-bit property emulates how the Amstrad CPC Gate Array is connected up to the CRTC
/// Built from R12, R13 and CLK
/// </summary>
/*
Memory Address Signal Signal source Signal name
A15 6845 MA13
@ -166,7 +167,6 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
A1 6845 MA0
A0 Gate-Array CLK
*/
/// </summary>
public ushort AddressLineCPC
{
get

View File

@ -395,6 +395,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
/// <summary>
/// The register array
/// </summary>
/*
The AY-3-8910/8912 contains 16 internal registers as follows:
@ -426,7 +427,6 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
The AY-3-8912 ignores bit 7 of this register.
*/
/// </summary>
private int[] _registers = new int[16];
/// <summary>

View File

@ -62,10 +62,10 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
/// </summary>
public AmstradGateArray GateArray { get; set; }
/// <summary>
/// Renders pixels to the screen
/// </summary>
//public CRTDevice CRT { get; set; }
// /// <summary>
// /// Renders pixels to the screen
// /// </summary>
// public CRTDevice CRT { get; set; }
/// <summary>
/// The PPI contoller chip

View File

@ -692,10 +692,10 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
/// </summary>
private class Command
{
/// <summary>
/// Mask to remove potential parameter bits (5,6, and or 7) in order to identify the command
/// </summary>
//public int BitMask { get; set; }
// /// <summary>
// /// Mask to remove potential parameter bits (5,6, and or 7) in order to identify the command
// /// </summary>
// public int BitMask { get; set; }
/// <summary>
/// The command code after bitmask has been applied
/// </summary>

View File

@ -379,6 +379,7 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
/// <summary>
/// The register array
/// </summary>
/*
The AY-3-8910/8912 contains 16 internal registers as follows:
@ -410,7 +411,6 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
The AY-3-8912 ignores bit 7 of this register.
*/
/// </summary>
private int[] _registers = new int[16];
/// <summary>

View File

@ -59,9 +59,9 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
// keyboard
List<string> keys = new List<string>
{
/// Controller mapping includes all keyboard keys from the following models:
/// https://upload.wikimedia.org/wikipedia/commons/thumb/3/33/ZXSpectrum48k.jpg/1200px-ZXSpectrum48k.jpg
/// https://upload.wikimedia.org/wikipedia/commons/c/ca/ZX_Spectrum%2B.jpg
// Controller mapping includes all keyboard keys from the following models:
// https://upload.wikimedia.org/wikipedia/commons/thumb/3/33/ZXSpectrum48k.jpg/1200px-ZXSpectrum48k.jpg
// https://upload.wikimedia.org/wikipedia/commons/c/ca/ZX_Spectrum%2B.jpg
// Keyboard - row 1
"Key True Video", "Key Inv Video", "Key 1", "Key 2", "Key 3", "Key 4", "Key 5", "Key 6", "Key 7", "Key 8", "Key 9", "Key 0", "Key Break",

View File

@ -615,29 +615,29 @@ namespace BizHawk.Emulation.Cores.Nintendo.SNES
}
}
/// <summary>
/// returns a tilemap which might be resized into 8x8 physical tiles if the 16x16 logical tilesize is specified
/// </summary>
//TileEntry[] AdaptTilemap(TileEntry[] map8x8, int tilesWide, int tilesTall, int tilesize)
//{
// if (tilesize == 8) return map8x8;
// int numTiles = tilesWide * tilesTall;
// var ret = new TileEntry[numTiles * 4];
// for(int y=0;y<tilesTall;y++)
// {
// for (int x = 0; x < tilesWide; x++)
// {
// int si = tilesWide * y + x;
// int di = tilesHigh
// for (int tx = 0; tx < 2; tx++)
// {
// for (int ty = 0; ty < 2; ty++)
// {
// }
// }
// }
// }
//}
// /// <summary>
// /// returns a tilemap which might be resized into 8x8 physical tiles if the 16x16 logical tilesize is specified
// /// </summary>
// TileEntry[] AdaptTilemap(TileEntry[] map8x8, int tilesWide, int tilesTall, int tilesize)
// {
// if (tilesize == 8) return map8x8;
// int numTiles = tilesWide * tilesTall;
// var ret = new TileEntry[numTiles * 4];
// for(int y=0;y<tilesTall;y++)
// {
// for (int x = 0; x < tilesWide; x++)
// {
// int si = tilesWide * y + x;
// int di = tilesHigh
// for (int tx = 0; tx < 2; tx++)
// {
// for (int ty = 0; ty < 2; ty++)
// {
// }
// }
// }
// }
// }
/// <summary>
/// decodes a BG. youll still need to paletteize and colorize it.

View File

@ -165,10 +165,6 @@ namespace BizHawk.Emulation.DiscSystem
/// The block address of the first block of the system Path Table is kept in this field
/// </summary>
public int AddressOfPathTable;
/// <summary>
/// This number is used to indicate the revision number of the file structure standard to which the
/// directory search files conform. It is set to one
/// </summary>
#endregion

View File

@ -96,11 +96,11 @@ namespace BizHawk.Emulation.DiscSystem
return ret;
}
/// <summary>
/// The DiscMountPolicy used to mount the disc. Consider this read-only.
/// NOT SURE WE NEED THIS
/// </summary>
//public DiscMountPolicy DiscMountPolicy;
// /// <summary>
// /// The DiscMountPolicy used to mount the disc. Consider this read-only.
// /// NOT SURE WE NEED THIS
// /// </summary>
// public DiscMountPolicy DiscMountPolicy;

View File

@ -250,10 +250,10 @@ namespace BizHawk.Emulation.DiscSystem
/// </summary>
public int Session;
/// <summary>
/// this seems just to be the LBA corresponding to AMIN:ASEC:AFRAME (give or take 150). It's not stored on the disc, and it's redundant.
/// </summary>
//public int ALBA;
// /// <summary>
// /// this seems just to be the LBA corresponding to AMIN:ASEC:AFRAME (give or take 150). It's not stored on the disc, and it's redundant.
// /// </summary>
// public int ALBA;
/// <summary>
/// this seems just to be the LBA corresponding to PMIN:PSEC:PFRAME (give or take 150).