Re: Thrift 1800

[Carl Yeksigian]

Hi Jens, I've attached the files for the updated DocTest and the generated HTML. The HTML has: "Vi mäter temperaturer i °C" instead of "Vi mäter temperaturer i °C". Thanks, Carl

Title: Thrift module: DocTest

Thrift module: DocTest

Module	Services	Data types	Constants
DocTest	ThriftTest testByte testDouble testEnum testI32 testI64 testInsanity testList testMap testMapMap testNest testSet testString testStruct testTypedef testUtf testVoid	BigDog CodeInComment EmptyStruct FirstAndLastLine FirstLineIndent Flush IndentedDocstring IndentedTitle Insanity Irregular1 Irregular2 LastLine NoStars Numberz OneField SorryNoGo StandardMultiLine TotallyDegenerate TrailingWhitespace TrivialMultiLine UserId Xception Xception2 Xtruct Xtruct2	INT16CONSTANT INT32CONSTANT MAPCONSTANT

---

Constants

Constant	Type	Value
INT32CONSTANT	i32	9853
You can document constants now too. Yeehaw!
INT16CONSTANT	i16	1616
MAPCONSTANT	map<string, string>	{ "hello" = "world", "goodnight" = "moon" }
Everyone get in on the docu-action!

---

Enumerations

Enumeration: Numberz

Some doc text goes here. Wow I am [nesting these] (no more nesting.)

ONE	1
TWO	2
THREE	3
FIVE	5
SIX	6
EIGHT	8

---

Type declarations

Typedef: UserId

Base type: i64

This is how you would do a typedef doc

Typedef: SorryNoGo

Base type: i32

Typedef: TrivialMultiLine

Base type: i32

This is a trivial example of a multiline docstring.

Typedef: StandardMultiLine

Base type: i32

This is the cannonical example of a multiline docstring.

Typedef: LastLine

Base type: i32

The last line is non-blank. I said non-blank!

Typedef: FirstAndLastLine

Base type: i32

Both the first line are non blank. ;-) and the last line

Typedef: IndentedTitle

Base type: i32

INDENTED TITLE The text is less indented.

Typedef: FirstLineIndent

Base type: i32

First line indented. Unfortunately, this does not get indented.

Typedef: CodeInComment

Base type: i32

void code_in_comment() { printf("hooray code!"); }

Typedef: IndentedDocstring

Base type: i32

Indented Docstring. This whole docstring is indented. This line is indented further.

Typedef: Irregular1

Base type: i32

Irregular docstring. * We will have to punt * on this thing

Typedef: Irregular2

Base type: i32

* note the space * before these lines * but not this * one

Typedef: Flush

Base type: i32

Flush against the left.

Typedef: NoStars

Base type: i32

No stars in this one. It should still work fine, though. Including indenting.

Typedef: TrailingWhitespace

Base type: i32

Trailing whitespace Sloppy trailing whitespace is truncated.

Typedef: BigDog

Base type: i32

This is a big one.

We'll have some blank lines in it.

void as_well_as(some code) { puts("YEEHAW!"); }

Typedef: TotallyDegenerate

Base type: i32

---

Data structures

Struct: Xtruct

Key	Field	Type	Description	Requiredness	Default value
1	string_thing	string	And the members of a struct	default
4	byte_thing	byte	doct text goes before a comma	default
9	i32_thing	i32		default
11	i64_thing	i64		default

And this is where you would document a struct

Struct: Xtruct2

Key	Field	Type	Description	Requiredness	Default value
1	byte_thing	byte		default
2	struct_thing	Xtruct		default
3	i32_thing	i32		default

Struct: Insanity

Key	Field	Type	Description	Requiredness	Default value
1	userMap	map<Numberz, UserId>	This is doc for field 1	default
2	xtructs	list<Xtruct>	And this is doc for field 2	default

Struct insanity

Exception: Xception

Key	Field	Type	Description	Requiredness	Default value
1	errorCode	i32		default
2	message	string		default

Exception: Xception2

Key	Field	Type	Description	Requiredness	Default value
1	errorCode	i32		default
2	struct_thing	Xtruct		default

Struct: EmptyStruct

Key	Field	Type	Description	Requiredness	Default value

Doc

Struct: OneField

Key	Field	Type	Description	Requiredness	Default value
1	field	EmptyStruct		default

---

Services

Service: ThriftTest

This is where you would document a Service

Function: ThriftTest.testVoid

void testVoid()

And this is how you would document functions in a service

Function: ThriftTest.testString

string testString(string thing)

Function: ThriftTest.testByte

byte testByte(byte thing)

Function: ThriftTest.testI32

i32 testI32(i32 thing)

Function: ThriftTest.testI64

i64 testI64(i64 thing)

Like this one

Function: ThriftTest.testDouble

double testDouble(double thing)

Function: ThriftTest.testStruct

Xtruct testStruct(Xtruct thing)

Function: ThriftTest.testNest

Xtruct2 testNest(Xtruct2 thing)

Function: ThriftTest.testMap

map<i32, i32> testMap(map<i32, i32> thing)

Function: ThriftTest.testSet

set<i32> testSet(set<i32> thing)

Function: ThriftTest.testList

list<i32> testList(list<i32> thing)

Function: ThriftTest.testEnum

Numberz testEnum(Numberz thing)

This is an example of a function with params documented

Parameters

Name	Description
thing	This param is a thing

Function: ThriftTest.testTypedef

UserId testTypedef(UserId thing)

Function: ThriftTest.testMapMap

map<i32, map<i32, i32>> testMapMap(i32 hello)

Function: ThriftTest.testInsanity

map<UserId, map<Numberz, Insanity>> testInsanity(Insanity argument)

Function: ThriftTest.testUtf

void testUtf()

Vi mäter temperaturer i °C

DocTest.thrift
Description: Binary data

On Dec 22, 2012, at 1:51 AM, Jens Geyer <jensge...@hotmail.com> wrote: Hi Carl, I just added some text like in the sentence mentioned at the beginning of all docstrings in DocTest.thrift to test it. I can provide such a file, but not right now. At this occasion I noticed that Thrift does not accept UTF-8 nor 16 as input. What I'm more interested in is the output you got. Could you send me the generated HTML? Thanks, JensG